asdoc/org/apache/royale/textLayout/utils/NavigationUtil.swf.json

{ "type": "class",
  "qname": "org.apache.royale.textLayout.utils.NavigationUtil",
  "baseClassname": ""
  ,
    "description": "Utilities for manipulating a TextRange The methods of this class are static and must be called using the syntax <code>NavigationUtil.method(<em>parameter</em>)</code>.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 1.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "previousAtomPosition",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Returns the absolute position of the previous atom.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "int",
          "params": [{ "name": "flowRoot", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "absolutePos", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "nextAtomPosition",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Returns the absolute position of the next atom.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "int",
          "params": [{ "name": "flowRoot", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "absolutePos", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "previousWordPosition",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Returns absolute position of the beginning of the previous word.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "int",
          "params": [{ "name": "flowRoot", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "absolutePos", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "nextWordPosition",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Returns the absolute position of the beginning of the next word.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "int",
          "params": [{ "name": "flowRoot", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "absolutePos", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "nextCharacter",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange forward by one character.",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "previousCharacter",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange backward by one character.",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "nextWord",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange forward by one word.",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "previousWord",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange backward by one word.",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "nextLine",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange down one line",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "previousLine",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange up one line.",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "nextPage",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange down one page.",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "previousPage",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange up one page.",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "endOfLine",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange at the end of the line.",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "startOfLine",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange at the beginning of the line.",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "endOfDocument",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange at the end of the document.",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "startOfDocument",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange at the beginning of the document.",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "startOfParagraph",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange at the beginning of the paragraph.",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "endOfParagraph",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Sets the TextRange at the end of the paragraph.",
        "tags": [
        {  "tagName": "param",
               "values": ["extendSelection Indicates that only activeIndex should move"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "range", "type": "org.apache.royale.textLayout.elements.TextRange"},
        { "name": "extendSelection", "type": "Boolean"}]}
      ]
  }