asdoc/org/apache/royale/textLayout/conversion/ITextImporter.js.json

{ "type": "interface",
  "qname": "org.apache.royale.textLayout.conversion.ITextImporter",
    "description": "Interface for importing text content into a TextFlow from an external source. The TextConverter class creates importers with no constructor arguments.",
  "tags": [
  {  "tagName": "see",
         "values": ["org.apache.royale.textLayout.elements.TextFlow"]},
      {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 1.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
    "qname": "importToFlow",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Import text content from an external source and convert it into a TextFlow.",
    "tags": [
    {  "tagName": "param",
           "values": ["source        The data to convert."]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "return",
           "values": ["TextFlow Created from the source."]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "org.apache.royale.textLayout.elements.ITextFlow",
      "params": [{ "name": "source", "type": "Object"}]}
  ,
  { "type": "accessor",
    "access": "read-only",
    "return": "Vector.<String>",
    "qname": "errors",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "This property contains a vector of error messages as strings after a call to an importer method is the <code>throwOnError</code> property is set to <code>false</code>, which is the default. If there were no errors, the property returns <code>null</code>. The property is reset on each method call.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "throwOnError",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The <code>throwOnError</code> property controls how the importer handles errors. If set to <code>true</code>, methods throw an Error instance on errors. If set to <code>false</code>, which is the default, errors are collected into a vector of strings and stored in the <code>errors</code> property, and the importer does not throw.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "useClipboardAnnotations",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Controls whether or not the importer should handle the extra information necessary for the clipboard. When data comes in from the clipboard, it might contain partial paragraphs; paragraphs that are missing the terminator or newline character. If <code>useClipboardAnnotations</code> is <code>true</code>, the importer marks these partial paragraphs with a <code>ConverterBase.MERGE_TO_NEXT_ON_PASTE</code> attribute. This causes the paste operation to correctly handle merging of the pasted paragraph (and any list or div elements that may include the paragraph) into the text.",
    "tags": [
    {  "tagName": "see",
           "values": ["org.apache.royale.textLayout.conversion.ConverterBase.MERGE_TO_NEXT_ON_PASTE"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10", "AIR 1.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "org.apache.royale.textLayout.elements.IConfiguration",
    "qname": "configuration",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The <code>configuration</code> property contains the IConfiguration instance that the importer needs when creating new TextFlow instances. This property is initially set to <code>null</code>.",
    "tags": [
    {  "tagName": "see",
           "values": ["org.apache.royale.textLayout.elements.TextFlow"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.0"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]}]
  }