asdoc/org/apache/royale/textLayout/elements/CellRange.js.json

{ "type": "class",
  "qname": "org.apache.royale.textLayout.elements.CellRange",
  "baseClassname": ""
  ,
    "description": "A read only class that describes a range of contiguous table cells. Such a range occurs when you select a section of table cells. The range consists of the anchor point of the selection, <code>anchorPosition</code>, and the point that is to be modified by actions, <code>activePosition</code>.  As block selections are modified and extended <code>anchorPosition</code> remains fixed and <code>activePosition</code> is modified. The anchor position may be placed in the text before or after the active position.",
  "tags": [
  {  "tagName": "see",
         "values": ["org.apache.royale.textLayout.elements.TextFlow TextFlow", "org.apache.royale.textLayout.edit.SelectionState SelectionState"]},
      {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 1.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "org.apache.royale.textLayout.elements.CellRange",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "",
          "params": [{ "name": "table", "type": "org.apache.royale.textLayout.elements.ITableElement"},
        { "name": "anchorCoords", "type": "org.apache.royale.textLayout.elements.CellCoordinates"},
        { "name": "activeCoords", "type": "org.apache.royale.textLayout.elements.CellCoordinates"}]}
      ,
      { "type": "method",
        "qname": "updateRange",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Update the range with new anchor or active position values.",
        "tags": [
        {  "tagName": "param",
               "values": ["newAnchorPosition the anchor index of the selection.", "newActivePosition the active index of the selection."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["true if selection is changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "newAnchorCoordinates", "type": "org.apache.royale.textLayout.elements.CellCoordinates"},
        { "name": "newActiveCoordinates", "type": "org.apache.royale.textLayout.elements.CellCoordinates"}]}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "org.apache.royale.textLayout.elements.ITableElement",
        "qname": "table",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The TableElement of the selection."},
      { "type": "accessor",
        "access": "read-write",
        "return": "org.apache.royale.textLayout.elements.CellCoordinates",
        "qname": "anchorCoordinates",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Anchor point of the current selection, as a CellCoordinates in the TableElement."},
      { "type": "accessor",
        "access": "read-write",
        "return": "org.apache.royale.textLayout.elements.CellCoordinates",
        "qname": "activeCoordinates",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Active end of the current selection, as a CellCoordinates in the TableElement."}]
  }