asdoc/spark/core/IEditableText.swf.json

{ "type": "interface",
  "qname": "spark.core.IEditableText",
"baseInterfaceNames": [
"spark.core.IDisplayText"]
,
    "description": "The IEditableText interface defines the properties and methods for editable text.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10.1", "AIR 2.0"]},
      {  "tagName": "productversion",
         "values": ["Royale 0.9.7"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "displayAsPassword",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "copy",
           "values": ["flash.text.TextField#displayAsPassword"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "editable",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Flag that indicates whether the text is editable.",
    "tags": [
    {  "tagName": "default",
           "values": ["false"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "enabled",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "copy",
           "values": ["mx.core.UIComponent#enabled"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "focusEnabled",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "copy",
           "values": ["mx.core.UIComponent#focusEnabled"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Number",
    "qname": "horizontalScrollPosition",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The horizontal scroll position of the text.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "String",
    "qname": "lineBreak",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Controls word wrapping within the text. This property corresponds to the lineBreak style.",
    "tags": [
    {  "tagName": "see",
           "values": ["flashx.textLayout.formats.ITextLayoutFormat#lineBreak"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "int",
    "qname": "maxChars",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "copy",
           "values": ["flash.text.TextField#maxChars"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "multiline",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "copy",
           "values": ["flash.text.TextField#multiline"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "String",
    "qname": "restrict",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "copy",
           "values": ["flash.text.TextField#restrict"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "selectable",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "copy",
           "values": ["flash.text.TextField#selectable"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "int",
    "qname": "selectionActivePosition",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The active, or last clicked position, of the selection. If the implementation does not support selection anchor this is the last character of the selection.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-only",
    "return": "int",
    "qname": "selectionAnchorPosition",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The anchor, or first clicked position, of the selection. If the implementation does not support selection anchor this is the first character of the selection.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "int",
    "qname": "tabIndex",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "copy",
           "values": ["flash.display.InteractiveObject#tabIndex"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Number",
    "qname": "verticalScrollPosition",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The vertical scroll position of the text.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "method",
    "qname": "scrollToRange",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Scroll so the specified range is in view.",
    "tags": [
    {  "tagName": "param",
           "values": ["anchorPosition The anchor position of the selection range.", "activePosition The active position of the selection range."]},
        {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": [{ "name": "anchorPosition", "type": "int"},
    { "name": "activePosition", "type": "int"}]}
  ,
  { "type": "method",
    "qname": "insertText",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Inserts the specified text into the text component as if you had typed it.  <p>If a range was selected, the new text replaces the selected text. If there was an insertion point, the new text is inserted there.</p>  <p>An insertion point is then set after the new text. If necessary, the text will scroll to ensure that the insertion point is visible.</p>",
    "tags": [
    {  "tagName": "param",
           "values": ["text The text to be inserted."]},
        {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": [{ "name": "text", "type": "String"}]}
  ,
  { "type": "method",
    "qname": "appendText",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Appends the specified text to the end of the text component, as if you had clicked at the end and typed.  <p>An insertion point is then set after the new text. If necessary, the text will scroll to ensure that the insertion point is visible.</p>",
    "tags": [
    {  "tagName": "param",
           "values": ["text The text to be appended."]},
        {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": [{ "name": "text", "type": "String"}]}
  ,
  { "type": "method",
    "qname": "selectRange",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Selects a specified range of characters.  <p>If either position is negative, it will deselect the text range.</p>  of the selection that stays fixed when the selection is extended.  of the selection that moves when the selection is extended.",
    "tags": [
    {  "tagName": "param",
           "values": ["anchorPosition The character position specifying the end", "activePosition The character position specifying the end"]},
        {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": [{ "name": "anchorIndex", "type": "int"},
    { "name": "activeIndex", "type": "int"}]}
  ,
  { "type": "method",
    "qname": "selectAll",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Selects all of the text.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": []}
  ,
  { "type": "method",
    "qname": "setFocus",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Set focus to this text field.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.1", "AIR 2.0"]},
        {  "tagName": "productversion",
           "values": ["Flex 4.5"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": []}
  ]
  }