Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
CellRange

Package | flashx.textLayout.elements
Class | public class CellRange
Inheritance | CellRange Object

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

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, `anchorPosition`, and the point that is to be modified by actions, `activePosition`. As block selections are modified and extended `anchorPosition` remains fixed and `activePosition` is modified. The anchor position may be placed in the text before or after the active position.

See also

TextFlow
SelectionState

Public Properties

| Property | Defined By
--- | --- | ---
|  | activeCoordinates : CellCoordinates Active end of the current selection, as a CellCoordinates in the TableElement. | CellRange
|  | anchorCoordinates : CellCoordinates Anchor point of the current selection, as a CellCoordinates in the TableElement. | CellRange
|  | table : TableElement The TableElement of the selection. | CellRange

Public Methods

| Method | Defined By
--- | --- | ---
|  | CellRange(table:TableElement, anchorCoords:CellCoordinates, activeCoords:CellCoordinates) | CellRange
|  | updateRange(newAnchorCoordinates:CellCoordinates, newActiveCoordinates:CellCoordinates):Boolean Update the range with new anchor or active position values. | CellRange

Property Detail

activeCoordinates | property

`activeCoordinates:CellCoordinates`

Active end of the current selection, as a CellCoordinates in the TableElement.

Implementation
`public function get activeCoordinates():CellCoordinates`
`public function set activeCoordinates(value:CellCoordinates):void`

anchorCoordinates | property |

`anchorCoordinates:CellCoordinates`

Anchor point of the current selection, as a CellCoordinates in the TableElement.

Implementation
`public function get anchorCoordinates():CellCoordinates`
`public function set anchorCoordinates(value:CellCoordinates):void`

table | property |

`table:TableElement`

The TableElement of the selection.

Implementation
`public function get table():TableElement`
`public function set table(value:TableElement):void`
Constructor Detail

CellRange | () | Constructor

`public function CellRange(table:TableElement, anchorCoords:CellCoordinates, activeCoords:CellCoordinates)`

Parameters

| `table:TableElement`
| `anchorCoords:CellCoordinates`
| `activeCoords:CellCoordinates`

Method Detail

updateRange | () | method

`public function updateRange(newAnchorCoordinates:CellCoordinates, newActiveCoordinates:CellCoordinates):Boolean`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Update the range with new anchor or active position values.

Parameters

| `newAnchorCoordinates:CellCoordinates` — the anchor index of the selection.
| `newActiveCoordinates:CellCoordinates` — the active index of the selection.

Returns

| `Boolean` — true if selection is changed.

Sun Mar 5 2017, 03:42 PM +11:00