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

{ "type": "class",
  "qname": "org.apache.royale.textLayout.edit.TextScrap",
  "baseClassname": ""
  ,
    "description": "The TextScrap class represents a fragment of a text flow.  <p>A TextScrap is a holding place for all or part of a TextFlow. A range of text can be copied from a TextFlow into a TextScrap, and pasted from the TextScrap into another TextFlow.</p>",
  "tags": [
  {  "tagName": "see",
         "values": ["org.apache.royale.textLayout.elements.TextFlow", "org.apache.royale.textLayout.edit.SelectionManager"]},
      {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 1.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "field",
        "qname": "MERGE_TO_NEXT_ON_PASTE",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {}},
      { "type": "method",
        "qname": "org.apache.royale.textLayout.edit.TextScrap",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Creates a TextScrap object.  <p>Use the <code>createTextScrap()</code> method to create a TextScrap object from a range of text represented by a TextRange object.</p>  Otherwise, the TextScrap object is empty.",
        "tags": [
        {  "tagName": "param",
               "values": ["textFlow if set, the new TextScrap object contains the entire text flow."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": [{ "name": "textFlow", "type": "org.apache.royale.textLayout.elements.ITextFlow"}]}
      ,
      { "type": "method",
        "qname": "createTextScrap",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Creates a TextScrap object from a range of text represented by a TextRange object.",
        "tags": [
        {  "tagName": "param",
               "values": ["range the TextRange object representing the range of text to copy."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "org.apache.royale.textLayout.edit.TextScrap",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"}]}
      ,
      { "type": "accessor",
        "access": "read-only",
        "return": "org.apache.royale.textLayout.elements.ITextFlow",
        "qname": "textFlow",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Gets the TextFlow that is currently in the TextScrap.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "clone",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Creates a duplicate copy of this TextScrap object.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["TextScrap A copy of this TextScrap."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "org.apache.royale.textLayout.edit.TextScrap",
          "params": []}
      ,
      { "type": "method",
        "qname": "setPlainText",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Marks the TextScrap's content as being either plain or formatted",
          "return": "void",
          "params": [{ "name": "plainText", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "isPlainText",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Returns true if the text is plain text (not formatted)",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": []}
      ]
  }