asdoc/org/apache/royale/textLayout/edit/ParaEdit.swf.json

{ "type": "class",
  "qname": "org.apache.royale.textLayout.edit.ParaEdit",
  "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": "insertText",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Inserts text into specified paragraph",
        "tags": [
        {  "tagName": "param",
               "values": ["textFlow  ITextFlow to insert into", "absoluteStart index relative to beginning of the ITextFlow to insert text", "text actual text to insert", "createNewSpan flag to force creation of a new span"]}  ],
          "return": "org.apache.royale.textLayout.elements.ISpanElement",
          "params": [{ "name": "textFlow", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "absoluteStart", "type": "int"},
        { "name": "insertText", "type": "String"},
        { "name": "createNewSpan", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "deleteText",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "return": "void",
          "params": [{ "name": "para", "type": "org.apache.royale.textLayout.elements.IParagraphElement"},
        { "name": "paraSelBegIdx", "type": "int"},
        { "name": "totalToDelete", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "createImage",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Creates image and inserts it into specified FlowGroupElement",
        "tags": [
        {  "tagName": "param",
               "values": ["flowBlock FlowGroupElement to insert image into", "flowSelBegIdx index relative to beginning of the FlowGroupElement to insert image", "urlString the url of image to insert", "width the width of the image", "height the height of the image", "options none supported"]},
            {  "tagName": "royaleignorecoercion",
               "values": ["org.apache.royale.textLayout.element.ISpanElement"]}  ],
          "return": "org.apache.royale.textLayout.elements.IInlineGraphicElement",
          "params": [{ "name": "flowBlock", "type": "org.apache.royale.textLayout.elements.IFlowGroupElement"},
        { "name": "flowSelBegIdx", "type": "int"},
        { "name": "source", "type": "Object"},
        { "name": "width", "type": "Object"},
        { "name": "height", "type": "Object"},
        { "name": "options", "type": "Object"},
        { "name": "pointFormat", "type": "org.apache.royale.textLayout.formats.ITextLayoutFormat"}]}
      ,
      { "type": "method",
        "qname": "applyTextStyleChange",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "return": "void",
          "params": [{ "name": "flowRoot", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "begChange", "type": "int"},
        { "name": "endChange", "type": "int"},
        { "name": "applyFormat", "type": "org.apache.royale.textLayout.formats.ITextLayoutFormat"},
        { "name": "undefineFormat", "type": "org.apache.royale.textLayout.formats.ITextLayoutFormat"}]}
      ,
      { "type": "method",
        "qname": "setTextStyleChange",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "return": "void",
          "params": [{ "name": "flowRoot", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "begChange", "type": "int"},
        { "name": "endChange", "type": "int"},
        { "name": "coreStyle", "type": "org.apache.royale.textLayout.formats.ITextLayoutFormat"}]}
      ,
      { "type": "method",
        "qname": "splitElement",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "",
        "tags": [
        {  "tagName": "royaleignorecoercion",
               "values": ["org.apache.royale.textLayout.elements.IFlowGroupElement"]}  ],
          "return": "org.apache.royale.textLayout.elements.IFlowGroupElement",
          "params": [{ "name": "elem", "type": "org.apache.royale.textLayout.elements.IFlowGroupElement"},
        { "name": "splitPos", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "mergeParagraphWithNext",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "",
        "tags": [
        {  "tagName": "royaleignorecoercion",
               "values": ["org.apache.royale.textLayout.element.IParagraphElement"]}  ],
          "return": "Boolean",
          "params": [{ "name": "para", "type": "org.apache.royale.textLayout.elements.IParagraphElement"}]}
      ,
      { "type": "method",
        "qname": "cacheParagraphStyleInformation",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "return": "void",
          "params": [{ "name": "flowRoot", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "begSel", "type": "int"},
        { "name": "endSel", "type": "int"},
        { "name": "undoArray", "type": "Array"}]}
      ,
      { "type": "method",
        "qname": "setParagraphStyleChange",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Replace the existing paragraph attributes with the incoming attributes.",
        "tags": [
        {  "tagName": "param",
               "values": ["flowRoot text flow where paragraphs are", "format attributes to apply", "beginIndex text index within the first paragraph in the range", "endIndex  text index within the last paragraph in the range"]}  ],
          "return": "void",
          "params": [{ "name": "flowRoot", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "begChange", "type": "int"},
        { "name": "endChange", "type": "int"},
        { "name": "format", "type": "org.apache.royale.textLayout.formats.ITextLayoutFormat"}]}
      ,
      { "type": "method",
        "qname": "applyParagraphStyleChange",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Additively apply the paragraph formating attributes to the paragraphs in the specified range. Each non-null field in the incoming format is copied into the existing paragraph attributes.",
        "tags": [
        {  "tagName": "param",
               "values": ["flowRoot text flow where paragraphs are", "format attributes to apply", "beginIndex text index within the first paragraph in the range", "endIndex  text index within the last paragraph in the range"]}  ],
          "return": "void",
          "params": [{ "name": "flowRoot", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "begChange", "type": "int"},
        { "name": "endChange", "type": "int"},
        { "name": "applyFormat", "type": "org.apache.royale.textLayout.formats.ITextLayoutFormat"},
        { "name": "undefineFormat", "type": "org.apache.royale.textLayout.formats.ITextLayoutFormat"}]}
      ,
      { "type": "method",
        "qname": "cacheStyleInformation",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "return": "void",
          "params": [{ "name": "flowRoot", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "begSel", "type": "int"},
        { "name": "endSel", "type": "int"},
        { "name": "undoArray", "type": "Array"}]}
      ,
      { "type": "method",
        "qname": "cacheContainerStyleInformation",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "return": "void",
          "params": [{ "name": "flowRoot", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "begIdx", "type": "int"},
        { "name": "endIdx", "type": "int"},
        { "name": "undoArray", "type": "Array"}]}
      ,
      { "type": "method",
        "qname": "applyContainerStyleChange",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "return": "void",
          "params": [{ "name": "flowRoot", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "begIdx", "type": "int"},
        { "name": "endIdx", "type": "int"},
        { "name": "applyFormat", "type": "org.apache.royale.textLayout.formats.ITextLayoutFormat"},
        { "name": "undefineFormat", "type": "org.apache.royale.textLayout.formats.ITextLayoutFormat"}]}
      ,
      { "type": "method",
        "qname": "setContainerStyleChange",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "obj is created by cacheContainerStyleInformation",
          "return": "void",
          "params": [{ "name": "obj", "type": "Object"}]}
      ]
  }