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

{ "type": "class",
  "qname": "org.apache.royale.textLayout.conversion.BaseTextLayoutExporter",
  "baseClassname": "org.apache.royale.textLayout.conversion.ConverterBase"
  ,
    "description": "Base export converter for TextLayout format.",
  "members": [
  { "type": "method",
        "qname": "org.apache.royale.textLayout.conversion.BaseTextLayoutExporter",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "",
          "params": [{ "name": "ns", "type": "Namespace"},
        { "name": "rootTag", "type": "XML"},
        { "name": "configuration", "type": "org.apache.royale.textLayout.conversion.ImportExportConfiguration"}]}
      ,
      { "type": "method",
        "qname": "export",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "",
        "tags": [
        {  "tagName": "copy",
               "values": ["ITextExporter#export()"]}  ],
          "return": "Object",
          "params": [{ "name": "source", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "conversionType", "type": "String"}]}
      ,
      { "type": "method",
        "qname": "exportToXML",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Export text content of a TextFlow into XFL format.",
        "tags": [
        {  "tagName": "param",
               "values": ["source the text to export"]},
            {  "tagName": "return",
               "values": ["XML the exported content"]}  ],
          "return": "XML",
          "params": [{ "name": "textFlow", "type": "org.apache.royale.textLayout.elements.ITextFlow"}]}
      ,
      { "type": "method",
        "qname": "exportFlowElement",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Base functionality for exporting a FlowElement.",
        "tags": [
        {  "tagName": "param",
               "values": ["exporter Root object for the export", "flowElement Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "exporter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutExporter"},
        { "name": "flowElement", "type": "org.apache.royale.textLayout.elements.IFlowElement"}]}
      ,
      { "type": "method",
        "qname": "exportFlowElement",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Overridable worker method for exporting a FlowElement. Creates the XMLList.",
        "tags": [
        {  "tagName": "param",
               "values": ["flowElement Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "flowElement", "type": "org.apache.royale.textLayout.elements.IFlowElement"}]}
      ,
      { "type": "method",
        "qname": "exportSpanText",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "return": "void",
          "params": [{ "name": "destination", "type": "XML"},
        { "name": "span", "type": "org.apache.royale.textLayout.elements.SpanElement"},
        { "name": "replacementRegex", "type": "RegExp"},
        { "name": "replacementXMLCallback", "type": "Function"}]}
      ,
      { "type": "method",
        "qname": "exportSpan",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Base functionality for exporting a Span. Exports as a FlowElement, and exports the text of the span.",
        "tags": [
        {  "tagName": "param",
               "values": ["exporter Root object for the export", "span Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "exporter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutExporter"},
        { "name": "span", "type": "org.apache.royale.textLayout.elements.SpanElement"}]}
      ,
      { "type": "accessor",
        "access": "read-only",
        "return": "RegExp",
        "qname": "spanTextReplacementRegex",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Gets the regex that specifies characters in span text to be replaced with XML elements. Note: Each match is a single character"},
      { "type": "method",
        "qname": "getSpanTextReplacementXML",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Gets the xml element used to represent a character in the export format",
          "return": "XML",
          "params": [{ "name": "ch", "type": "String"}]}
      ,
      { "type": "method",
        "qname": "exportFlowGroupElement",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Base functionality for exporting a FlowGroupElement. Exports as a FlowElement, and exports the children of a element.",
        "tags": [
        {  "tagName": "param",
               "values": ["exporter Root object for the export", "flowBlockElement Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "exporter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutExporter"},
        { "name": "flowBlockElement", "type": "org.apache.royale.textLayout.elements.FlowGroupElement"}]}
      ,
      { "type": "method",
        "qname": "exportParagraphFormattedElement",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Base functionality for exporting a IParagraphFormattedElement. Exports as a FlowGroupElement, and exports paragraph attributes.",
        "tags": [
        {  "tagName": "param",
               "values": ["exporter Root object for the export", "flowParagraph Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "exporter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutExporter"},
        { "name": "flowParagraph", "type": "org.apache.royale.textLayout.elements.IParagraphFormattedElement"}]}
      ,
      { "type": "method",
        "qname": "exportList",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "return": "XMLList",
          "params": [{ "name": "exporter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutExporter"},
        { "name": "flowParagraph", "type": "org.apache.royale.textLayout.elements.IParagraphFormattedElement"}]}
      ,
      { "type": "method",
        "qname": "exportList",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "XMLList",
          "params": [{ "name": "flowElement", "type": "org.apache.royale.textLayout.elements.IFlowElement"}]}
      ,
      { "type": "method",
        "qname": "exportListItem",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "return": "XMLList",
          "params": [{ "name": "exporter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutExporter"},
        { "name": "flowParagraph", "type": "org.apache.royale.textLayout.elements.IParagraphFormattedElement"}]}
      ,
      { "type": "method",
        "qname": "exportListItem",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "XMLList",
          "params": [{ "name": "flowElement", "type": "org.apache.royale.textLayout.elements.IFlowElement"}]}
      ,
      { "type": "method",
        "qname": "exportContainerFormattedElement",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Base functionality for exporting a IContainerFormattedElement. Exports as a IParagraphFormattedElement, and exports container attributes.",
        "tags": [
        {  "tagName": "param",
               "values": ["exporter Root object for the export", "container Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "exporter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutExporter"},
        { "name": "container", "type": "org.apache.royale.textLayout.elements.IContainerFormattedElement"}]}
      ,
      { "type": "method",
        "qname": "exportContainerFormattedElement",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Overridable worker method for exporting a IParagraphFormattedElement. Creates the XMLList.",
        "tags": [
        {  "tagName": "param",
               "values": ["flowElement Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "flowElement", "type": "org.apache.royale.textLayout.elements.IFlowElement"}]}
      ,
      { "type": "method",
        "qname": "exportTableElement",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Base functionality for exporting a TableElement. Exports as a TableElement, and exports table attributes.",
        "tags": [
        {  "tagName": "param",
               "values": ["exporter Root object for the export", "container Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "exporter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutExporter"},
        { "name": "table", "type": "org.apache.royale.textLayout.elements.TableElement"}]}
      ,
      { "type": "method",
        "qname": "exportTableElement",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Overridable worker method for exporting a TableElement. Creates the XMLList.",
        "tags": [
        {  "tagName": "param",
               "values": ["flowElement Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "tableElement", "type": "org.apache.royale.textLayout.elements.TableElement"}]}
      ,
      { "type": "method",
        "qname": "exportTableRowElement",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Base functionality for exporting a TableRowElement. Exports as a TableRowElement, and exports table row attributes.",
        "tags": [
        {  "tagName": "param",
               "values": ["exporter Root object for the export", "container Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "exporter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutExporter"},
        { "name": "tableRow", "type": "org.apache.royale.textLayout.elements.TableRowElement"}]}
      ,
      { "type": "method",
        "qname": "exportTableRowElement",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Overridable worker method for exporting a TableRowElement. Creates the XMLList.",
        "tags": [
        {  "tagName": "param",
               "values": ["flowElement Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "tableRowElement", "type": "org.apache.royale.textLayout.elements.TableRowElement"}]}
      ,
      { "type": "method",
        "qname": "exportTableCellElement",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Base functionality for exporting a TableCellElement. Exports as a TableCellElement, and exports table cell attributes.",
        "tags": [
        {  "tagName": "param",
               "values": ["exporter Root object for the export", "container Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "exporter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutExporter"},
        { "name": "tableCell", "type": "org.apache.royale.textLayout.elements.TableCellElement"}]}
      ,
      { "type": "method",
        "qname": "exportTableCellElement",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Overridable worker method for exporting a TableCellElement. Creates the XMLList.",
        "tags": [
        {  "tagName": "param",
               "values": ["flowElement Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "tableCellElement", "type": "org.apache.royale.textLayout.elements.TableCellElement"}]}
      ,
      { "type": "method",
        "qname": "exportParagraphFormattedElement",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Overridable worker method for exporting a IParagraphFormattedElement. Creates the XMLList.",
        "tags": [
        {  "tagName": "param",
               "values": ["flowElement Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "flowElement", "type": "org.apache.royale.textLayout.elements.IFlowElement"}]}
      ,
      { "type": "method",
        "qname": "exportTextFlow",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Base functionality for exporting a TextFlow. Exports as a ContainerElement, and exports container attributes.",
        "tags": [
        {  "tagName": "param",
               "values": ["exporter Root object for the export", "textFlow Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the element"]}  ],
          "return": "XMLList",
          "params": [{ "name": "exporter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutExporter"},
        { "name": "textFlow", "type": "org.apache.royale.textLayout.elements.ITextFlow"}]}
      ,
      { "type": "method",
        "qname": "exportChild",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Exports the object. It will find the appropriate exporter and use it to export the object.",
        "tags": [
        {  "tagName": "param",
               "values": ["exporter Root object for the export", "flowElement Element to export"]},
            {  "tagName": "return",
               "values": ["XMLList XML for the flowElement"]}  ],
          "return": "XMLList",
          "params": [{ "name": "flowElement", "type": "org.apache.royale.textLayout.elements.IFlowElement"}]}
      ,
      { "type": "method",
        "qname": "exportStyles",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Helper function to export styles (core or user) in the form of xml attributes or xml children.",
        "tags": [
        {  "tagName": "param",
               "values": ["xml object to which attributes/children are added", "sortableStyles an array of objects (xmlName,xmlVal) members that is sorted and exported."]}  ],
          "return": "void",
          "params": [{ "name": "xml", "type": "XMLList"},
        { "name": "sortableStyles", "type": "Array"}]}
      ,
      { "type": "accessor",
        "access": "read-only",
        "return": "Namespace",
        "qname": "flowNS",
        "namespace": "internal",
        "bindable": [],
        "details": [],
        "deprecated": {}},
      { "type": "accessor",
        "access": "read-only",
        "return": "Object",
        "qname": "formatDescription",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {}}]
  }