| Package | flashx.textLayout.container |
| Class | public class ColumnState |
| Inheritance | ColumnState  Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Related API Elements
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 | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
ColumnState(blockProgression:String, columnDirection:String, controller:ContainerController, compositionWidth:Number, compositionHeight:Number)
Constructor function - creates a ColumnState object. | ColumnState | ||
Returns the area that a column takes within the container. | ColumnState | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
Property Detail
columnCount | property |
columnGap | property |
columnWidth | property |
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.
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
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.
|
Rectangle — The area of the specified column.
|
Mon Nov 28 2011, 06:48 AM -08:00