Package | flashx.textLayout.formats |
Class | public class TextLayoutFormat |
Inheritance | TextLayoutFormat Object |
Implements | ITextLayoutFormat |
Subclasses | ListMarkerFormat |
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
format
properties that enable you to assign a TextLayoutFormat instance to them. Assign a TextLayoutFormat object to a container to affect the format of all of the container's content. Assign a TextLayoutFormat object to a FlowElement descendant to specify formatting for that particular element: TextFlow, ParagraphElement, DivElement, SpanElement, InlineGraphicElement, LinkElement, and TCYElement.
In addition to the format
property, these classes also define each of the individual TextLayoutFormat properties so that you can override the setting of a particular style property for that element, if you wish. Because you can set a given style at multiple levels, it is possible to have conflicts. For example, the color of the text at the TextFlow level could be set to black while a SpanElement object sets it to blue. The general rule is that the setting at the lowest level on the text flow tree takes precedence. So if the ligature level is set for a TextFlow instance and also set for a DivElement, the DivElement setting takes precedence.
Cascading styles refers to the process of adopting styles from a higher level in the text flow if a style value is undefined at a lower level. When a style is undefined on an element at the point it is about to be rendered, it either takes its default value or the value cascades or descends from the value on a parent element. For example, if the transparency (textAlpha
property) of the text is undefined on a SpanElement object, but is set on the TextFlow, the value of the TextFlow.textAlpha
property cascades to the SpanElement object and is applied to the text for that span. The result of the cascade, or the sum of the styles that is applied to the element, is stored in the element's computedFormat
property.
In the same way, you can apply user styles using the userStyles
property of the ContainerController and FlowElement classes. This property allows you to read or write a dictionary of user styles and apply its settings to a container or a text flow element. The user styles dictionary is an object that consists of stylename-value pairs. Styles specified by the userStyles
property take precedence over all others.
Most styles that are undefined inherit the value of their immediate parent during a cascade. A small number of styles, however, do not inherit their parent�s value and take on their default values instead.
Style properties that adopt their default values, if undefined, include:
backgroundAlpha
, backgroundColor
, columnCount
, columnGap
, columnWidth
, lineBreak
, paddingBottom
, paddingLeft
, paddingRight
, paddingTop
, verticalAlign
See also
Property | Defined By | ||
---|---|---|---|
alignmentBaseline : *
Specifies the baseline to which the dominant baseline aligns. | TextLayoutFormat | ||
alignmentBaselineProperty : Property [static] [read-only] | TextLayoutFormat | ||
backgroundAlpha : *
Alpha (transparency) value for the background (adopts default value if undefined during cascade). | TextLayoutFormat | ||
backgroundAlphaProperty : Property [static] [read-only] | TextLayoutFormat | ||
backgroundColor : *
Background color of the text (adopts default value if undefined during cascade). | TextLayoutFormat | ||
backgroundColorProperty : Property [static] [read-only] | TextLayoutFormat | ||
baselineShift : *
Amount to shift the baseline from the dominantBaseline value. | TextLayoutFormat | ||
baselineShiftProperty : Property [static] [read-only] | TextLayoutFormat | ||
blockProgression : *
Specifies a vertical or horizontal progression of line placement. | TextLayoutFormat | ||
blockProgressionProperty : Property [static] [read-only] | TextLayoutFormat | ||
borderBottomColor : *
Color of the bottom border (adopts default value if undefined during cascade). | TextLayoutFormat | ||
borderBottomColorProperty : Property [static] [read-only] | TextLayoutFormat | ||
borderBottomPriority : *
Specifies the priority when drawing cell boundaries. | TextLayoutFormat | ||
borderBottomPriorityProperty : Property [static] [read-only] | TextLayoutFormat | ||
borderBottomWidth : *
Bottom border width in pixels (adopts default value if undefined during cascade)
Legal values are numbers from 0 to 128 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
| TextLayoutFormat | ||
borderBottomWidthProperty : Property [static] [read-only] | TextLayoutFormat | ||
borderLeftColor : *
Color of the left border (adopts default value if undefined during cascade). | TextLayoutFormat | ||
borderLeftColorProperty : Property [static] [read-only] | TextLayoutFormat | ||
borderLeftPriority : *
Specifies the priority when drawing cell boundaries. | TextLayoutFormat | ||
borderLeftPriorityProperty : Property [static] [read-only] | TextLayoutFormat | ||
borderLeftWidth : *
Left border width in pixels (adopts default value if undefined during cascade)
Legal values are numbers from 0 to 128 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
| TextLayoutFormat | ||
borderLeftWidthProperty : Property [static] [read-only] | TextLayoutFormat | ||
borderRightColor : *
Color of the right border (adopts default value if undefined during cascade). | TextLayoutFormat | ||
borderRightColorProperty : Property [static] [read-only] | TextLayoutFormat | ||
borderRightPriority : *
Specifies the priority when drawing cell boundaries. | TextLayoutFormat | ||
borderRightPriorityProperty : Property [static] [read-only] | TextLayoutFormat | ||
borderRightWidth : *
Right border width in pixels (adopts default value if undefined during cascade)
Legal values are numbers from 0 to 128 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
| TextLayoutFormat | ||
borderRightWidthProperty : Property [static] [read-only] | TextLayoutFormat | ||
borderTopColor : *
Color of the top border (adopts default value if undefined during cascade). | TextLayoutFormat | ||
borderTopColorProperty : Property [static] [read-only] | TextLayoutFormat | ||
borderTopPriority : *
Specifies the priority when drawing cell boundaries. | TextLayoutFormat | ||
borderTopPriorityProperty : Property [static] [read-only] | TextLayoutFormat | ||
borderTopWidth : *
Top border width in pixels (adopts default value if undefined during cascade)
Legal values are numbers from 0 to 128 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
| TextLayoutFormat | ||
borderTopWidthProperty : Property [static] [read-only] | TextLayoutFormat | ||
breakOpportunity : *
Controls where lines are allowed to break when breaking wrapping text into multiple lines. | TextLayoutFormat | ||
breakOpportunityProperty : Property [static] [read-only] | TextLayoutFormat | ||
cellPadding : *
cellPadding specifies the amount of space between the border of the cell and its contents. | TextLayoutFormat | ||
cellPaddingProperty : Property [static] [read-only] | TextLayoutFormat | ||
cellSpacing : *
cellSpacing specifies how much space the user agent should leave between the left side of the table and the left-hand side of the leftmost column, the top of the table and the top side of the topmost row, and so on for the right and bottom of the table. | TextLayoutFormat | ||
cellSpacingProperty : Property [static] [read-only] | TextLayoutFormat | ||
cffHinting : *
The type of CFF hinting used for this text. | TextLayoutFormat | ||
cffHintingProperty : Property [static] [read-only] | TextLayoutFormat | ||
clearFloats : *
Controls how text wraps around a float. | TextLayoutFormat | ||
clearFloatsProperty : Property [static] [read-only] | TextLayoutFormat | ||
color : *
Color of the text. | TextLayoutFormat | ||
colorProperty : Property [static] [read-only] | TextLayoutFormat | ||
columnBreakAfter : *
Controls column after before the element. | TextLayoutFormat | ||
columnBreakAfterProperty : Property [static] [read-only] | TextLayoutFormat | ||
columnBreakBefore : *
Controls column break before the element. | TextLayoutFormat | ||
columnBreakBeforeProperty : Property [static] [read-only] | TextLayoutFormat | ||
columnCount : *
Number of text columns (adopts default value if undefined during cascade). | TextLayoutFormat | ||
columnCountProperty : Property [static] [read-only] | TextLayoutFormat | ||
columnGap : *
Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade). | TextLayoutFormat | ||
columnGapProperty : Property [static] [read-only] | TextLayoutFormat | ||
columnWidth : *
Column width in pixels (adopts default value if undefined during cascade). | TextLayoutFormat | ||
columnWidthProperty : Property [static] [read-only] | TextLayoutFormat | ||
containerBreakAfter : *
Controls container after before the element. | TextLayoutFormat | ||
containerBreakAfterProperty : Property [static] [read-only] | TextLayoutFormat | ||
containerBreakBefore : *
Controls container break before the element. | TextLayoutFormat | ||
containerBreakBeforeProperty : Property [static] [read-only] | TextLayoutFormat | ||
coreStyles : Object [read-only] Returns the coreStyles on this TextLayoutFormat. | TextLayoutFormat | ||
defaultFormat : ITextLayoutFormat [static] [read-only]
Returns a TextLayoutFormat object with default settings. | TextLayoutFormat | ||
digitCase : *
The type of digit case used for this text. | TextLayoutFormat | ||
digitCaseProperty : Property [static] [read-only] | TextLayoutFormat | ||
digitWidth : *
Type of digit width used for this text. | TextLayoutFormat | ||
digitWidthProperty : Property [static] [read-only] | TextLayoutFormat | ||
direction : *
Specifies the default bidirectional embedding level of the text in the text block. | TextLayoutFormat | ||
directionProperty : Property [static] [read-only] | TextLayoutFormat | ||
dominantBaseline : *
Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line. | TextLayoutFormat | ||
dominantBaselineProperty : Property [static] [read-only] | TextLayoutFormat | ||
firstBaselineOffset : *
Specifies the baseline position of the first line in the container. | TextLayoutFormat | ||
firstBaselineOffsetProperty : Property [static] [read-only] | TextLayoutFormat | ||
fontFamily : *
The name of the font to use, or a comma-separated list of font names. | TextLayoutFormat | ||
fontFamilyProperty : Property [static] [read-only] | TextLayoutFormat | ||
fontLookup : *
Font lookup to use. | TextLayoutFormat | ||
fontLookupProperty : Property [static] [read-only] | TextLayoutFormat | ||
fontSize : *
The size of the text in pixels. | TextLayoutFormat | ||
fontSizeProperty : Property [static] [read-only] | TextLayoutFormat | ||
fontStyle : *
Style of text. | TextLayoutFormat | ||
fontStyleProperty : Property [static] [read-only] | TextLayoutFormat | ||
fontWeight : *
Weight of text. | TextLayoutFormat | ||
fontWeightProperty : Property [static] [read-only] | TextLayoutFormat | ||
frame : *
frame specifies which sides of the frame surrounding a table will be visible. | TextLayoutFormat | ||
frameProperty : Property [static] [read-only] | TextLayoutFormat | ||
justificationRule : *
Rule used to justify text in a paragraph. | TextLayoutFormat | ||
justificationRuleProperty : Property [static] [read-only] | TextLayoutFormat | ||
justificationStyle : *
The style used for justification of the paragraph. | TextLayoutFormat | ||
justificationStyleProperty : Property [static] [read-only] | TextLayoutFormat | ||
kerning : *
Kerning adjusts the pixels between certain character pairs to improve readability. | TextLayoutFormat | ||
kerningProperty : Property [static] [read-only] | TextLayoutFormat | ||
leadingModel : *
Specifies the leading model, which is a combination of leading basis and leading direction. | TextLayoutFormat | ||
leadingModelProperty : Property [static] [read-only] | TextLayoutFormat | ||
ligatureLevel : *
Controls which of the ligatures that are defined in the font may be used in the text. | TextLayoutFormat | ||
ligatureLevelProperty : Property [static] [read-only] | TextLayoutFormat | ||
lineBreak : *
Controls word wrapping within the container (adopts default value if undefined during cascade). | TextLayoutFormat | ||
lineBreakProperty : Property [static] [read-only] | TextLayoutFormat | ||
lineHeight : *
Leading controls for the text. | TextLayoutFormat | ||
lineHeightProperty : Property [static] [read-only] | TextLayoutFormat | ||
lineThrough : *
If true, applies strikethrough, a line drawn through the middle of the text. | TextLayoutFormat | ||
lineThroughProperty : Property [static] [read-only] | TextLayoutFormat | ||
linkActiveFormat : *
Defines the formatting attributes used for links in normal state. | TextLayoutFormat | ||
linkActiveFormatProperty : Property [static] [read-only] | TextLayoutFormat | ||
linkHoverFormat : *
Defines the formatting attributes used for links in hover state, when the mouse is within the bounds (rolling over) a link. | TextLayoutFormat | ||
linkHoverFormatProperty : Property [static] [read-only] | TextLayoutFormat | ||
linkNormalFormat : *
Defines the formatting attributes used for links in normal state. | TextLayoutFormat | ||
linkNormalFormatProperty : Property [static] [read-only] | TextLayoutFormat | ||
listAutoPadding : *
This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto. | TextLayoutFormat | ||
listAutoPaddingProperty : Property [static] [read-only] | TextLayoutFormat | ||
listMarkerFormat : *
Defines the formatting attributes list markers. | TextLayoutFormat | ||
listMarkerFormatProperty : Property [static] [read-only] | TextLayoutFormat | ||
listStylePosition : *
Legal values are ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. | TextLayoutFormat | ||
listStylePositionProperty : Property [static] [read-only] | TextLayoutFormat | ||
listStyleType : *
Legal values are ListStyleType.UPPER_ALPHA, ListStyleType.LOWER_ALPHA, ListStyleType.UPPER_ROMAN, ListStyleType.LOWER_ROMAN, ListStyleType.NONE, ListStyleType.DISC, ListStyleType.CIRCLE, ListStyleType.SQUARE, ListStyleType.BOX, ListStyleType.CHECK, ListStyleType.DIAMOND, ListStyleType.HYPHEN, ListStyleType.ARABIC_INDIC, ListStyleType.BENGALI, ListStyleType.DECIMAL, ListStyleType.DECIMAL_LEADING_ZERO, ListStyleType.DEVANAGARI, ListStyleType.GUJARATI, ListStyleType.GURMUKHI, ListStyleType.KANNADA, ListStyleType.PERSIAN, ListStyleType.THAI, ListStyleType.URDU, ListStyleType.CJK_EARTHLY_BRANCH, ListStyleType.CJK_HEAVENLY_STEM, ListStyleType.HANGUL, ListStyleType.HANGUL_CONSTANT, ListStyleType.HIRAGANA, ListStyleType.HIRAGANA_IROHA, ListStyleType.KATAKANA, ListStyleType.KATAKANA_IROHA, ListStyleType.LOWER_ALPHA, ListStyleType.LOWER_GREEK, ListStyleType.LOWER_LATIN, ListStyleType.UPPER_ALPHA, ListStyleType.UPPER_GREEK, ListStyleType.UPPER_LATIN, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. | TextLayoutFormat | ||
listStyleTypeProperty : Property [static] [read-only] | TextLayoutFormat | ||
locale : *
The locale of the text. | TextLayoutFormat | ||
localeProperty : Property [static] [read-only] | TextLayoutFormat | ||
marginBottom : *
bottom margin in pixels (adopts default value if undefined during cascade). | TextLayoutFormat | ||
marginBottomProperty : Property [static] [read-only] | TextLayoutFormat | ||
marginLeft : *
left margin in pixels(adopts default value if undefined during cascade). | TextLayoutFormat | ||
marginLeftProperty : Property [static] [read-only] | TextLayoutFormat | ||
marginRight : *
right margin in pixels (adopts default value if undefined during cascade). | TextLayoutFormat | ||
marginRightProperty : Property [static] [read-only] | TextLayoutFormat | ||
marginTop : *
top margin in pixels (adopts default value if undefined during cascade). | TextLayoutFormat | ||
marginTopProperty : Property [static] [read-only] | TextLayoutFormat | ||
maxCellHeight : *
Maximum height of a table cell. | TextLayoutFormat | ||
maxCellHeightProperty : Property [static] [read-only] | TextLayoutFormat | ||
minCellHeight : *
Minimum height of a table cell. | TextLayoutFormat | ||
minCellHeightProperty : Property [static] [read-only] | TextLayoutFormat | ||
paddingBottom : *
Bottom inset in pixels. | TextLayoutFormat | ||
paddingBottomProperty : Property [static] [read-only] | TextLayoutFormat | ||
paddingLeft : *
Left inset in pixels. | TextLayoutFormat | ||
paddingLeftProperty : Property [static] [read-only] | TextLayoutFormat | ||
paddingRight : *
Right inset in pixels. | TextLayoutFormat | ||
paddingRightProperty : Property [static] [read-only] | TextLayoutFormat | ||
paddingTop : *
Top inset in pixels. | TextLayoutFormat | ||
paddingTopProperty : Property [static] [read-only] | TextLayoutFormat | ||
paragraphEndIndent : *
A Number that specifies, in pixels, the amount to indent the paragraph's end edge. | TextLayoutFormat | ||
paragraphEndIndentProperty : Property [static] [read-only] | TextLayoutFormat | ||
paragraphSpaceAfter : *
A Number that specifies the amount of space, in pixels, to leave after the paragraph. | TextLayoutFormat | ||
paragraphSpaceAfterProperty : Property [static] [read-only] | TextLayoutFormat | ||
paragraphSpaceBefore : *
A Number that specifies the amount of space, in pixels, to leave before the paragraph. | TextLayoutFormat | ||
paragraphSpaceBeforeProperty : Property [static] [read-only] | TextLayoutFormat | ||
paragraphStartIndent : *
A Number that specifies, in pixels, the amount to indent the paragraph's start edge. | TextLayoutFormat | ||
paragraphStartIndentProperty : Property [static] [read-only] | TextLayoutFormat | ||
renderingMode : *
The rendering mode used for this text. | TextLayoutFormat | ||
renderingModeProperty : Property [static] [read-only] | TextLayoutFormat | ||
rules : *
rules specifies which rules will appear between cells within a table. | TextLayoutFormat | ||
rulesProperty : Property [static] [read-only] | TextLayoutFormat | ||
styleName : *
Assigns an identifying class to the element, making it possible to set a style for the element by referencing the styleName. | TextLayoutFormat | ||
styleNameProperty : Property [static] [read-only] | TextLayoutFormat | ||
styles : Object [read-only] Returns the styles on this TextLayoutFormat. | TextLayoutFormat | ||
tableColumnWidth : *
Width of table column specifies a default width for each column spanned by the current COL element. | TextLayoutFormat | ||
tableColumnWidthProperty : Property [static] [read-only] | TextLayoutFormat | ||
tableWidth : *
Width of table element specifies the desired width of the entire table and is intended for visual user agents. | TextLayoutFormat | ||
tableWidthProperty : Property [static] [read-only] | TextLayoutFormat | ||
tabStops : *
Specifies the tab stops associated with the paragraph. | TextLayoutFormat | ||
tabStopsProperty : Property [static] [read-only] | TextLayoutFormat | ||
textAlign : *
Alignment of lines in the paragraph relative to the container. | TextLayoutFormat | ||
textAlignLast : *
Alignment of the last (or only) line in the paragraph relative to the container in justified text. | TextLayoutFormat | ||
textAlignLastProperty : Property [static] [read-only] | TextLayoutFormat | ||
textAlignProperty : Property [static] [read-only] | TextLayoutFormat | ||
textAlpha : *
Alpha (transparency) value for the text. | TextLayoutFormat | ||
textAlphaProperty : Property [static] [read-only] | TextLayoutFormat | ||
textDecoration : *
Decoration on text. | TextLayoutFormat | ||
textDecorationProperty : Property [static] [read-only] | TextLayoutFormat | ||
textIndent : *
A Number that specifies, in pixels, the amount to indent the first line of the paragraph. | TextLayoutFormat | ||
textIndentProperty : Property [static] [read-only] | TextLayoutFormat | ||
textJustify : *
Specifies options for justifying text. | TextLayoutFormat | ||
textJustifyProperty : Property [static] [read-only] | TextLayoutFormat | ||
textRotation : *
Determines the number of degrees to rotate this text. | TextLayoutFormat | ||
textRotationProperty : Property [static] [read-only] | TextLayoutFormat | ||
trackingLeft : *
Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character. | TextLayoutFormat | ||
trackingLeftProperty : Property [static] [read-only] | TextLayoutFormat | ||
trackingRight : *
Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character. | TextLayoutFormat | ||
trackingRightProperty : Property [static] [read-only] | TextLayoutFormat | ||
typographicCase : *
The type of typographic case used for this text. | TextLayoutFormat | ||
typographicCaseProperty : Property [static] [read-only] | TextLayoutFormat | ||
userStyles : Object [read-only] Returns the userStyles on this TextLayoutFormat. | TextLayoutFormat | ||
verticalAlign : *
Vertical alignment or justification (adopts default value if undefined during cascade). | TextLayoutFormat | ||
verticalAlignProperty : Property [static] [read-only] | TextLayoutFormat | ||
whiteSpaceCollapse : *
Collapses or preserves whitespace when importing text into a TextFlow. | TextLayoutFormat | ||
whiteSpaceCollapseProperty : Property [static] [read-only] | TextLayoutFormat | ||
wordSpacing : *
Specifies the optimum, minimum, and maximum spacing (as a multiplier of the width of a normal space) between words to use during justification. | TextLayoutFormat | ||
wordSpacingProperty : Property [static] [read-only] | TextLayoutFormat |
Method | Defined By | ||
---|---|---|---|
TextLayoutFormat(initialValues:ITextLayoutFormat = null)
Creates a new TextLayoutFormat object. | TextLayoutFormat | ||
apply(incoming:ITextLayoutFormat):void
Replaces property values in this TextLayoutFormat object with the values of properties that are set in
the incoming ITextLayoutFormat instance. | TextLayoutFormat | ||
concat(incoming:ITextLayoutFormat):void
Concatenates the values of properties in the incoming ITextLayoutFormat instance
with the values of this TextLayoutFormat object. | TextLayoutFormat | ||
concatInheritOnly(incoming:ITextLayoutFormat):void
Concatenates the values of properties in the incoming ITextLayoutFormat instance
with the values of this TextLayoutFormat object. | TextLayoutFormat | ||
copy(incoming:ITextLayoutFormat):void
Copies TextLayoutFormat settings from the values ITextLayoutFormat instance into this TextLayoutFormat object. | TextLayoutFormat | ||
createTextLayoutFormat(initialValues:Object):TextLayoutFormat [static]
Creates a new TextLayoutFormat object. | TextLayoutFormat | ||
getStyle(styleProp:String):* Returns the value of the style specified by the styleProp parameter, which specifies
the style name. | TextLayoutFormat | ||
[static]
Compares properties in ITextLayoutFormat instance p1 with properties in ITextLayoutFormat instance p2
and returns true if all properties match. | TextLayoutFormat | ||
removeClashing(incoming:ITextLayoutFormat):void
Sets properties in this TextLayoutFormat object to undefined if they do not match those in the
incoming ITextLayoutFormat instance. | TextLayoutFormat | ||
removeMatching(incoming:ITextLayoutFormat):void
Sets properties in this TextLayoutFormat object to undefined if they match those in the incoming
ITextLayoutFormat instance. | TextLayoutFormat | ||
setStyle(styleProp:String, newValue:*):void Sets the style specified by the styleProp parameter to the value specified by the
newValue parameter. | TextLayoutFormat |
alignmentBaseline | property |
alignmentBaseline:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the baseline to which the dominant baseline aligns. For example, if you set dominantBaseline
to ASCENT, setting alignmentBaseline
to DESCENT aligns the top of the text with the DESCENT baseline, or below the line. The largest element in the line generally determines the baselines.
Legal values are TextBaseline.ROMAN, TextBaseline.ASCENT, TextBaseline.DESCENT, TextBaseline.IDEOGRAPHIC_TOP, TextBaseline.IDEOGRAPHIC_CENTER, TextBaseline.IDEOGRAPHIC_BOTTOM, TextBaseline.USE_DOMINANT_BASELINE, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextBaseline.USE_DOMINANT_BASELINE.
public function get alignmentBaseline():*
public function set alignmentBaseline(value:any):void
RangeError — when set value is not within range for this property
|
See also
alignmentBaselineProperty | property |
alignmentBaselineProperty:Property
[read-only] public static function get alignmentBaselineProperty():Property
backgroundAlpha | property |
backgroundAlpha:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Alpha (transparency) value for the background (adopts default value if undefined during cascade). A value of 0 is fully transparent, and a value of 1 is fully opaque. Display objects with alpha set to 0 are active, even though they are invisible.
Legal values are numbers from 0 to 1 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 1.
public function get backgroundAlpha():*
public function set backgroundAlpha(value:any):void
RangeError — when set value is not within range for this property
|
backgroundAlphaProperty | property |
backgroundAlphaProperty:Property
[read-only] public static function get backgroundAlphaProperty():Property
backgroundColor | property |
backgroundColor:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Background color of the text (adopts default value if undefined during cascade). Can be either the constant value BackgroundColor.TRANSPARENT
, or a hexadecimal value that specifies the three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green.
Legal values as a string are BackgroundColor.TRANSPARENT, FormatValue.INHERIT and uints from 0x0 to 0xffffffff.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of BackgroundColor.TRANSPARENT.
public function get backgroundColor():*
public function set backgroundColor(value:any):void
RangeError — when set value is not within range for this property
|
See also
backgroundColorProperty | property |
backgroundColorProperty:Property
[read-only] public static function get backgroundColorProperty():Property
baselineShift | property |
baselineShift:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Amount to shift the baseline from the dominantBaseline
value. Units are in pixels, or a percentage of fontSize
(in which case, enter a string value, like 140%). Positive values shift the line up for horizontal text (right for vertical) and negative values shift it down for horizontal (left for vertical).
Legal values are BaselineShift.SUPERSCRIPT, BaselineShift.SUBSCRIPT, FormatValue.INHERIT.
Legal values as a number are from -1000 to 1000.
Legal values as a percent are numbers from -1000 to 1000.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.0.
public function get baselineShift():*
public function set baselineShift(value:any):void
RangeError — when set value is not within range for this property
|
See also
baselineShiftProperty | property |
baselineShiftProperty:Property
[read-only] public static function get baselineShiftProperty():Property
blockProgression | property |
blockProgression:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies a vertical or horizontal progression of line placement.
Lines are either placed top-to-bottom (BlockProgression.TB
, used for horizontal text) or right-to-left (BlockProgression.RL
, used for vertical text).
Legal values are BlockProgression.RL, BlockProgression.TB, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of BlockProgression.TB.
public function get blockProgression():*
public function set blockProgression(value:any):void
RangeError — when set value is not within range for this property
|
See also
blockProgressionProperty | property |
blockProgressionProperty:Property
[read-only] public static function get blockProgressionProperty():Property
borderBottomColor | property |
borderBottomColor:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Color of the bottom border (adopts default value if undefined during cascade). Can be either the constant value BorderColor.TRANSPARENT
, or a hexadecimal value that specifies the three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green.
Legal values as a string are BorderColor.TRANSPARENT, FormatValue.INHERIT and uints from 0x0 to 0xffffffff.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of BorderColor.TRANSPARENT.
public function get borderBottomColor():*
public function set borderBottomColor(value:any):void
RangeError — when set value is not within range for this property
|
See also
borderBottomColorProperty | property |
borderBottomColorProperty:Property
[read-only] public static function get borderBottomColorProperty():Property
borderBottomPriority | property |
borderBottomPriority:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the priority when drawing cell boundaries. When settings between two adjacent cells conflict, the border with the higher priority wins. If the priorities are equal, the latter of the two cells takes priority.
Legal values are any rational number. Conflicts are resolved with the properties of the higher number being drawn.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit, and default to 0.
public function get borderBottomPriority():*
public function set borderBottomPriority(value:any):void
RangeError — when set value is not within range for this property
|
borderBottomPriorityProperty | property |
borderBottomPriorityProperty:Property
[read-only] public static function get borderBottomPriorityProperty():Property
borderBottomWidth | property |
borderBottomWidth:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Bottom border width in pixels (adopts default value if undefined during cascade)
Legal values are numbers from 0 to 128 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
public function get borderBottomWidth():*
public function set borderBottomWidth(value:any):void
RangeError — when set value is not within range for this property
|
borderBottomWidthProperty | property |
borderBottomWidthProperty:Property
[read-only] public static function get borderBottomWidthProperty():Property
borderLeftColor | property |
borderLeftColor:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Color of the left border (adopts default value if undefined during cascade). Can be either the constant value BorderColor.TRANSPARENT
, or a hexadecimal value that specifies the three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green.
Legal values as a string are BorderColor.TRANSPARENT, FormatValue.INHERIT and uints from 0x0 to 0xffffffff.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of BorderColor.TRANSPARENT.
public function get borderLeftColor():*
public function set borderLeftColor(value:any):void
RangeError — when set value is not within range for this property
|
See also
borderLeftColorProperty | property |
borderLeftColorProperty:Property
[read-only] public static function get borderLeftColorProperty():Property
borderLeftPriority | property |
borderLeftPriority:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the priority when drawing cell boundaries. When settings between two adjacent cells conflict, the border with the higher priority wins. If the priorities are equal, the latter of the two cells takes priority.
Legal values are any rational number. Conflicts are resolved with the properties of the higher number being drawn.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit, and default to 0.
public function get borderLeftPriority():*
public function set borderLeftPriority(value:any):void
RangeError — when set value is not within range for this property
|
borderLeftPriorityProperty | property |
borderLeftPriorityProperty:Property
[read-only] public static function get borderLeftPriorityProperty():Property
borderLeftWidth | property |
borderLeftWidth:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Left border width in pixels (adopts default value if undefined during cascade)
Legal values are numbers from 0 to 128 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
public function get borderLeftWidth():*
public function set borderLeftWidth(value:any):void
RangeError — when set value is not within range for this property
|
borderLeftWidthProperty | property |
borderLeftWidthProperty:Property
[read-only] public static function get borderLeftWidthProperty():Property
borderRightColor | property |
borderRightColor:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Color of the right border (adopts default value if undefined during cascade). Can be either the constant value BorderColor.TRANSPARENT
, or a hexadecimal value that specifies the three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green.
Legal values as a string are BorderColor.TRANSPARENT, FormatValue.INHERIT and uints from 0x0 to 0xffffffff.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of BorderColor.TRANSPARENT.
public function get borderRightColor():*
public function set borderRightColor(value:any):void
RangeError — when set value is not within range for this property
|
See also
borderRightColorProperty | property |
borderRightColorProperty:Property
[read-only] public static function get borderRightColorProperty():Property
borderRightPriority | property |
borderRightPriority:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the priority when drawing cell boundaries. When settings between two adjacent cells conflict, the border with the higher priority wins. If the priorities are equal, the latter of the two cells takes priority.
Legal values are any rational number. Conflicts are resolved with the properties of the higher number being drawn.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit, and default to 0.
public function get borderRightPriority():*
public function set borderRightPriority(value:any):void
RangeError — when set value is not within range for this property
|
borderRightPriorityProperty | property |
borderRightPriorityProperty:Property
[read-only] public static function get borderRightPriorityProperty():Property
borderRightWidth | property |
borderRightWidth:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Right border width in pixels (adopts default value if undefined during cascade)
Legal values are numbers from 0 to 128 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
public function get borderRightWidth():*
public function set borderRightWidth(value:any):void
RangeError — when set value is not within range for this property
|
borderRightWidthProperty | property |
borderRightWidthProperty:Property
[read-only] public static function get borderRightWidthProperty():Property
borderTopColor | property |
borderTopColor:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Color of the top border (adopts default value if undefined during cascade). Can be either the constant value BorderColor.TRANSPARENT
, or a hexadecimal value that specifies the three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green.
Legal values as a string are BorderColor.TRANSPARENT, FormatValue.INHERIT and uints from 0x0 to 0xffffffff.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of BorderColor.TRANSPARENT.
public function get borderTopColor():*
public function set borderTopColor(value:any):void
RangeError — when set value is not within range for this property
|
See also
borderTopColorProperty | property |
borderTopColorProperty:Property
[read-only] public static function get borderTopColorProperty():Property
borderTopPriority | property |
borderTopPriority:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the priority when drawing cell boundaries. When settings between two adjacent cells conflict, the border with the higher priority wins. If the priorities are equal, the latter of the two cells takes priority.
Legal values are any rational number. Conflicts are resolved with the properties of the higher number being drawn.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit, and default to 0.
public function get borderTopPriority():*
public function set borderTopPriority(value:any):void
RangeError — when set value is not within range for this property
|
borderTopPriorityProperty | property |
borderTopPriorityProperty:Property
[read-only] public static function get borderTopPriorityProperty():Property
borderTopWidth | property |
borderTopWidth:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Top border width in pixels (adopts default value if undefined during cascade)
Legal values are numbers from 0 to 128 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
public function get borderTopWidth():*
public function set borderTopWidth(value:any):void
RangeError — when set value is not within range for this property
|
borderTopWidthProperty | property |
borderTopWidthProperty:Property
[read-only] public static function get borderTopWidthProperty():Property
breakOpportunity | property |
breakOpportunity:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Controls where lines are allowed to break when breaking wrapping text into multiple lines. Set to BreakOpportunity.AUTO
to break text normally. Set to BreakOpportunity.NONE
to not break the text unless the text would overrun the measure and there are no other places to break the line. Set to BreakOpportunity.ANY
to allow the line to break anywhere, rather than just between words. Set to BreakOpportunity.ALL
to have each typographic cluster put on a separate line (useful for text on a path).
Legal values are BreakOpportunity.ALL, BreakOpportunity.ANY, BreakOpportunity.AUTO, BreakOpportunity.NONE, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of BreakOpportunity.AUTO.
public function get breakOpportunity():*
public function set breakOpportunity(value:any):void
RangeError — when set value is not within range for this property
|
See also
breakOpportunityProperty | property |
breakOpportunityProperty:Property
[read-only] public static function get breakOpportunityProperty():Property
cellPadding | property |
cellPadding:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
cellPadding specifies the amount of space between the border of the cell and its contents. If the value of this attribute is a pixel length, all four margins should be this distance from the contents. If the value of the attribute is a percentage length, the top and bottom margins should be equally separated from the content based on a percentage of the available vertical space, and the left and right margins should be equally separated from the content based on a percentage of the available horizontal space.
Legal values as a number are from 0 to 1000.
Legal values as a percent are numbers from 0% to 100%.
Legal values include FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.
public function get cellPadding():*
public function set cellPadding(value:any):void
RangeError — when set value is not within range for this property
|
cellPaddingProperty | property |
cellPaddingProperty:Property
[read-only] public static function get cellPaddingProperty():Property
cellSpacing | property |
cellSpacing:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
cellSpacing specifies how much space the user agent should leave between the left side of the table and the left-hand side of the leftmost column, the top of the table and the top side of the topmost row, and so on for the right and bottom of the table. The attribute also specifies the amount of space to leave between cells.
Legal values are numbers from 0 to 1000 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
public function get cellSpacing():*
public function set cellSpacing(value:any):void
RangeError — when set value is not within range for this property
|
cellSpacingProperty | property |
cellSpacingProperty:Property
[read-only] public static function get cellSpacingProperty():Property
cffHinting | property |
cffHinting:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The type of CFF hinting used for this text. CFF hinting determines whether the Flash runtime forces strong horizontal stems to fit to a sub pixel grid or not. This property applies only if the renderingMode
property is set to RenderingMode.CFF
, and the font is embedded (fontLookup
property is set to FontLookup.EMBEDDED_CFF
). At small screen sizes, hinting produces a clear, legible text for human readers.
Legal values are CFFHinting.NONE, CFFHinting.HORIZONTAL_STEM, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of CFFHinting.HORIZONTAL_STEM.
public function get cffHinting():*
public function set cffHinting(value:any):void
RangeError — when set value is not within range for this property
|
See also
cffHintingProperty | property |
cffHintingProperty:Property
[read-only] public static function get cffHintingProperty():Property
clearFloats | property |
clearFloats:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Controls how text wraps around a float. A value of none allows the text to wrap most closely around a float. A value of left causes the text to skip over any portion of the container that has a left float, and a value of right causes the text to skip over any portion of the container that has a right float. A value of both causes the text to skip over any floats.
Legal values are ClearFloats.START, ClearFloats.END, ClearFloats.LEFT, ClearFloats.RIGHT, ClearFloats.BOTH, ClearFloats.NONE, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of ClearFloats.NONE.
public function get clearFloats():*
public function set clearFloats(value:any):void
RangeError — when set value is not within range for this property
|
See also
clearFloatsProperty | property |
clearFloatsProperty:Property
[read-only] public static function get clearFloatsProperty():Property
color | property |
color:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Color of the text. A hexadecimal number that specifies three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green. It can also be enum value {BLACK, GREEN, GRAY, BLUE, SILVER, LIME, OLIVE, WHITE, YELLOW, MAROON, NAVY, RED, PURPLE, TEAL, FUCHSIA, AQUA, MAGENTA, CYAN}
Legal values as a string are ColorName.BLACK, ColorName.GREEN, ColorName.GRAY, ColorName.BLUE, ColorName.SILVER, ColorName.LIME, ColorName.OLIVE, ColorName.WHITE, ColorName.YELLOW, ColorName.MAROON, ColorName.NAVY, ColorName.RED, ColorName.PURPLE, ColorName.TEAL, ColorName.FUCHSIA, ColorName.AQUA, ColorName.MAGENTA, ColorName.CYAN, FormatValue.INHERIT and uints from 0x0 to 0xffffffff.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.
public function get color():*
public function set color(value:any):void
RangeError — when set value is not within range for this property
|
See also
colorProperty | property |
colorProperty:Property
[read-only] public static function get colorProperty():Property
columnBreakAfter | property |
columnBreakAfter:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Controls column after before the element.
Legal values are BreakStyle.AUTO, BreakStyle.ALWAYS, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of BreakStyle.AUTO.
public function get columnBreakAfter():*
public function set columnBreakAfter(value:any):void
RangeError — when set value is not within range for this property
|
See also
columnBreakAfterProperty | property |
columnBreakAfterProperty:Property
[read-only] public static function get columnBreakAfterProperty():Property
columnBreakBefore | property |
columnBreakBefore:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Controls column break before the element.
Legal values are BreakStyle.AUTO, BreakStyle.ALWAYS, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of BreakStyle.AUTO.
public function get columnBreakBefore():*
public function set columnBreakBefore(value:any):void
RangeError — when set value is not within range for this property
|
See also
columnBreakBeforeProperty | property |
columnBreakBeforeProperty:Property
[read-only] public static function get columnBreakBeforeProperty():Property
columnCount | property |
columnCount:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Number of text columns (adopts default value if undefined during cascade).
The column number overrides the other column settings. Value is an integer, or FormatValue.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 FormatValue.AUTO, FormatValue.INHERIT and from ints from 1 to 50.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of FormatValue.AUTO.
public function get columnCount():*
public function set columnCount(value:any):void
RangeError — when set value is not within range for this property
|
See also
columnCountProperty | property |
columnCountProperty:Property
[read-only] public static function get columnCountProperty():Property
columnGap | property |
columnGap:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade). Value is a Number
Legal values are numbers from 0 to 1000 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 20.
public function get columnGap():*
public function set columnGap(value:any):void
RangeError — when set value is not within range for this property
|
columnGapProperty | property |
columnGapProperty:Property
[read-only] public static function get columnGapProperty():Property
columnWidth | property |
columnWidth:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Column width in pixels (adopts default value if undefined during cascade).
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 container width and columnGap
settings. Any remainder space is left after the last column. Value is a Number.
Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from 0 to 8000.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of FormatValue.AUTO.
public function get columnWidth():*
public function set columnWidth(value:any):void
RangeError — when set value is not within range for this property
|
See also
columnWidthProperty | property |
columnWidthProperty:Property
[read-only] public static function get columnWidthProperty():Property
containerBreakAfter | property |
containerBreakAfter:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Controls container after before the element.
Legal values are BreakStyle.AUTO, BreakStyle.ALWAYS, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of BreakStyle.AUTO.
public function get containerBreakAfter():*
public function set containerBreakAfter(value:any):void
RangeError — when set value is not within range for this property
|
See also
containerBreakAfterProperty | property |
containerBreakAfterProperty:Property
[read-only] public static function get containerBreakAfterProperty():Property
containerBreakBefore | property |
containerBreakBefore:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Controls container break before the element.
Legal values are BreakStyle.AUTO, BreakStyle.ALWAYS, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of BreakStyle.AUTO.
public function get containerBreakBefore():*
public function set containerBreakBefore(value:any):void
RangeError — when set value is not within range for this property
|
See also
containerBreakBeforeProperty | property |
containerBreakBeforeProperty:Property
[read-only] public static function get containerBreakBeforeProperty():Property
coreStyles | property |
coreStyles:Object
[read-only] Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Returns the coreStyles
on this TextLayoutFormat.
The coreStyles object includes the formats that are defined by TextLayoutFormat and are in TextLayoutFormat.description. The
returned coreStyles
object consists of an array of stylename-value pairs.
public function get coreStyles():Object
See also
defaultFormat | property |
defaultFormat:ITextLayoutFormat
[read-only] Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Returns a TextLayoutFormat object with default settings. This function always returns the same object.
public static function get defaultFormat():ITextLayoutFormat
digitCase | property |
digitCase:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The type of digit case used for this text. Setting the value to DigitCase.OLD_STYLE
approximates lowercase letterforms with varying ascenders and descenders. The figures are proportionally spaced. This style is only available in selected typefaces, most commonly in a supplemental or expert font. The DigitCase.LINING
setting has all-cap height and is typically monospaced to line up in charts.
Legal values are DigitCase.DEFAULT, DigitCase.LINING, DigitCase.OLD_STYLE, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DigitCase.DEFAULT.
public function get digitCase():*
public function set digitCase(value:any):void
RangeError — when set value is not within range for this property
|
See also
digitCaseProperty | property |
digitCaseProperty:Property
[read-only] public static function get digitCaseProperty():Property
digitWidth | property |
digitWidth:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Type of digit width used for this text. This can be DigitWidth.PROPORTIONAL
, which looks best for individual numbers, or DigitWidth.TABULAR
, which works best for numbers in tables, charts, and vertical rows.
Legal values are DigitWidth.DEFAULT, DigitWidth.PROPORTIONAL, DigitWidth.TABULAR, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DigitWidth.DEFAULT.
public function get digitWidth():*
public function set digitWidth(value:any):void
RangeError — when set value is not within range for this property
|
See also
digitWidthProperty | property |
digitWidthProperty:Property
[read-only] public static function get digitWidthProperty():Property
direction | property |
direction:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the default bidirectional embedding level of the text in the text block. Left-to-right reading order, as in Latin-style scripts, or right-to-left reading order, as in Arabic or Hebrew. This property also affects column direction when it is applied at the container level. Columns can be either left-to-right or right-to-left, just like text. Below are some examples:
Legal values are Direction.LTR, Direction.RTL, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of Direction.LTR.
public function get direction():*
public function set direction(value:any):void
RangeError — when set value is not within range for this property
|
See also
directionProperty | property |
directionProperty:Property
[read-only] public static function get directionProperty():Property
dominantBaseline | property |
dominantBaseline:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies which element baseline snaps to the alignmentBaseline
to determine the vertical position of the element on the line. A value of TextBaseline.AUTO
selects the dominant baseline based on the locale
property of the parent paragraph. For Japanese and Chinese, the selected baseline value is TextBaseline.IDEOGRAPHIC_CENTER
; for all others it is TextBaseline.ROMAN
. These baseline choices are determined by the choice of font and the font size.
Legal values are FormatValue.AUTO, TextBaseline.ROMAN, TextBaseline.ASCENT, TextBaseline.DESCENT, TextBaseline.IDEOGRAPHIC_TOP, TextBaseline.IDEOGRAPHIC_CENTER, TextBaseline.IDEOGRAPHIC_BOTTOM, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FormatValue.AUTO.
public function get dominantBaseline():*
public function set dominantBaseline(value:any):void
RangeError — when set value is not within range for this property
|
See also
dominantBaselineProperty | property |
dominantBaselineProperty:Property
[read-only] public static function get dominantBaselineProperty():Property
firstBaselineOffset | property |
firstBaselineOffset:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the baseline position of the first line in the container. Which baseline this property refers to depends on the container-level locale. For Japanese and Chinese, it is TextBaseline.IDEOGRAPHIC_BOTTOM
; for all others it is TextBaseline.ROMAN
.
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 BaselineOffset.ASCENT
, meaning equal to the ascent of the line, BaselineOffset.LINE_HEIGHT
, meaning equal to the height of that first line, or any fixed-value number to specify an absolute distance. BaselineOffset.AUTO
aligns the ascent of the line with the container top inset.
Legal values as a string are BaselineOffset.AUTO, BaselineOffset.ASCENT, BaselineOffset.LINE_HEIGHT, FormatValue.INHERIT and numbers from 0 to 1000.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of BaselineOffset.AUTO.
public function get firstBaselineOffset():*
public function set firstBaselineOffset(value:any):void
RangeError — when set value is not within range for this property
|
See also
firstBaselineOffsetProperty | property |
firstBaselineOffsetProperty:Property
[read-only] public static function get firstBaselineOffsetProperty():Property
fontFamily | property |
fontFamily:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The name of the font to use, or a comma-separated list of font names. The Flash runtime renders the element with the first available font in the list. For example Arial, Helvetica, _sans causes the player to search for Arial, then Helvetica if Arial is not found, then _sans if neither is found.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of Arial.
public function get fontFamily():*
public function set fontFamily(value:any):void
RangeError — when set value is not within range for this property
|
fontFamilyProperty | property |
fontFamilyProperty:Property
[read-only] public static function get fontFamilyProperty():Property
fontLookup | property |
fontLookup:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Font lookup to use. Specifying FontLookup.DEVICE
uses the fonts installed on the system that is running the SWF file. Device fonts result in a smaller movie size, but text is not always rendered the same across different systems and platforms. Specifying FontLookup.EMBEDDED_CFF
uses font outlines embedded in the published SWF file. Embedded fonts increase the size of the SWF file (sometimes dramatically), but text is consistently displayed in the chosen font.
Legal values are FontLookup.DEVICE, FontLookup.EMBEDDED_CFF, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FontLookup.DEVICE.
public function get fontLookup():*
public function set fontLookup(value:any):void
RangeError — when set value is not within range for this property
|
See also
fontLookupProperty | property |
fontLookupProperty:Property
[read-only] public static function get fontLookupProperty():Property
fontSize | property |
fontSize:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The size of the text in pixels.
Legal values are numbers from 1 to 720 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 12.
public function get fontSize():*
public function set fontSize(value:any):void
RangeError — when set value is not within range for this property
|
fontSizeProperty | property |
fontSizeProperty:Property
[read-only] public static function get fontSizeProperty():Property
fontStyle | property |
fontStyle:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Style of text. May be FontPosture.NORMAL
, for use in plain text, or FontPosture.ITALIC
for italic. This property applies only to device fonts (fontLookup
property is set to flash.text.engine.FontLookup.DEVICE).
Legal values are FontPosture.NORMAL, FontPosture.ITALIC, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FontPosture.NORMAL.
public function get fontStyle():*
public function set fontStyle(value:any):void
RangeError — when set value is not within range for this property
|
See also
fontStyleProperty | property |
fontStyleProperty:Property
[read-only] public static function get fontStyleProperty():Property
fontWeight | property |
fontWeight:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Weight of text. May be FontWeight.NORMAL
for use in plain text, or FontWeight.BOLD
. Applies only to device fonts (fontLookup
property is set to flash.text.engine.FontLookup.DEVICE).
Legal values are FontWeight.NORMAL, FontWeight.BOLD, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FontWeight.NORMAL.
public function get fontWeight():*
public function set fontWeight(value:any):void
RangeError — when set value is not within range for this property
|
See also
fontWeightProperty | property |
fontWeightProperty:Property
[read-only] public static function get fontWeightProperty():Property
frame | property |
frame:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
frame specifies which sides of the frame surrounding a table will be visible. Possible values:
Legal values are TableFrame.VOID, TableFrame.ABOVE, TableFrame.BELOW, TableFrame.HSIDES, TableFrame.VSIDES, TableFrame.LHS, TableFrame.RHS, TableFrame.BOX, TableFrame.BORDER, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of TableFrame.VOID.
public function get frame():*
public function set frame(value:any):void
RangeError — when set value is not within range for this property
|
See also
frameProperty | property |
frameProperty:Property
[read-only] public static function get frameProperty():Property
justificationRule | property |
justificationRule:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Rule used to justify text in a paragraph.
Default value is FormatValue.AUTO
, which justifies text based on the paragraph's locale
property. For all languages except Japanese and Chinese, FormatValue.AUTO
becomes JustificationRule.SPACE
, which adds extra space to the space characters. For Japanese and Chinese, FormatValue.AUTO
becomes JustficationRule.EAST_ASIAN
. In part, justification changes the spacing of punctuation. In Roman text the comma and Japanese periods take a full character's width but in East Asian text only half of a character's width. Also, in the East Asian text the spacing between sequential punctuation marks becomes tighter, obeying traditional East Asian typographic conventions. Note, too, in the example below the leading that is applied to the second line of the paragraphs. In the East Asian version, the last two lines push left. In the Roman version, the second and following lines push left.
Legal values are JustificationRule.EAST_ASIAN, JustificationRule.SPACE, FormatValue.AUTO, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FormatValue.AUTO.
public function get justificationRule():*
public function set justificationRule(value:any):void
RangeError — when set value is not within range for this property
|
See also
justificationRuleProperty | property |
justificationRuleProperty:Property
[read-only] public static function get justificationRuleProperty():Property
justificationStyle | property |
justificationStyle:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The style used for justification of the paragraph. Used only in conjunction with a justificationRule
setting of JustificationRule.EAST_ASIAN
.
Default value of FormatValue.AUTO
is resolved to JustificationStyle.PUSH_IN_KINSOKU
for all locales. The constants defined by the JustificationStyle class specify options for handling kinsoku characters, which are Japanese characters that cannot appear at either the beginning or end of a line. If you want looser text, specify JustificationStyle.PUSH-OUT-ONLY
. If you want behavior that is like what you get with the justificationRule
of JustificationRule.SPACE
, use JustificationStyle.PRIORITIZE-LEAST-ADJUSTMENT
.
Legal values are JustificationStyle.PRIORITIZE_LEAST_ADJUSTMENT, JustificationStyle.PUSH_IN_KINSOKU, JustificationStyle.PUSH_OUT_ONLY, FormatValue.AUTO, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FormatValue.AUTO.
public function get justificationStyle():*
public function set justificationStyle(value:any):void
RangeError — when set value is not within range for this property
|
See also
justificationStyleProperty | property |
justificationStyleProperty:Property
[read-only] public static function get justificationStyleProperty():Property
kerning | property |
kerning:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Kerning adjusts the pixels between certain character pairs to improve readability. Kerning is supported for all fonts with kerning tables.
Legal values are Kerning.ON, Kerning.OFF, Kerning.AUTO, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of Kerning.AUTO.
public function get kerning():*
public function set kerning(value:any):void
RangeError — when set value is not within range for this property
|
See also
kerningProperty | property |
kerningProperty:Property
[read-only] public static function get kerningProperty():Property
leadingModel | property |
leadingModel:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the leading model, which is a combination of leading basis and leading direction.
Leading basis is the baseline to which the lineHeight
property refers. Leading direction determines whether the lineHeight
property refers to the distance of a line's baseline from that of the line before it or the line after it. The default value of FormatValue.AUTO
is resolved based on the paragraph's locale
property. For Japanese and Chinese, it is LeadingModel.IDEOGRAPHIC_TOP_DOWN
and for all others it is LeadingModel.ROMAN_UP
.
Leading Basis:
Leading Direction:
Legal values are LeadingModel.ROMAN_UP, LeadingModel.IDEOGRAPHIC_TOP_UP, LeadingModel.IDEOGRAPHIC_CENTER_UP, LeadingModel.IDEOGRAPHIC_TOP_DOWN, LeadingModel.IDEOGRAPHIC_CENTER_DOWN, LeadingModel.APPROXIMATE_TEXT_FIELD, LeadingModel.ASCENT_DESCENT_UP, LeadingModel.BOX, LeadingModel.AUTO, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of LeadingModel.AUTO.
public function get leadingModel():*
public function set leadingModel(value:any):void
RangeError — when set value is not within range for this property
|
See also
leadingModelProperty | property |
leadingModelProperty:Property
[read-only] public static function get leadingModelProperty():Property
ligatureLevel | property |
ligatureLevel:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Controls which of the ligatures that are defined in the font may be used in the text. The ligatures that appear for each of these settings is dependent on the font. A ligature occurs where two or more letter-forms are joined as a single glyph. Ligatures usually replace consecutive characters sharing common components, such as the letter pairs 'fi', 'fl', or 'ae'. They are used with both Latin and Non-Latin character sets. The ligatures enabled by the values of the LigatureLevel class - MINIMUM
, COMMON
, UNCOMMON
, and EXOTIC
- are additive. Each value enables a new set of ligatures, but also includes those of the previous types.
Note: When working with Arabic or Syriac fonts, ligatureLevel
must be set to MINIMUM or above.
Legal values are LigatureLevel.MINIMUM, LigatureLevel.COMMON, LigatureLevel.UNCOMMON, LigatureLevel.EXOTIC, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of LigatureLevel.COMMON.
public function get ligatureLevel():*
public function set ligatureLevel(value:any):void
RangeError — when set value is not within range for this property
|
See also
ligatureLevelProperty | property |
ligatureLevelProperty:Property
[read-only] public static function get ligatureLevelProperty():Property
lineBreak | property |
lineBreak:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Controls word wrapping within the container (adopts default value if undefined during cascade).
Text in the container may be set to fit the width of the container (LineBreak.TO_FIT
), or can be set to break only at explicit return or line feed characters (LineBreak.EXPLICIT
).
Legal values are LineBreak.EXPLICIT, LineBreak.TO_FIT, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of LineBreak.TO_FIT.
public function get lineBreak():*
public function set lineBreak(value:any):void
RangeError — when set value is not within range for this property
|
See also
lineBreakProperty | property |
lineBreakProperty:Property
[read-only] public static function get lineBreakProperty():Property
lineHeight | property |
lineHeight:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Leading controls for the text. The distance from the baseline of the previous or the next line (based on LeadingModel
) to the baseline of the current line is equal to the maximum amount of the leading applied to any character in the line. This is either a number or a percent. If specifying a percent, enter a string value, like 140%.
Legal values as a number are from -720 to 720.
Legal values as a percent are numbers from -1000% to 1000%.
Legal values include FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 120%.
public function get lineHeight():*
public function set lineHeight(value:any):void
RangeError — when set value is not within range for this property
|
lineHeightProperty | property |
lineHeightProperty:Property
[read-only] public static function get lineHeightProperty():Property
lineThrough | property |
lineThrough:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
If true
, applies strikethrough, a line drawn through the middle of the text.
Legal values are true, false and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of false.
public function get lineThrough():*
public function set lineThrough(value:any):void
RangeError — when set value is not within range for this property
|
lineThroughProperty | property |
lineThroughProperty:Property
[read-only] public static function get lineThroughProperty():Property
linkActiveFormat | property |
linkActiveFormat:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Defines the formatting attributes used for links in normal state. This value will cascade down the hierarchy and apply to any links that are descendants.
Accepts inherit
, an ITextLayoutFormat
or converts an array of objects with key and value as members to a TextLayoutFormat.
Legal values include FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of null.
public function get linkActiveFormat():*
public function set linkActiveFormat(value:any):void
RangeError — when set value is not within range for this property
|
linkActiveFormatProperty | property |
linkActiveFormatProperty:Property
[read-only] public static function get linkActiveFormatProperty():Property
linkHoverFormat | property |
linkHoverFormat:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Defines the formatting attributes used for links in hover state, when the mouse is within the bounds (rolling over) a link. This value will cascade down the hierarchy and apply to any links that are descendants.
Accepts inherit
, an ITextLayoutFormat
or converts an array of objects with key and value as members to a TextLayoutFormat.
Legal values include FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of null.
public function get linkHoverFormat():*
public function set linkHoverFormat(value:any):void
RangeError — when set value is not within range for this property
|
linkHoverFormatProperty | property |
linkHoverFormatProperty:Property
[read-only] public static function get linkHoverFormatProperty():Property
linkNormalFormat | property |
linkNormalFormat:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Defines the formatting attributes used for links in normal state. This value will cascade down the hierarchy and apply to any links that are descendants.
Accepts inherit
, an ITextLayoutFormat
or converts an array of objects with key and value as members to a TextLayoutFormat.
Legal values include FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of null.
public function get linkNormalFormat():*
public function set linkNormalFormat(value:any):void
RangeError — when set value is not within range for this property
|
linkNormalFormatProperty | property |
linkNormalFormatProperty:Property
[read-only] public static function get linkNormalFormatProperty():Property
listAutoPadding | property |
listAutoPadding:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto
.
Legal values are numbers from -1000 to 1000 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 40.
public function get listAutoPadding():*
public function set listAutoPadding(value:any):void
RangeError — when set value is not within range for this property
|
listAutoPaddingProperty | property |
listAutoPaddingProperty:Property
[read-only] public static function get listAutoPaddingProperty():Property
listMarkerFormat | property |
listMarkerFormat:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Defines the formatting attributes list markers. This value will cascade down the hierarchy and apply to any links that are descendants.
Accepts inherit
, an IListMarkerFormat
or converts an array of objects with key and value as members to a ListMarkerFormat.
Legal values include FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of null.
public function get listMarkerFormat():*
public function set listMarkerFormat(value:any):void
RangeError — when set value is not within range for this property
|
listMarkerFormatProperty | property |
listMarkerFormatProperty:Property
[read-only] public static function get listMarkerFormatProperty():Property
listStylePosition | property |
listStylePosition:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Legal values are ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of ListStylePosition.OUTSIDE.
public function get listStylePosition():*
public function set listStylePosition(value:any):void
RangeError — when set value is not within range for this property
|
See also
listStylePositionProperty | property |
listStylePositionProperty:Property
[read-only] public static function get listStylePositionProperty():Property
listStyleType | property |
listStyleType:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Legal values are ListStyleType.UPPER_ALPHA, ListStyleType.LOWER_ALPHA, ListStyleType.UPPER_ROMAN, ListStyleType.LOWER_ROMAN, ListStyleType.NONE, ListStyleType.DISC, ListStyleType.CIRCLE, ListStyleType.SQUARE, ListStyleType.BOX, ListStyleType.CHECK, ListStyleType.DIAMOND, ListStyleType.HYPHEN, ListStyleType.ARABIC_INDIC, ListStyleType.BENGALI, ListStyleType.DECIMAL, ListStyleType.DECIMAL_LEADING_ZERO, ListStyleType.DEVANAGARI, ListStyleType.GUJARATI, ListStyleType.GURMUKHI, ListStyleType.KANNADA, ListStyleType.PERSIAN, ListStyleType.THAI, ListStyleType.URDU, ListStyleType.CJK_EARTHLY_BRANCH, ListStyleType.CJK_HEAVENLY_STEM, ListStyleType.HANGUL, ListStyleType.HANGUL_CONSTANT, ListStyleType.HIRAGANA, ListStyleType.HIRAGANA_IROHA, ListStyleType.KATAKANA, ListStyleType.KATAKANA_IROHA, ListStyleType.LOWER_ALPHA, ListStyleType.LOWER_GREEK, ListStyleType.LOWER_LATIN, ListStyleType.UPPER_ALPHA, ListStyleType.UPPER_GREEK, ListStyleType.UPPER_LATIN, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of ListStyleType.DISC.
public function get listStyleType():*
public function set listStyleType(value:any):void
RangeError — when set value is not within range for this property
|
See also
listStyleTypeProperty | property |
listStyleTypeProperty:Property
[read-only] public static function get listStyleTypeProperty():Property
locale | property |
locale:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The locale of the text. Controls case transformations and shaping. Standard locale identifiers as described in Unicode Technical Standard #35 are used. For example en, en_US and en-US are all English, ja is Japanese.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of en.
public function get locale():*
public function set locale(value:any):void
RangeError — when set value is not within range for this property
|
localeProperty | property |
localeProperty:Property
[read-only] public static function get localeProperty():Property
marginBottom | property |
marginBottom:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
bottom margin in pixels (adopts default value if undefined during cascade).
Legal values are numbers from -8000 to 8000 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
public function get marginBottom():*
public function set marginBottom(value:any):void
RangeError — when set value is not within range for this property
|
marginBottomProperty | property |
marginBottomProperty:Property
[read-only] public static function get marginBottomProperty():Property
marginLeft | property |
marginLeft:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
left margin in pixels(adopts default value if undefined during cascade).
Legal values are numbers from -8000 to 8000 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
public function get marginLeft():*
public function set marginLeft(value:any):void
RangeError — when set value is not within range for this property
|
marginLeftProperty | property |
marginLeftProperty:Property
[read-only] public static function get marginLeftProperty():Property
marginRight | property |
marginRight:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
right margin in pixels (adopts default value if undefined during cascade).
Legal values are numbers from -8000 to 8000 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
public function get marginRight():*
public function set marginRight(value:any):void
RangeError — when set value is not within range for this property
|
marginRightProperty | property |
marginRightProperty:Property
[read-only] public static function get marginRightProperty():Property
marginTop | property |
marginTop:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
top margin in pixels (adopts default value if undefined during cascade).
Legal values are numbers from -8000 to 8000 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
public function get marginTop():*
public function set marginTop(value:any):void
RangeError — when set value is not within range for this property
|
marginTopProperty | property |
marginTopProperty:Property
[read-only] public static function get marginTopProperty():Property
maxCellHeight | property |
maxCellHeight:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Maximum height of a table cell. If there is no maximum, the cell will grow in height to fit the content. Minimum and maximum of the same values will give the cell a fixed height.
Legal values as a number are from 2 to 10000.
Legal values include FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 2.
public function get maxCellHeight():*
public function set maxCellHeight(value:any):void
RangeError — when set value is not within range for this property
|
maxCellHeightProperty | property |
maxCellHeightProperty:Property
[read-only] public static function get maxCellHeightProperty():Property
minCellHeight | property |
minCellHeight:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Minimum height of a table cell. If there is no maximum, the cell will grow in height to fit the content. Minimum and maximum of the same values will give the cell a fixed height.
Legal values as a number are from 2 to 10000.
Legal values include FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 2.
public function get minCellHeight():*
public function set minCellHeight(value:any):void
RangeError — when set value is not within range for this property
|
minCellHeightProperty | property |
minCellHeightProperty:Property
[read-only] public static function get minCellHeightProperty():Property
paddingBottom | property |
paddingBottom:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Bottom inset in pixels. Default of auto is zero except in lists which get a start side padding of 45. (adopts default value if undefined during cascade). Space between the bottom edge of the container and the text. Value is a Number or auto.
With horizontal text, in scrollable containers with multiple columns, the first and following columns will show the padding as blank space at the bottom of the container, but for the last column, if the text doesn't all fit, you may have to scroll in order to see the padding.
Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from -8000 to 8000.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of FormatValue.AUTO.
public function get paddingBottom():*
public function set paddingBottom(value:any):void
RangeError — when set value is not within range for this property
|
See also
paddingBottomProperty | property |
paddingBottomProperty:Property
[read-only] public static function get paddingBottomProperty():Property
paddingLeft | property |
paddingLeft:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Left inset in pixels. Default of auto is zero except in lists which get a start side padding of 45. (adopts default value if undefined during cascade). Space between the left edge of the container and the text. Value is a Number or auto.
With vertical text, in scrollable containers with multiple columns, the first and following columns will show the padding as blank space at the end of the container, but for the last column, if the text doesn't all fit, you may have to scroll in order to see the padding.
Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from -8000 to 8000.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of FormatValue.AUTO.
public function get paddingLeft():*
public function set paddingLeft(value:any):void
RangeError — when set value is not within range for this property
|
See also
paddingLeftProperty | property |
paddingLeftProperty:Property
[read-only] public static function get paddingLeftProperty():Property
paddingRight | property |
paddingRight:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Right inset in pixels. Default of auto is zero except in lists which get a start side padding of 45. (adopts default value if undefined during cascade). Space between the right edge of the container and the text. Value is a Number or auto.
Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from -8000 to 8000.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of FormatValue.AUTO.
public function get paddingRight():*
public function set paddingRight(value:any):void
RangeError — when set value is not within range for this property
|
See also
paddingRightProperty | property |
paddingRightProperty:Property
[read-only] public static function get paddingRightProperty():Property
paddingTop | property |
paddingTop:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Top inset in pixels. Default of auto is zero except in lists which get a start side padding of 45. (adopts default value if undefined during cascade). Space between the top edge of the container and the text. Value is a Number or auto.
Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from -8000 to 8000.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of FormatValue.AUTO.
public function get paddingTop():*
public function set paddingTop(value:any):void
RangeError — when set value is not within range for this property
|
See also
paddingTopProperty | property |
paddingTopProperty:Property
[read-only] public static function get paddingTopProperty():Property
paragraphEndIndent | property |
paragraphEndIndent:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
A Number that specifies, in pixels, the amount to indent the paragraph's end edge. Refers to the right edge in left-to-right text and the left edge in right-to-left text.
Legal values are numbers from 0 to 8000 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.
public function get paragraphEndIndent():*
public function set paragraphEndIndent(value:any):void
RangeError — when set value is not within range for this property
|
paragraphEndIndentProperty | property |
paragraphEndIndentProperty:Property
[read-only] public static function get paragraphEndIndentProperty():Property
paragraphSpaceAfter | property |
paragraphSpaceAfter:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
A Number that specifies the amount of space, in pixels, to leave after the paragraph.
Collapses in tandem with paragraphSpaceBefore
.
Legal values are numbers from 0 to 8000 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.
public function get paragraphSpaceAfter():*
public function set paragraphSpaceAfter(value:any):void
RangeError — when set value is not within range for this property
|
paragraphSpaceAfterProperty | property |
paragraphSpaceAfterProperty:Property
[read-only] public static function get paragraphSpaceAfterProperty():Property
paragraphSpaceBefore | property |
paragraphSpaceBefore:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
A Number that specifies the amount of space, in pixels, to leave before the paragraph.
Collapses in tandem with paragraphSpaceAfter
.
Legal values are numbers from 0 to 8000 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.
public function get paragraphSpaceBefore():*
public function set paragraphSpaceBefore(value:any):void
RangeError — when set value is not within range for this property
|
paragraphSpaceBeforeProperty | property |
paragraphSpaceBeforeProperty:Property
[read-only] public static function get paragraphSpaceBeforeProperty():Property
paragraphStartIndent | property |
paragraphStartIndent:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
A Number that specifies, in pixels, the amount to indent the paragraph's start edge. Refers to the left edge in left-to-right text and the right edge in right-to-left text.
Legal values are numbers from 0 to 8000 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.
public function get paragraphStartIndent():*
public function set paragraphStartIndent(value:any):void
RangeError — when set value is not within range for this property
|
paragraphStartIndentProperty | property |
paragraphStartIndentProperty:Property
[read-only] public static function get paragraphStartIndentProperty():Property
renderingMode | property |
renderingMode:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The rendering mode used for this text. Applies only to embedded fonts (fontLookup
property is set to FontLookup.EMBEDDED_CFF
).
Legal values are RenderingMode.NORMAL, RenderingMode.CFF, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of RenderingMode.CFF.
public function get renderingMode():*
public function set renderingMode(value:any):void
RangeError — when set value is not within range for this property
|
See also
renderingModeProperty | property |
renderingModeProperty:Property
[read-only] public static function get renderingModeProperty():Property
rules | property |
rules:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
rules specifies which rules will appear between cells within a table. The rendering of rules is user agent dependent. Possible values:
Legal values are TableRules.NONE, TableRules.GROUPS, TableRules.ROWS, TableRules.COLS, TableRules.ALL, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of TableRules.NONE.
public function get rules():*
public function set rules(value:any):void
RangeError — when set value is not within range for this property
|
See also
rulesProperty | property |
rulesProperty:Property
[read-only] public static function get rulesProperty():Property
styleName | property |
styleName:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Assigns an identifying class to the element, making it possible to set a style for the element by referencing the styleName
.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of null.
public function get styleName():*
public function set styleName(value:any):void
RangeError — when set value is not within range for this property
|
styleNameProperty | property |
styleNameProperty:Property
[read-only] public static function get styleNameProperty():Property
styles | property |
styles:Object
[read-only] Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Returns the styles on this TextLayoutFormat. Note that the getter makes a copy of the styles dictionary. The coreStyles object encapsulates all styles set in the format property including core and user styles. The returned object consists of an array of stylename-value pairs.
public function get styles():Object
See also
tableColumnWidth | property |
tableColumnWidth:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Width of table column specifies a default width for each column spanned by the current COL element.
Legal values as a number are from 0 to 8000.
Legal values as a percent are numbers from 0% to 100%.
Legal values include FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 0.
public function get tableColumnWidth():*
public function set tableColumnWidth(value:any):void
RangeError — when set value is not within range for this property
|
tableColumnWidthProperty | property |
tableColumnWidthProperty:Property
[read-only] public static function get tableColumnWidthProperty():Property
tableWidth | property |
tableWidth:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Width of table element specifies the desired width of the entire table and is intended for visual user agents. When the value is a percentage value, the value is relative to the user agent's available horizontal space.
Legal values as a number are from 0 to 8000.
Legal values as a percent are numbers from 0% to 100%.
Legal values include FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of 100%.
public function get tableWidth():*
public function set tableWidth(value:any):void
RangeError — when set value is not within range for this property
|
tableWidthProperty | property |
tableWidthProperty:Property
[read-only] public static function get tableWidthProperty():Property
tabStops | property |
tabStops:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the tab stops associated with the paragraph.
Setters can take an array of TabStopFormat, a condensed string representation, undefined, or FormatValue.INHERIT
. The condensed string representation is always converted into an array of TabStopFormat.
The string-based format is a list of tab stops, where each tab stop is delimited by one or more spaces.
A tab stop takes the following form: <alignment type><alignment position>|<alignment token>.
The alignment type is a single character, and can be S, E, C, or D (or lower-case equivalents). S or s for start, E or e for end, C or c for center, D or d for decimal. The alignment type is optional, and if its not specified will default to S.
The alignment position is a Number, and is specified according to FXG spec for Numbers (decimal or scientific notation). The alignment position is required.
The vertical bar is used to separate the alignment position from the alignment token, and should only be present if the alignment token is present.
The alignment token is optional if the alignment type is D, and should not be present if the alignment type is anything other than D. The alignment token may be any sequence of characters terminated by the space that ends the tab stop (for the last tab stop, the terminating space is optional; end of alignment token is implied). A space may be part of the alignment token if it is escaped with a backslash (\ ). A backslash may be part of the alignment token if it is escaped with another backslash (\\). If the alignment type is D, and the alignment token is not specified, it will take on the default value of null.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of null.
public function get tabStops():*
public function set tabStops(value:any):void
RangeError — when set value is not within range for this property
|
See also
tabStopsProperty | property |
tabStopsProperty:Property
[read-only] public static function get tabStopsProperty():Property
textAlign | property |
textAlign:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Alignment of lines in the paragraph relative to the container.
TextAlign.LEFT
aligns lines along the left edge of the container. TextAlign.RIGHT
aligns on the right edge. TextAlign.CENTER
positions the line equidistant from the left and right edges. TextAlign.JUSTIFY
spreads the lines out so they fill the space. TextAlign.START
is equivalent to setting left in left-to-right text, or right in right-to-left text. TextAlign.END
is equivalent to setting right in left-to-right text, or left in right-to-left text.
Legal values are TextAlign.LEFT, TextAlign.RIGHT, TextAlign.CENTER, TextAlign.JUSTIFY, TextAlign.START, TextAlign.END, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextAlign.START.
public function get textAlign():*
public function set textAlign(value:any):void
RangeError — when set value is not within range for this property
|
See also
textAlignLast | property |
textAlignLast:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Alignment of the last (or only) line in the paragraph relative to the container in justified text.
If textAlign
is set to TextAlign.JUSTIFY
, textAlignLast
specifies how the last line (or only line, if this is a one line block) is aligned. Values are similar to textAlign
.
Legal values are TextAlign.LEFT, TextAlign.RIGHT, TextAlign.CENTER, TextAlign.JUSTIFY, TextAlign.START, TextAlign.END, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextAlign.START.
public function get textAlignLast():*
public function set textAlignLast(value:any):void
RangeError — when set value is not within range for this property
|
See also
textAlignLastProperty | property |
textAlignLastProperty:Property
[read-only] public static function get textAlignLastProperty():Property
textAlignProperty | property |
textAlignProperty:Property
[read-only] public static function get textAlignProperty():Property
textAlpha | property |
textAlpha:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Alpha (transparency) value for the text. A value of 0 is fully transparent, and a value of 1 is fully opaque. Display objects with textAlpha
set to 0 are active, even though they are invisible.
Legal values are numbers from 0 to 1 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 1.
public function get textAlpha():*
public function set textAlpha(value:any):void
RangeError — when set value is not within range for this property
|
textAlphaProperty | property |
textAlphaProperty:Property
[read-only] public static function get textAlphaProperty():Property
textDecoration | property |
textDecoration:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Decoration on text. Use to apply underlining; default is none.
Legal values are TextDecoration.NONE, TextDecoration.UNDERLINE, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextDecoration.NONE.
public function get textDecoration():*
public function set textDecoration(value:any):void
RangeError — when set value is not within range for this property
|
See also
textDecorationProperty | property |
textDecorationProperty:Property
[read-only] public static function get textDecorationProperty():Property
textIndent | property |
textIndent:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
A Number that specifies, in pixels, the amount to indent the first line of the paragraph. A negative indent will push the line into the margin, and possibly out of the container.
Legal values are numbers from -8000 to 8000 and FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.
public function get textIndent():*
public function set textIndent(value:any):void
RangeError — when set value is not within range for this property
|
textIndentProperty | property |
textIndentProperty:Property
[read-only] public static function get textIndentProperty():Property
textJustify | property |
textJustify:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies options for justifying text.
Default value is TextJustify.INTER_WORD
, meaning that extra space is added to the space characters. TextJustify.DISTRIBUTE
adds extra space to space characters and between individual letters. Used only in conjunction with a justificationRule
value of JustificationRule.SPACE
.
Legal values are TextJustify.INTER_WORD, TextJustify.DISTRIBUTE, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextJustify.INTER_WORD.
public function get textJustify():*
public function set textJustify(value:any):void
RangeError — when set value is not within range for this property
|
See also
textJustifyProperty | property |
textJustifyProperty:Property
[read-only] public static function get textJustifyProperty():Property
textRotation | property |
textRotation:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Determines the number of degrees to rotate this text.
Legal values are TextRotation.ROTATE_0, TextRotation.ROTATE_180, TextRotation.ROTATE_270, TextRotation.ROTATE_90, TextRotation.AUTO, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextRotation.AUTO.
public function get textRotation():*
public function set textRotation(value:any):void
RangeError — when set value is not within range for this property
|
See also
textRotationProperty | property |
textRotationProperty:Property
[read-only] public static function get textRotationProperty():Property
trackingLeft | property |
trackingLeft:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Number in pixels (or percent of fontSize
, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character. If kerning is enabled, the trackingLeft
value is added to the values in the kerning table for the font. If kerning is disabled, the trackingLeft
value is used as a manual kerning value. Supports both positive and negative values.
Legal values as a number are from -1000 to 1000.
Legal values as a percent are numbers from -1000% to 1000%.
Legal values include FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.
public function get trackingLeft():*
public function set trackingLeft(value:any):void
RangeError — when set value is not within range for this property
|
trackingLeftProperty | property |
trackingLeftProperty:Property
[read-only] public static function get trackingLeftProperty():Property
trackingRight | property |
trackingRight:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Number in pixels (or percent of fontSize
, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character. If kerning is enabled, the trackingRight
value is added to the values in the kerning table for the font. If kerning is disabled, the trackingRight
value is used as a manual kerning value. Supports both positive and negative values.
Legal values as a number are from -1000 to 1000.
Legal values as a percent are numbers from -1000% to 1000%.
Legal values include FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.
public function get trackingRight():*
public function set trackingRight(value:any):void
RangeError — when set value is not within range for this property
|
trackingRightProperty | property |
trackingRightProperty:Property
[read-only] public static function get trackingRightProperty():Property
typographicCase | property |
typographicCase:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The type of typographic case used for this text. Here are some examples:
Legal values are TLFTypographicCase.DEFAULT, TLFTypographicCase.CAPS_TO_SMALL_CAPS, TLFTypographicCase.UPPERCASE, TLFTypographicCase.LOWERCASE, TLFTypographicCase.LOWERCASE_TO_SMALL_CAPS, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TLFTypographicCase.DEFAULT.
public function get typographicCase():*
public function set typographicCase(value:any):void
RangeError — when set value is not within range for this property
|
See also
typographicCaseProperty | property |
typographicCaseProperty:Property
[read-only] public static function get typographicCaseProperty():Property
userStyles | property |
userStyles:Object
[read-only] Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Returns the userStyles
on this TextLayoutFormat.
The userStyles object includes the formats that are defined by TextLayoutFormat and are not in TextLayoutFormat.description. The
returned userStyles
object consists of an array of stylename-value pairs.
public function get userStyles():Object
See also
verticalAlign | property |
verticalAlign:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Vertical alignment or justification (adopts default value if undefined during cascade). Determines how TextFlow elements align within the container.
Legal values are VerticalAlign.TOP, VerticalAlign.MIDDLE, VerticalAlign.BOTTOM, VerticalAlign.JUSTIFY, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will have a value of VerticalAlign.TOP.
public function get verticalAlign():*
public function set verticalAlign(value:any):void
RangeError — when set value is not within range for this property
|
See also
verticalAlignProperty | property |
verticalAlignProperty:Property
[read-only] public static function get verticalAlignProperty():Property
whiteSpaceCollapse | property |
whiteSpaceCollapse:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Collapses or preserves whitespace when importing text into a TextFlow. WhiteSpaceCollapse.PRESERVE
retains all whitespace characters. WhiteSpaceCollapse.COLLAPSE
removes newlines, tabs, and leading or trailing spaces within a block of imported text. Line break tags () and Unicode line separator characters are retained.
Legal values are WhiteSpaceCollapse.PRESERVE, WhiteSpaceCollapse.COLLAPSE, FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of WhiteSpaceCollapse.COLLAPSE.
public function get whiteSpaceCollapse():*
public function set whiteSpaceCollapse(value:any):void
RangeError — when set value is not within range for this property
|
See also
whiteSpaceCollapseProperty | property |
whiteSpaceCollapseProperty:Property
[read-only] public static function get whiteSpaceCollapseProperty():Property
wordSpacing | property |
wordSpacing:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the optimum, minimum, and maximum spacing (as a multiplier of the width of a normal space) between words to use during justification. The optimum space is used to indicate the desired size of a space, as a fraction of the value defined in the font. The minimum and maximum values are the used when textJustify is distribute to determine how wide or narrow the spaces between the words may grow before letter spacing is used to justify the line.
Legal values as a percent are numbers from -1000% to 1000%.
Legal values include FormatValue.INHERIT.
Default value is undefined indicating not set.
If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 100%, 50%, 150%.
public function get wordSpacing():*
public function set wordSpacing(value:any):void
RangeError — when set value is not within range for this property
|
wordSpacingProperty | property |
wordSpacingProperty:Property
[read-only] public static function get wordSpacingProperty():Property
TextLayoutFormat | () | Constructor |
public function TextLayoutFormat(initialValues:ITextLayoutFormat = null)
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Creates a new TextLayoutFormat object. All settings are empty or, optionally, are initialized from the
supplied initialValues
object.
initialValues:ITextLayoutFormat (default = null ) — optional instance from which to copy initial values.
|
See also
apply | () | method |
public function apply(incoming:ITextLayoutFormat):void
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Replaces property values in this TextLayoutFormat object with the values of properties that are set in
the incoming
ITextLayoutFormat instance. Properties that are undefined
in the incoming
ITextLayoutFormat instance are not changed in this object.
Parameters
incoming:ITextLayoutFormat — instance whose property values are applied to this TextLayoutFormat object.
|
concat | () | method |
public function concat(incoming:ITextLayoutFormat):void
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Concatenates the values of properties in the incoming
ITextLayoutFormat instance
with the values of this TextLayoutFormat object. In this (the receiving) TextLayoutFormat object, properties whose values are FormatValue.INHERIT
,
and inheriting properties whose values are undefined
will get new values from the incoming
object.
Non-inheriting properties whose values are undefined
will get their default values.
All other property values will remain unmodified.
Parameters
incoming:ITextLayoutFormat — instance from which values are concatenated.
|
See also
concatInheritOnly | () | method |
public function concatInheritOnly(incoming:ITextLayoutFormat):void
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Concatenates the values of properties in the incoming
ITextLayoutFormat instance
with the values of this TextLayoutFormat object. In this (the receiving) TextLayoutFormat object, properties whose values are FormatValue.INHERIT
,
and inheriting properties whose values are undefined
will get new values from the incoming
object.
All other property values will remain unmodified.
Parameters
incoming:ITextLayoutFormat — instance from which values are concatenated.
|
See also
copy | () | method |
public function copy(incoming:ITextLayoutFormat):void
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Copies TextLayoutFormat settings from the values
ITextLayoutFormat instance into this TextLayoutFormat object.
If values
is null
, this TextLayoutFormat object is initialized with undefined values for all properties.
Parameters
incoming:ITextLayoutFormat — optional instance from which to copy values.
|
createTextLayoutFormat | () | method |
public static function createTextLayoutFormat(initialValues:Object):TextLayoutFormat
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Creates a new TextLayoutFormat object. All settings are empty or, optionally, are initialized from the
supplied initialValues
object.
Parameters
initialValues:Object — optional instance from which to copy initial values. If an TextLayoutFormat object values are copied.
Otherwise initialValues is treated like a Dictionary or Object and iterated over.
|
TextLayoutFormat |
getStyle | () | method |
public function getStyle(styleProp:String):*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Returns the value of the style specified by the styleProp
parameter, which specifies
the style name.
Parameters
styleProp:String — The name of the style whose value is to be retrieved.
|
* — The value of the specified style. The type varies depending on the type of the style being
accessed. Returns undefined if the style is not set.
|
isEqual | () | method |
public static function isEqual(p1:ITextLayoutFormat, p2:ITextLayoutFormat):Boolean
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Compares properties in ITextLayoutFormat instance p1
with properties in ITextLayoutFormat instance p2
and returns true
if all properties match.
Parameters
p1:ITextLayoutFormat — instance to compare to p2 .
| |
p2:ITextLayoutFormat — instance to compare to p1 .
|
Boolean — true if all properties match, false otherwise.
|
removeClashing | () | method |
public function removeClashing(incoming:ITextLayoutFormat):void
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Sets properties in this TextLayoutFormat object to undefined
if they do not match those in the
incoming
ITextLayoutFormat instance.
Parameters
incoming:ITextLayoutFormat — instance against which to compare this TextLayoutFormat object's property values.
|
removeMatching | () | method |
public function removeMatching(incoming:ITextLayoutFormat):void
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Sets properties in this TextLayoutFormat object to undefined
if they match those in the incoming
ITextLayoutFormat instance.
Parameters
incoming:ITextLayoutFormat — instance against which to compare this TextLayoutFormat object's property values.
|
setStyle | () | method |
public function setStyle(styleProp:String, newValue:*):void
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Sets the style specified by the styleProp
parameter to the value specified by the
newValue
parameter.
Parameters
styleProp:String — The name of the style to set.
| |
newValue:* — The value to which to set the style.
|