blob: 0bacb6ed8db510c62fdc7424839f71e67b66422a [file] [log] [blame]
{ "type": "class",
"qname": "org.apache.royale.textLayout.conversion.TextLayoutImporter",
"baseClassname": "org.apache.royale.textLayout.conversion.BaseTextLayoutImporter"
,
"description": "TextLayoutImporter converts from XML to TextLayout data structures and back.",
"tags": [
{ "tagName": "private",
"values": []} ],
"members": [
{ "type": "accessor",
"access": "read-only",
"return": "org.apache.royale.textLayout.conversion.ImportExportConfiguration",
"qname": "defaultConfiguration",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Default ImportExportConfiguration to use when none specified",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10", "AIR 1.5"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "restoreDefaults",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Set the default configuration back to its original value",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10", "AIR 1.5"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "org.apache.royale.textLayout.conversion.TextLayoutImporter",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Constructor",
"return": "",
"params": []}
,
{ "type": "accessor",
"access": "read-write",
"return": "Function",
"qname": "imageSourceResolveFunction",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "@copy ITextLayoutImporter#imageSourceResolveFunction",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 10.0", "AIR 2.0"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "createTextFlowFromXML",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"return": "org.apache.royale.textLayout.elements.TextFlow",
"params": [{ "name": "xmlToParse", "type": "XML"},
{ "name": "textFlow", "type": "org.apache.royale.textLayout.elements.TextFlow"}]}
,
{ "type": "method",
"qname": "createDivFromXML",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"return": "org.apache.royale.textLayout.elements.IDivElement",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "createTableFromXML",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Create a table element from XML",
"return": "org.apache.royale.textLayout.elements.ITableElement",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "createTableRowFromXML",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Create a table row element from XML",
"return": "org.apache.royale.textLayout.elements.TableRowElement",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "createTableCellFromXML",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Create a table cell element from XML",
"return": "org.apache.royale.textLayout.elements.TableCellElement",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "createParagraphFromXML",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "Create a paragraph element from XML",
"return": "org.apache.royale.textLayout.elements.IParagraphElement",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "createSubParagraphGroupFromXML",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Create a sub paragraph group element from XML",
"return": "org.apache.royale.textLayout.elements.SubParagraphGroupElement",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "createTCYFromXML",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Create a tate chu yoko element from XML",
"return": "org.apache.royale.textLayout.elements.TCYElement",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "createLinkFromXML",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Parse a LinkElement Block.",
"tags": [
{ "tagName": "param",
"values": ["- importFilter:BaseTextLayoutImporter - parser object", "- xmlToParse:XML - the xml describing the Link", "- parent:FlowBlockElement - the parent of the new Link"]},
{ "tagName": "return",
"values": ["LinkElement - a new LinkElement and its children"]} ],
"return": "org.apache.royale.textLayout.elements.LinkElement",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "createSpanFromXML",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "Create a span element from XML",
"return": "org.apache.royale.textLayout.elements.ISpanElement",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "createInlineGraphicFromXML",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Create an inline graphic from XML",
"return": "org.apache.royale.textLayout.elements.InlineGraphicElement",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "createListFromXML",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "Create a list element from XML",
"return": "org.apache.royale.textLayout.elements.IListElement",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "createListItemFromXML",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "Create a list item element from XML",
"return": "org.apache.royale.textLayout.elements.IListItemElement",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "extractTextFormatAttributesHelper",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Extract text format attributes",
"return": "Object",
"params": [{ "name": "curAttrs", "type": "Object"},
{ "name": "importer", "type": "org.apache.royale.textLayout.conversion.TLFormatImporter"}]}
,
{ "type": "method",
"qname": "parseSPGE",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Parse an SPGE element",
"tags": [
{ "tagName": "param",
"values": ["- importFilter:BaseTextLayoutImporter - parser object", "- xmlToParse:XML - the xml describing the TCY Block", "- parent:FlowBlockElement - the parent of the new TCY Block"]},
{ "tagName": "return",
"values": ["SubParagraphGroupElement - a new TCYBlockElement and its children"]} ],
"return": "void",
"params": [{ "name": "importFilter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutImporter"},
{ "name": "xmlToParse", "type": "XML"},
{ "name": "parent", "type": "org.apache.royale.textLayout.elements.FlowGroupElement"}]}
,
{ "type": "method",
"qname": "parseTCY",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Parse a TCY Block.",
"tags": [
{ "tagName": "param",
"values": ["- importFilter:BaseTextLayoutImporter - parser object", "- xmlToParse:XML - the xml describing the TCY Block", "- parent:FlowBlockElement - the parent of the new TCY Block"]},
{ "tagName": "return",
"values": ["TCYBlockElement - a new TCYBlockElement and its children"]} ],
"return": "void",
"params": [{ "name": "importFilter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutImporter"},
{ "name": "xmlToParse", "type": "XML"},
{ "name": "parent", "type": "org.apache.royale.textLayout.elements.FlowGroupElement"}]}
,
{ "type": "method",
"qname": "parseLink",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Parse a LinkElement Block.",
"tags": [
{ "tagName": "param",
"values": ["- importFilter:BaseTextLayoutImporter - parser object", "- xmlToParse:XML - the xml describing the Link", "- parent:FlowBlockElement - the parent of the new Link"]},
{ "tagName": "return",
"values": ["LinkElement - a new LinkElement and its children"]} ],
"return": "void",
"params": [{ "name": "importFilter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutImporter"},
{ "name": "xmlToParse", "type": "XML"},
{ "name": "parent", "type": "org.apache.royale.textLayout.elements.FlowGroupElement"}]}
,
{ "type": "method",
"qname": "createDictionaryFromXML",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"return": "org.apache.royale.utils.ObjectMap",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "parseLinkNormalFormat",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"return": "void",
"params": [{ "name": "importFilter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutImporter"},
{ "name": "xmlToParse", "type": "XML"},
{ "name": "parent", "type": "org.apache.royale.textLayout.elements.FlowGroupElement"}]}
,
{ "type": "method",
"qname": "parseLinkActiveFormat",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"return": "void",
"params": [{ "name": "importFilter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutImporter"},
{ "name": "xmlToParse", "type": "XML"},
{ "name": "parent", "type": "org.apache.royale.textLayout.elements.FlowGroupElement"}]}
,
{ "type": "method",
"qname": "parseLinkHoverFormat",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"return": "void",
"params": [{ "name": "importFilter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutImporter"},
{ "name": "xmlToParse", "type": "XML"},
{ "name": "parent", "type": "org.apache.royale.textLayout.elements.FlowGroupElement"}]}
,
{ "type": "method",
"qname": "createListMarkerFormatDictionaryFromXML",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"return": "org.apache.royale.utils.ObjectMap",
"params": [{ "name": "xmlToParse", "type": "XML"}]}
,
{ "type": "method",
"qname": "parseListMarkerFormat",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"return": "void",
"params": [{ "name": "importFilter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutImporter"},
{ "name": "xmlToParse", "type": "XML"},
{ "name": "parent", "type": "org.apache.royale.textLayout.elements.FlowGroupElement"}]}
,
{ "type": "method",
"qname": "parseDivElement",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Parse the <div ...> tag and all its children",
"tags": [
{ "tagName": "param",
"values": ["- importFilter:BaseTextLayoutImportFilter - parser object", "- xmlToParse:XML - the xml describing the Div", "- parent:FlowBlockElement - the parent of the new Div"]} ],
"return": "void",
"params": [{ "name": "importFilter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutImporter"},
{ "name": "xmlToParse", "type": "XML"},
{ "name": "parent", "type": "org.apache.royale.textLayout.elements.FlowGroupElement"}]}
,
{ "type": "method",
"qname": "parseInlineGraphic",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Parse a leaf element, the <img ...> tag.",
"tags": [
{ "tagName": "param",
"values": ["- importFilter:BaseTextLayoutImporter - parser object", "- xmlToParse:XML - the xml describing the InlineGraphic FlowElement", "- parent:FlowBlockElement - the parent of the new image FlowElement"]} ],
"return": "void",
"params": [{ "name": "importFilter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutImporter"},
{ "name": "xmlToParse", "type": "XML"},
{ "name": "parent", "type": "org.apache.royale.textLayout.elements.FlowGroupElement"}]}
,
{ "type": "method",
"qname": "parseTable",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Parse the <table ...> tag and all its children",
"tags": [
{ "tagName": "param",
"values": ["- importFilter:BaseTextLayoutImportFilter - parser object", "- xmlToParse:XML - the xml describing the Table", "- parent:FlowBlockElement - the parent of the new Table"]} ],
"return": "void",
"params": [{ "name": "importFilter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutImporter"},
{ "name": "xmlToParse", "type": "XML"},
{ "name": "parent", "type": "org.apache.royale.textLayout.elements.FlowGroupElement"}]}
,
{ "type": "method",
"qname": "parseTableRow",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Parse the <tr ...> tag (TableRowElement) and all its children",
"tags": [
{ "tagName": "param",
"values": ["- importFilter:BaseTextLayoutImportFilter - parser object", "- xmlToParse:XML - the xml describing the Table", "- parent:FlowBlockElement - the parent of the new Table"]} ],
"return": "void",
"params": [{ "name": "importFilter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutImporter"},
{ "name": "xmlToParse", "type": "XML"},
{ "name": "parent", "type": "org.apache.royale.textLayout.elements.FlowGroupElement"}]}
,
{ "type": "method",
"qname": "parseTableCell",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Parse the <td ...> or <th ...> tag (TableCellElement) and all its children",
"tags": [
{ "tagName": "param",
"values": ["- importFilter:BaseTextLayoutImportFilter - parser object", "- xmlToParse:XML - the xml describing the Table", "- parent:FlowBlockElement - the parent of the new Table"]} ],
"return": "void",
"params": [{ "name": "importFilter", "type": "org.apache.royale.textLayout.conversion.BaseTextLayoutImporter"},
{ "name": "xmlToParse", "type": "XML"},
{ "name": "parent", "type": "org.apache.royale.textLayout.elements.FlowGroupElement"}]}
,
{ "type": "method",
"qname": "getTextFlowContent",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Creates default text flow from the text value passed in. Used for table cell text flows. Used for testing. May be removed in the future.",
"return": "org.apache.royale.textLayout.elements.TextFlow",
"params": [{ "name": "text", "type": "String"},
{ "name": "selectable", "type": "Boolean"},
{ "name": "editable", "type": "Boolean"}]}
]
}