| Package | flashx.textLayout.formats |
| Interface | public interface IContainerFormat |
| Implementors | ContainerFormat |
| Property | Defined By | ||
|---|---|---|---|
| blockProgression : String [read-only] Settings for line layout. | IContainerFormat | ||
| columnCount : Object [read-only] Number of text columns. | IContainerFormat | ||
| columnGap : Object [read-only] Gutter space between the columns in pixels. | IContainerFormat | ||
| columnWidth : Object [read-only] Width of column in pixels. | IContainerFormat | ||
| firstBaselineOffset : Object [read-only] Position of the baseline of first line in the container (in pixels). | IContainerFormat | ||
| firstBaselineOffsetBasis : String [read-only] Specifies the baseline to which the firstBaselineOffset property refers. | IContainerFormat | ||
| lineBreak : String [read-only] Controls word wrapping within the container. | IContainerFormat | ||
| paddingBottom : Object [read-only] Botttom inset in pixels. | IContainerFormat | ||
| paddingLeft : Object [read-only] Left inset in pixels. | IContainerFormat | ||
| paddingRight : Object [read-only] Right inset in pixels. | IContainerFormat | ||
| paddingTop : Object [read-only] Top inset in pixels. | IContainerFormat | ||
| verticalAlign : String [read-only] Vertical alignment or justification. | IContainerFormat | ||
| blockProgression | property |
blockProgression:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Settings for line layout. Controls placement of lines. Lines are either placed top-to-bottom (TB, used for horizontal text) or right-to-left (RL, used for vertical text).
Legal values are flashx.textLayout.formats.BlockProgression.RL, flashx.textLayout.formats.BlockProgression.TB.
Default value is TB.
Values may be null indicating not set.
public function get blockProgression():StringSee also
| columnCount | property |
columnCount:Object [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Number of text columns. The column number overrides the other column settings. Value is an Integer, or AUTO if unspecified. If columnCount is not specified, columnWidth is used to create as many columns as can fit in the container.
Legal values as a string are flashx.textLayout.formats.FormatValue.AUTO and from 1 to 50.
Default value is AUTO.
Values may be null indicating not set.
public function get columnCount():ObjectSee also
| columnGap | property |
columnGap:Object [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Gutter space between the columns in pixels. Amount of space to leave between columns. Value is a Number
Legal values are from 0 to 1000.
Default value is 0.
Values may be null indicating not set.
public function get columnGap():Object| columnWidth | property |
columnWidth:Object [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Width of column in pixels.
If you specify the width of the columns, but not the count, TextLayout will create as many columns of that width as possible given the the container width and
columnGap
settings. Any remainder space is left after the last column. Value is a Number.
Legal values as a string are flashx.textLayout.formats.FormatValue.AUTO and from 0 to 8000.
Default value is AUTO.
Values may be null indicating not set.
public function get columnWidth():ObjectSee also
| firstBaselineOffset | property |
firstBaselineOffset:Object [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Position of the baseline of first line in the container (in pixels).
The offset from the top inset (or right inset if
blockProgression
is RL) of the container to the baseline of the first line can be either ASCENT, meaning equal to the ascent of the line, LINE_HEIGHT, equal to the height of that first line, or any fixed value number to specify an absolute distance. AUTO aligns the ascent of the line with the container top inset.
Legal values as a string are flashx.textLayout.formats.BaselineOffset.AUTO, flashx.textLayout.formats.BaselineOffset.ASCENT, flashx.textLayout.formats.BaselineOffset.LINE_HEIGHT and from 0 to 1000.
Default value is AUTO.
Values may be null indicating not set.
public function get firstBaselineOffset():ObjectSee also
| firstBaselineOffsetBasis | property |
firstBaselineOffsetBasis:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the baseline to which the
firstBaselineOffset
property refers.
This property is ignored when
firstBaselineOffset
is AUTO.
Legal values are flash.text.engine.TextBaseline.ROMAN, flash.text.engine.TextBaseline.ASCENT, flash.text.engine.TextBaseline.DESCENT, flash.text.engine.TextBaseline.IDEOGRAPHIC_TOP, flash.text.engine.TextBaseline.IDEOGRAPHIC_CENTER, flash.text.engine.TextBaseline.IDEOGRAPHIC_BOTTOM.
Default value is ROMAN.
Values may be null indicating not set.
public function get firstBaselineOffsetBasis():StringSee also
| lineBreak | property |
lineBreak:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Controls word wrapping within the container. Text in the container may be set to fit the width of the container (TO_FIT), or can be set to break only at explicit return/line feeds (EXPLICIT).
Legal values are flashx.textLayout.formats.LineBreak.EXPLICIT, flashx.textLayout.formats.LineBreak.TO_FIT.
Default value is TO_FIT.
Values may be null indicating not set.
public function get lineBreak():StringSee also
| paddingBottom | property |
paddingBottom:Object [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Botttom inset in pixels. Space between the bottom edge of the container and the text. Value is a Number.
Legal values are from 0 to 1000.
Default value is 0.
Values may be null indicating not set.
public function get paddingBottom():Object| paddingLeft | property |
paddingLeft:Object [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Left inset in pixels. Space between the left edge of the container and the text. Value is a Number.
Legal values are from 0 to 1000.
Default value is 0.
Values may be null indicating not set.
public function get paddingLeft():Object| paddingRight | property |
paddingRight:Object [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Right inset in pixels. Space between the right edge of the container and the text. Value is a Number.
Legal values are from 0 to 1000.
Default value is 0.
Values may be null indicating not set.
public function get paddingRight():Object| paddingTop | property |
paddingTop:Object [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Top inset in pixels. Space between the top edge of the container and the text. Value is a Number.
Legal values are from 0 to 1000.
Default value is 0.
Values may be null indicating not set.
public function get paddingTop():Object| verticalAlign | property |
verticalAlign:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Vertical alignment or justification. Determines how TextFlow elements align within the container.
Legal values are flashx.textLayout.formats.VerticalAlign.TOP, flashx.textLayout.formats.VerticalAlign.MIDDLE, flashx.textLayout.formats.VerticalAlign.BOTTOM, flashx.textLayout.formats.VerticalAlign.JUSTIFY.
Default value is TOP.
Values may be null indicating not set.
public function get verticalAlign():StringSee also
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/labs/textlayout/flashx/textLayout/formats/IContainerFormat.html