asdoc/org/apache/royale/textLayout/accessibility/TextAccImpl.swf.json

{ "type": "class",
  "qname": "org.apache.royale.textLayout.accessibility.TextAccImpl",
  "baseClassname": "flash.accessibility.AccessibilityImplementation"
  ,
    "description": "The TextAccImpl class adds accessibility for text components. This hooks into DisplayObjects when TextFlow.container is set.",
  "tags": [
  {  "tagName": "private",
         "values": []}  ],
  "members": [
  { "type": "field",
        "qname": "STATE_SYSTEM_NORMAL",
        "return": "uint",
        "namespace": "protected",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Default state"},
      { "type": "field",
        "qname": "STATE_SYSTEM_READONLY",
        "return": "uint",
        "namespace": "protected",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Read-only text"},
      { "type": "field",
        "qname": "STATE_SYSTEM_INVISIBLE",
        "return": "uint",
        "namespace": "protected",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Inivisible text"},
      { "type": "field",
        "qname": "ROLE_SYSTEM_STATICTEXT",
        "return": "uint",
        "namespace": "protected",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Default role -- read-only, unselectable text."},
      { "type": "field",
        "qname": "ROLE_SYSTEM_TEXT",
        "return": "uint",
        "namespace": "protected",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Editable OR read-only, selectable text."},
      { "type": "field",
        "qname": "EVENT_OBJECT_NAMECHANGE",
        "return": "uint",
        "namespace": "protected",
        "bindable": [],
        "details": ["static"],
        "deprecated": {}},
      { "type": "field",
        "qname": "EVENT_OBJECT_VALUECHANGE",
        "return": "uint",
        "namespace": "protected",
        "bindable": [],
        "details": ["static"],
        "deprecated": {}},
      { "type": "field",
        "qname": "textContainer",
        "return": "flash.display.DisplayObject",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "A reference to the DisplayObject that is hosting accessible text."},
      { "type": "field",
        "qname": "textFlow",
        "return": "org.apache.royale.textLayout.elements.TextFlow",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "A reference to the TextFlow where our text originates."},
      { "type": "method",
        "qname": "org.apache.royale.textLayout.accessibility.TextAccImpl",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.  TextAccImpl instance is making accessible.",
        "tags": [
        {  "tagName": "param",
               "values": ["textContainer The DisplayObject instance that this", "textFlow The TextFlow that is hosting the textContainer."]}  ],
          "return": "",
          "params": [{ "name": "textCont", "type": "flash.display.DisplayObject"},
        { "name": "textFlow", "type": "org.apache.royale.textLayout.elements.TextFlow"}]}
      ,
      { "type": "method",
        "qname": "detachListeners",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "void",
          "params": []}
      ,
      { "type": "method",
        "qname": "get_accRole",
        "namespace": "public",
        "bindable": [],
        "details": ["override"],
        "deprecated": {},
          "description": "Returns the system role for the text.",
        "tags": [
        {  "tagName": "param",
               "values": ["childID uint."]},
            {  "tagName": "return",
               "values": ["Role associated with the text."]}  ],
          "return": "uint",
          "params": [{ "name": "childID", "type": "uint"}]}
      ,
      { "type": "method",
        "qname": "get_accState",
        "namespace": "public",
        "bindable": [],
        "details": ["override"],
        "deprecated": {},
          "description": "Returns the state of the text.",
        "tags": [
        {  "tagName": "param",
               "values": ["childID uint."]},
            {  "tagName": "return",
               "values": ["Role associated with the text."]}  ],
          "return": "uint",
          "params": [{ "name": "childID", "type": "uint"}]}
      ,
      { "type": "method",
        "qname": "get_accName",
        "namespace": "public",
        "bindable": [],
        "details": ["override"],
        "deprecated": {},
          "description": "Returns the name of the text.",
        "tags": [
        {  "tagName": "param",
               "values": ["childID uint."]},
            {  "tagName": "return",
               "values": ["Name of the text."]}  ],
          "return": "String",
          "params": [{ "name": "childID", "type": "uint"}]}
      ,
      { "type": "method",
        "qname": "get_accValue",
        "namespace": "public",
        "bindable": [],
        "details": ["override"],
        "deprecated": {},
          "description": "Returns the value of the text.",
        "tags": [
        {  "tagName": "param",
               "values": ["childID uint."]},
            {  "tagName": "return",
               "values": ["Name of the text."]}  ],
          "return": "String",
          "params": [{ "name": "childID", "type": "uint"}]}
      ,
      { "type": "method",
        "qname": "eventHandler",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Handles COMPOSITION_COMPLETE and SELECTION_CHANGE events, updates the MSAA model.",
          "return": "void",
          "params": [{ "name": "event", "type": "org.apache.royale.events.Event"}]}
      ,
      { "type": "accessor",
        "access": "read-only",
        "return": "int",
        "qname": "selectionActiveIndex",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The zero-based character index value of the first character in the current selection. Components which wish to support inline IME or Accessibility should call into this method.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.0"]},
            {  "tagName": "return",
               "values": ["the index of the character at the anchor end of the selection, or <code>-1</code> if no text is selected."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "int",
        "qname": "selectionAnchorIndex",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The zero-based character index value of the last character in the current selection. Components which wish to support inline IME or Accessibility should call into this method.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.0"]},
            {  "tagName": "return",
               "values": ["the index of the character at the active end of the selection, or <code>-1</code> if no text is selected."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "String",
        "qname": "searchText",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Enable search index for Ichabod Returns the entire text of the TextFlow, or null if search index is not enabled",
        "tags": [
        {  "tagName": "see",
               "values": ["GlobalSettings.searchIndexEnabled"]}  ]}]
  }