flashx.textLayout.container

# ColumnState - AS3

Package | flashx.textLayout.container
Class | public class ColumnState
Inheritance | ColumnState 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).

Related API Elements

ContainerController

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | 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
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ColumnState(blockProgression:String, columnDirection:String, controller:ContainerController, compositionWidth:Number, compositionHeight:Number) Constructor function - creates a ColumnState object. | ColumnState
|  | getColumnAt(index:int):Rectangle Returns the area that a column takes within the container. | ColumnState
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

### columnCount

property

`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`

### columnGap

property

`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`

### columnWidth

property

`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.

Related API Elements

BlockProgression
Direction
Method Detail

### 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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00