asdoc/org/apache/royale/textLayout/edit/TextFlowEdit.js.json

{ "type": "class",
  "qname": "org.apache.royale.textLayout.edit.TextFlowEdit",
  "baseClassname": ""
  ,
    "description": "Encapsulates all methods necessary for dynamic editing of a text.  The methods are all static member functions of this class.",
  "tags": [
  {  "tagName": "private",
         "values": ["- because we can't make it tlf_internal. Used by the operations package"]}  ],
  "members": [
  { "type": "method",
        "qname": "deleteRange",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "return": "org.apache.royale.textLayout.elements.IParagraphElement",
          "params": [{ "name": "textFlow", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "startPos", "type": "int"},
        { "name": "endPos", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "insertTextScrap",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Replaces the range of text positions that the <code>startPos</code> and <code>endPos</code> parameters specify with the <code>textScrap</code> parameter in <code>theFlow</code>. <p>To delete elements, pass <code>null</code> for <code>newTextFlow</code>.</p> <p>To insert an element, pass the same value for <code>startPos</code> and <code>endPos</code>. <p>The new element will be inserted before the specified index.</p> <p>To append the ITextFlow, pass <code>theFlow.length</code> for <code>startPos</code> and <code>endPos</code>.</p>",
        "tags": [
        {  "tagName": "param",
               "values": ["destinationFlow The ITextFlow that is being inserted into.", "absoluteStart The index value of the first position of the replacement range in the ITextFlow.", "textScrap The TextScrap to be pasted into theFlow."]}  ],
          "return": "int",
          "params": [{ "name": "destinationFlow", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "absoluteStart", "type": "int"},
        { "name": "textScrap", "type": "org.apache.royale.textLayout.edit.TextScrap"},
        { "name": "applyFormat", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "makeTCY",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Creates a TCY run out of the selected positions.",
        "tags": [
        {  "tagName": "param",
               "values": ["theFlow The ITextFlow of interest.", "startPos The index value of the first position of the ITextFlow to be turned into a TCY run.", "endPos The index value following the end position of the ITextFlow to be turned into a TCY run."]}  ],
          "return": "Boolean",
          "params": [{ "name": "theFlow", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "startPos", "type": "int"},
        { "name": "endPos", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "makeLink",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Creates one or more LinkElements out of the selected positions. It will go through every paragraph within the selected position and make links.",
        "tags": [
        {  "tagName": "param",
               "values": ["theFlow The ITextFlow of interest.", "startPos The index value of the first position of the ITextFlow to be turned into a link.", "endPos The index value following the end position of the ITextFlow to be turned into a link.", "urlString The url string to be associated with the link."]}  ],
          "return": "Boolean",
          "params": [{ "name": "theFlow", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "startPos", "type": "int"},
        { "name": "endPos", "type": "int"},
        { "name": "urlString", "type": "String"},
        { "name": "target", "type": "String"}]}
      ,
      { "type": "method",
        "qname": "removeTCY",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Removes the TCY block at the selected positions.",
        "tags": [
        {  "tagName": "param",
               "values": ["theFlow The ITextFlow of interest.", "startPos The index value of the first position of the ITextFlow.", "endPos The index value following the end position of the ITextFlow."]}  ],
          "return": "Boolean",
          "params": [{ "name": "theFlow", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "startPos", "type": "int"},
        { "name": "endPos", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "removeLink",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Removes all LinkElements under the selected positions. It will go through every paragraph within the selected position and remove any link.",
        "tags": [
        {  "tagName": "param",
               "values": ["theFlow The ITextFlow of interest.", "startPos The index value of the first position of the ITextFlow.", "endPos The index value following the end position of the ITextFlow."]}  ],
          "return": "Boolean",
          "params": [{ "name": "theFlow", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "startPos", "type": "int"},
        { "name": "endPos", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "findNextParagraph",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "returns next paragraph in reading order after para. Used for merging paragraphs after delete.",
          "return": "org.apache.royale.textLayout.elements.IParagraphElement",
          "params": [{ "name": "para", "type": "org.apache.royale.textLayout.elements.IParagraphElement"}]}
      ,
      { "type": "method",
        "qname": "removeEmptyParentChain",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "if parent is a singleton element, deletes it, then repeats deletion of singletons up the parent chain.  Used after paragraph merge.",
          "return": "org.apache.royale.textLayout.edit.IMemento",
          "params": [{ "name": "parent", "type": "org.apache.royale.textLayout.elements.IFlowGroupElement"}]}
      ,
      { "type": "method",
        "qname": "joinNextParagraph",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Joins this paragraph's next sibling to this if it is a paragraph",
          "return": "org.apache.royale.textLayout.edit.IMemento",
          "params": [{ "name": "para", "type": "org.apache.royale.textLayout.elements.IParagraphElement"},
        { "name": "inSameParent", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "joinToNextParagraph",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Joins this paragraph's next sibling to this if it is a paragraph",
          "return": "org.apache.royale.textLayout.edit.MementoList",
          "params": [{ "name": "para", "type": "org.apache.royale.textLayout.elements.IParagraphElement"},
        { "name": "inSameParent", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "joinToElement",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Joins this element2 to element1 -- all children of element2 added to end of element1",
          "return": "org.apache.royale.textLayout.edit.IMemento",
          "params": [{ "name": "element1", "type": "org.apache.royale.textLayout.elements.IFlowGroupElement"},
        { "name": "element2", "type": "org.apache.royale.textLayout.elements.IFlowGroupElement"}]}
      ,
      { "type": "method",
        "qname": "joinToNextElement",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Joins this element1 to element2 -- all children of element1 added to front of element2",
          "return": "org.apache.royale.textLayout.edit.MementoList",
          "params": [{ "name": "element1", "type": "org.apache.royale.textLayout.elements.IFlowGroupElement"},
        { "name": "element2", "type": "org.apache.royale.textLayout.elements.IFlowGroupElement"}]}
      ]
  }