Packageflashx.textLayout.container
Classpublic class ColumnState
InheritanceColumnState Inheritance Object

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

The ColumnState class calculates the sizes and locations of columns using the width of the container and the container attributes. You can create instances of this class independently to calculate column values, or you can get the column values that were used for the text after the container has been composed or updated (redrawn).

See also

ContainerController


Public Properties
 PropertyDefined By
  cellCount : int
[read-only] The number of cells in the container.
ColumnState
  columnCount : int
[read-only] The number of columns in the container.
ColumnState
  columnGap : Number
[read-only] The amount of space, in pixels, left between columns in the container.
ColumnState
  columnWidth : Number
[read-only] The width of columns, in pixels, in the container.
ColumnState
Public Methods
 MethodDefined By
  
ColumnState(blockProgression:String, columnDirection:String, controller:ContainerController, compositionWidth:Number, compositionHeight:Number)
Constructor function - creates a ColumnState object.
ColumnState
  
ColumnState
  
ColumnState
  
getColumnAt(index:int):Rectangle
Returns the area that a column takes within the container.
ColumnState
  
ColumnState
Property Detail
cellCountproperty
cellCount:int  [read-only]

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

The number of cells in the container.


Implementation
    public function get cellCount():int
columnCountproperty 
columnCount:int  [read-only]

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

The number of columns in the container.


Implementation
    public function get columnCount():int
columnGapproperty 
columnGap:Number  [read-only]

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

The amount of space, in pixels, left between columns in the container.


Implementation
    public function get columnGap():Number
columnWidthproperty 
columnWidth:Number  [read-only]

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

The width of columns, in pixels, in the container.


Implementation
    public function get columnWidth():Number
Constructor Detail
ColumnState()Constructor
public function ColumnState(blockProgression:String, columnDirection:String, controller:ContainerController, compositionWidth:Number, compositionHeight:Number)

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Constructor function - creates a ColumnState object. If the values of controller.compositionWidth and controller.compositionHeight equal NaN (not a number), the constructor measures the container's contents to determine the actual composition width and height that feed into ColumnState. Use the constants defined by the flashx.textLayout.formats.BlockProgression class to specify the value of the blockProgression parameter. Use the constants defined by flashx.textLayout.formats.Direction to specify the value of the columnDirection parameter.

Parameters
blockProgression:String — The direction of lines for the textflow, either BlockProgression.TB (top-to-bottom) or BlockProgression.RL (right-to-left).
 
columnDirection:String — The direction of column layout for the text flow, either Direction.RTL (right-to-left) or Direction.LTR (left-to-right).
 
controller:ContainerController — A ContainerController instance whose attributes are used to calculate the column values.
 
compositionWidth:Number — The horizontal extent, in pixels, allowed for text inside the container.
 
compositionHeight:Number — The vertical extent, in pixels, allowed for text inside the container.

See also

Method Detail
clearCellList()method
public function clearCellList():void

getCellAt()method 
public function getCellAt(index:int):TableCellElement

Parameters

index:int

Returns
TableCellElement
getColumnAt()method 
public function getColumnAt(index:int):Rectangle

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Returns the area that a column takes within the container. Allows you to access the area for a specific column.

Parameters

index:int — The relative position of the column among all columns in the container, with the first column at position 0.

Returns
Rectangle — The area of the specified column.
pushTableCell()method 
public function pushTableCell(cell:TableCellElement):void

Parameters

cell:TableCellElement