asdoc/spark/components/gridClasses/GridSelection.js.json

{ "type": "class",
  "qname": "spark.components.gridClasses.GridSelection",
  "baseClassname": ""
  ,
    "description": "Use the GridSelection class to track a Grid control's <code>selectionMode</code> property and its set of selected rows, columns, or cells. The selected elements are defined by integer indices.",
  "tags": [
  {  "tagName": "see",
         "values": ["spark.components.Grid", "spark.components.Grid#columns", "spark.components.Grid#dataProvider", "spark.components.gridClasses.GridSelectionMode"]},
      {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 2.5"]},
      {  "tagName": "productversion",
         "values": ["Flex 4.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "spark.components.gridClasses.GridSelection",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": []}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "spark.components.Grid",
        "qname": "grid",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The grid control associated with this object. This property should only be set once.  <p>For the Spark DataGrid, this value is initialized by the <code>DataGrid.partAdded()</code> method.</p>",
        "tags": [
        {  "tagName": "default",
               "values": ["null"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Boolean",
        "qname": "preserveSelection",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If <code>true</code>, and <code>selectionMode</code> is <code>GridSelectionMode.SINGLE_ROW</code> or <code>GridSelectionMode.SINGLE_CELL</code>, then selection is preserved when the <code>dataProvider</code> refreshes its collection, and the selected item is contained in the collection after the refresh.",
        "tags": [
        {  "tagName": "default",
               "values": ["true"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Boolean",
        "qname": "requireSelection",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If <code>true</code>, a data item must always be selected in the control as long as there is at least one item in <code>dataProvider</code> and one column in <code>columns</code>.",
        "tags": [
        {  "tagName": "default",
               "values": ["false"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "int",
        "qname": "selectionLength",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The length of the selection.  <p>If the <code>selectionMode</code> is either <code>GridSelectionMode.SINGLE_ROW</code> or <code>GridSelectionMode.MULTIPLE_ROWS</code>, contains the number of selected rows.  If a selected row has no <code>columns</code> whose <code>visible</code> property is set to <code>true</code> it is still included in the number of selected rows.</p>  <p>If the <code>selectionMode</code> is either <code>GridSelectionMode.SINGLE_CELL</code> or <code>GridSelectionMode.MULTIPLE_CELLS</code>, contains the number of selected cells. If a selected cell is in a column which has its <code>visible</code> property set to false after it is selected, the cell is included in the number of selected cells.</p>  <p>If the <code>selectionMode</code> is <code>GridSelectionMode.NONE</code>, contains 0.</p>",
        "tags": [
        {  "tagName": "default",
               "values": ["0"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["Number of selected rows or cells."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "selectionMode",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The selection mode of the control.  Possible values are: <code>GridSelectionMode.MULTIPLE_CELLS</code>, <code>GridSelectionMode.MULTIPLE_ROWS</code>, <code>GridSelectionMode.NONE</code>, <code>GridSelectionMode.SINGLE_CELL</code>, and <code>GridSelectionMode.SINGLE_ROW</code>.  <p>Changing the <code>selectionMode</code> causes the current selection to be cleared.</p>",
        "tags": [
        {  "tagName": "default",
               "values": ["GridSelectionMode.SINGLE_ROW"]},
            {  "tagName": "see",
               "values": ["spark.components.gridClasses.GridSelectionMode"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "allCells",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is either <code>GridSelectionMode.SINGLE_CELL</code> or <code>GridSelectionMode.MULTIPLE_CELLS</code>, returns a list of all the selected cells.  if none are selected, a Vector of length 0.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["Vector of selected cell locations as row and column indices or,"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Vector.<spark.components.gridClasses.CellPosition>",
          "params": []}
      ,
      { "type": "method",
        "qname": "allRows",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is either <code>GridSelectionMode.SINGLE_ROW</code> or <code>GridSelectionMode.MULTIPLE_ROWS</code>, returns a list of all the selected rows.  of length 0.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["Vector of selected rows as row indices or, if none, a Vector"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Vector.<int>",
          "params": []}
      ,
      { "type": "method",
        "qname": "selectAll",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is <code>GridSelectionMode.MULTIPLE_ROWS</code> selects all the rows in the grid and if <code>selectionMode</code> is <code>GridSelectionMode.MULTIPLE_CELLS</code>, selects all the cells in columns with <code>visible</code> set to <code>true</code>.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> if the selection changed."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": []}
      ,
      { "type": "method",
        "qname": "removeAll",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Remove the current selection. If <code>requireSelection</code> is <code>true</code>, and the <code>selectionMode</code> is row-based, then row 0 is selected. If the <code>selectionMode</code> is cell-based, then cell 0,0 is selected.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> if the list of selected items has changed from the last call."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": []}
      ,
      { "type": "method",
        "qname": "containsRow",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is either <code>GridSelectionMode.SINGLE_ROW</code> or <code>GridSelectionMode.MULTIPLE_ROWS</code>, determines if the row is in the current selection.",
        "tags": [
        {  "tagName": "param",
               "values": ["rowIndex The 0-based row index."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> if the row is in the selection"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "rowIndex", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "containsRows",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is <code>GridSelectionMode.MULTIPLE_ROWS</code>, determines if the rows are in the current selection.",
        "tags": [
        {  "tagName": "param",
               "values": ["rowIndex The 0-based row index."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> if the rows are in the selection"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "rowsIndices", "type": "Vector.<int>"}]}
      ,
      { "type": "method",
        "qname": "setRow",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is either <code>GridSelectionMode.SINGLE_ROW</code> or <code>GridSelectionMode.MULTIPLE_ROWS</code>, replaces the current selection with the specified row.   <code>rowIndex</code> is not a valid index in the control's <code>dataProvider</code>, or if the <code>selectionMode</code> is not valid.",
        "tags": [
        {  "tagName": "param",
               "values": ["rowIndex The 0-based row index."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> if no errors, or <code>false</code> if the"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "rowIndex", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "addRow",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is <code>GridSelectionMode.MULTIPLE_ROWS</code>, adds the row to the selection.   <code>rowIndex</code> is not a valid index in the control's <code>dataProvider</code>, or the <code>selectionMode</code> is not valid.",
        "tags": [
        {  "tagName": "param",
               "values": ["rowIndex The 0-based row index."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> if no errors, or <code>false</code> if the"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "rowIndex", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "removeRow",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is either <code>GridSelectionMode.SINGLE_ROW</code> or <code>GridSelectionMode.MULTIPLE_ROWS</code>, removes the row from the selection.   Returns <code>false</code> if the <code>rowIndex</code> is not a valid index in the control's <code>dataProvider</code>, or if the <code>selectionMode</code> is not valid.",
        "tags": [
        {  "tagName": "param",
               "values": ["rowIndex The 0-based row index."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> if no errors."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "rowIndex", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "setRows",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is <code>GridSelectionMode.MULTIPLE_ROWS</code>, replaces the current selection with the <code>rowCount</code> rows starting at <code>rowIndex</code>.   Returns <code>false</code> if any of the indices are invalid, if <code>startRowIndex</code> is not less than or equal to <code>endRowIndex</code>, or if the <code>selectionMode</code> is not valid.",
        "tags": [
        {  "tagName": "param",
               "values": ["rowIndex 0-based row index of the first row in the selection.", "rowCount Number of rows in the selection."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> if no errors."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "rowIndex", "type": "int"},
        { "name": "rowCount", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "containsCell",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is either <code>GridSelectionMode.SINGLE_CELLS</code> or <code>GridSelectionMode.MULTIPLE_CELLS</code>, determines if the cell is in the current selection.",
        "tags": [
        {  "tagName": "param",
               "values": ["rowIndex The 0-based row index.", "columnsIndex The 0-based column index."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> if the cell is in the selection."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "rowIndex", "type": "int"},
        { "name": "columnIndex", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "containsCellRegion",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is <code>GridSelectionMode.MULTIPLE_CELLS</code>, determines if all the cells in the cell region are in the current selection.",
        "tags": [
        {  "tagName": "param",
               "values": ["rowIndex The 0-based row index.", "columnsIndex The 0-based column index.", "rowCount The row height of the region.", "columnsCount The width of the cell region, in columns."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> if the cells are in the selection."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "rowIndex", "type": "int"},
        { "name": "columnIndex", "type": "int"},
        { "name": "rowCount", "type": "int"},
        { "name": "columnCount", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "setCell",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is either <code>GridSelectionMode.SINGLE_CELLS</code> or <code>GridSelectionMode.MULTIPLE_CELLS</code>, replaces the current selection with the cell at the given location.  The cell must be in a visible column.    Returns <code>false</code> if <code>rowIndex</code> is not a valid index in <code>dataProvider</code>, if <code>columnIndex</code> is not a valid index in <code>columns</code>, if the <code>selectionMode</code> is invalid or the column is not visible.",
        "tags": [
        {  "tagName": "param",
               "values": ["rowIndex The 0-based row index.", "columnsIndex The 0-based column index."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> no errors."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "rowIndex", "type": "int"},
        { "name": "columnIndex", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "addCell",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is <code>GridSelectionMode.MULTIPLE_CELLS</code>, adds the cell at the given location to the cell selection.  The cell must be in a visible column.    Returns <code>false</code> if <code>rowIndex</code> is not a valid index in <code>dataProvider</code>, if <code>columnIndex</code> is not a valid index in <code>columns</code>, if the <code>selectionMode</code> is invalid or the column is not visible.",
        "tags": [
        {  "tagName": "param",
               "values": ["rowIndex The 0-based row index.", "columnsIndex The 0-based column index."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> no errors."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "rowIndex", "type": "int"},
        { "name": "columnIndex", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "removeCell",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is either <code>GridSelectionMode.SINGLE_CELL</code> or <code>GridSelectionMode.MULTIPLE_CELLS</code>, removes the cell at the given position from the cell selection.    Returns <code>false</code> if <code>rowIndex</code> is not a valid index in <code>dataProvider</code>, or if <code>columnIndex</code> is not a valid index in <code>columns</code>, or if the <code>selectionMode</code> is invalid.",
        "tags": [
        {  "tagName": "param",
               "values": ["rowIndex The 0-based row index.", "columnsIndex The 0-based column index."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> if no errors."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "rowIndex", "type": "int"},
        { "name": "columnIndex", "type": "int"}]}
      ,
      { "type": "method",
        "qname": "setCellRegion",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "If the <code>selectionMode</code> is <code>GridSelectionMode.MULTIPLE_CELLS</code>, replaces the current selection with the cells in the given cell region. The origin of the cell region is the cell location specified by <code>rowIndex</code> and <code>columnIndex</code>, the width is <code>columnCount</code> and the height is <code>rowCound</code>.  <p>Only cells in columns which are visible at the time of selection are included in the selection.</p>      Returns <code>false</code> if <code>rowIndex</code> is not a valid index in <code>dataProvider</code>, if <code>columnIndex</code> is not a valid index in <code>columns</code>, or if the <code>selectionMode</code> is invalid.",
        "tags": [
        {  "tagName": "param",
               "values": ["rowIndex The 0-based row index of the origin.", "columnsIndex The 0-based column index of the origin.", "rowCount The row height of the cell region.", "columnsCount The column width of the cell region."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code> if no errors."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "rowIndex", "type": "int"},
        { "name": "columnIndex", "type": "int"},
        { "name": "rowCount", "type": "uint"},
        { "name": "columnCount", "type": "uint"}]}
      ]
  }