Returns the first character in the container. If this is not the first container in the flow, this value is updated when the text is composed, that is when the IFlowComposer's compose() or updateAllControllers() methods are called.

See also

TextLayoutFormat: 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 flash.text.engine.TextBaseline.ROMAN, flash.text.engine.TextBaseline.ASCENT, flash.text.engine.TextBaseline.DESCENT, flash.text.engine.TextBaseline.IDEOGRAPHIC_TOP, flash.text.engine.TextBaseline.IDEOGRAPHIC_CENTER, flash.text.engine.TextBaseline.IDEOGRAPHIC_BOTTOM, flash.text.engine.TextBaseline.USE_DOMINANT_BASELINE, flashx.textLayout.formats.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 USE_DOMINANT_BASELINE.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of 1.

TextLayoutFormat: 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 flashx.textLayout.formats.BackgroundColor.TRANSPARENT, flashx.textLayout.formats.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 TRANSPARENT.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.BaselineShift.SUPERSCRIPT, flashx.textLayout.formats.BaselineShift.SUBSCRIPT, flashx.textLayout.formats.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.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.BlockProgression.RL, flashx.textLayout.formats.BlockProgression.TB, flashx.textLayout.formats.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 TB.

See also

TextLayoutFormat: 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 flash.text.engine.BreakOpportunity.ALL, flash.text.engine.BreakOpportunity.ANY, flash.text.engine.BreakOpportunity.AUTO, flash.text.engine.BreakOpportunity.NONE, flashx.textLayout.formats.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 AUTO.

See also

TextLayoutFormat: 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 flash.text.engine.CFFHinting.NONE, flash.text.engine.CFFHinting.HORIZONTAL_STEM, flashx.textLayout.formats.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 HORIZONTAL_STEM.

See also

TextLayoutFormat: 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.

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.

TextLayoutFormat: 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 flashx.textLayout.formats.FormatValue.AUTO, flashx.textLayout.formats.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 AUTO.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of 20.

Returns a ColumnState object, which describes the number and characteristics of columns in the container. These values are updated when the text is recomposed, either as a result of IFlowComposer.compose() or IFlowComposer.updateAllControllers().

See also

TextLayoutFormat: 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 flashx.textLayout.formats.FormatValue.AUTO, flashx.textLayout.formats.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 AUTO.

See also

Returns the vertical extent allowed for text inside the container. The value is specified in pixels.

See also

Returns the horizontal extent allowed for text inside the container. The value is specified in pixels.

See also

Returns an ITextLayoutFormat instance with the attributes applied to this container, including the attributes inherited from its root element.

See also

Returns the container display object that holds the text lines for this ContainerController instance.

See also

Returns the coreStyles on this ContainerController. Note that the getter makes a copy of the core styles dictionary. The coreStyles object encapsulates those formats that are defined by TextLayoutFormat. The coreStyles object consists of an array of stylename-value pairs.

TextLayoutFormat: 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 flash.text.engine.DigitCase.DEFAULT, flash.text.engine.DigitCase.LINING, flash.text.engine.DigitCase.OLD_STYLE, flashx.textLayout.formats.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 DEFAULT.

See also

TextLayoutFormat: 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 flash.text.engine.DigitWidth.DEFAULT, flash.text.engine.DigitWidth.PROPORTIONAL, flash.text.engine.DigitWidth.TABULAR, flashx.textLayout.formats.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 DEFAULT.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.Direction.LTR, flashx.textLayout.formats.Direction.RTL, flashx.textLayout.formats.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 LTR.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.FormatValue.AUTO, flash.text.engine.TextBaseline.ROMAN, flash.text.engine.TextBaseline.ASCENT, flash.text.engine.TextBaseline.DESCENT, flash.text.engine.TextBaseline.IDEOGRAPHIC_TOP, flash.text.engine.TextBaseline.IDEOGRAPHIC_CENTER, flash.text.engine.TextBaseline.IDEOGRAPHIC_BOTTOM, flashx.textLayout.formats.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 flashx.textLayout.formats.FormatValue.AUTO.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.BaselineOffset.AUTO, flashx.textLayout.formats.BaselineOffset.ASCENT, flashx.textLayout.formats.BaselineOffset.LINE_HEIGHT, flashx.textLayout.formats.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 AUTO.

See also

Returns the flow composer object that composes and highlights text into the container that this controller manages.

See also

TextLayoutFormat: 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.

TextLayoutFormat: 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 flash.text.engine.FontLookup.DEVICE, flash.text.engine.FontLookup.EMBEDDED_CFF, flashx.textLayout.formats.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 DEVICE.

See also

TextLayoutFormat: The size of the text in pixels.

Legal values are numbers from 1 to 720 and flashx.textLayout.formats.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.

TextLayoutFormat: 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 flash.text.engine.FontPosture.NORMAL, flash.text.engine.FontPosture.ITALIC, flashx.textLayout.formats.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 NORMAL.

See also

TextLayoutFormat: 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 flash.text.engine.FontWeight.NORMAL, flash.text.engine.FontWeight.BOLD, flashx.textLayout.formats.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 NORMAL.

See also

Stores the ITextLayoutFormat object that contains the attributes for this container. The controller inherits the container properties from the TextFlow of which it is part. This property allows different controllers in the same text flow to have, for example, different column settings or padding.

See also

Specifies the horizontal scrolling policy, which you can set by assigning one of the constants of the ScrollPolicy class: ON, OFF, or AUTO.

See also

Specifies the current horizontal scroll location on the stage. The value specifies the number of pixels from the left.

The InteractionManager associated with this TextFlow object.

Controls all selection and editing on the text. If the TextFlow is not selectable, the interactionManager is null. To make the TextFlow editable, assign a interactionManager that is both an ISelectionManager and an IEditManager. To make a TextFlow that is read-only and allows selection, assign a interactionManager that is an ISelectionManager only.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.JustificationRule.EAST_ASIAN, flashx.textLayout.formats.JustificationRule.SPACE, flashx.textLayout.formats.FormatValue.AUTO, flashx.textLayout.formats.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 flashx.textLayout.formats.FormatValue.AUTO.

See also

TextLayoutFormat: 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 flash.text.engine.JustificationStyle.PRIORITIZE_LEAST_ADJUSTMENT, flash.text.engine.JustificationStyle.PUSH_IN_KINSOKU, flash.text.engine.JustificationStyle.PUSH_OUT_ONLY, flashx.textLayout.formats.FormatValue.AUTO, flashx.textLayout.formats.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 flashx.textLayout.formats.FormatValue.AUTO.

See also

TextLayoutFormat: Kerning adjusts the pixels between certain character pairs to improve readability. Kerning is supported for all fonts with kerning tables.

Legal values are flash.text.engine.Kerning.ON, flash.text.engine.Kerning.OFF, flash.text.engine.Kerning.AUTO, flashx.textLayout.formats.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 AUTO.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.LeadingModel.ROMAN_UP, flashx.textLayout.formats.LeadingModel.IDEOGRAPHIC_TOP_UP, flashx.textLayout.formats.LeadingModel.IDEOGRAPHIC_CENTER_UP, flashx.textLayout.formats.LeadingModel.IDEOGRAPHIC_TOP_DOWN, flashx.textLayout.formats.LeadingModel.IDEOGRAPHIC_CENTER_DOWN, flashx.textLayout.formats.LeadingModel.APPROXIMATE_TEXT_FIELD, flashx.textLayout.formats.LeadingModel.ASCENT_DESCENT_UP, flashx.textLayout.formats.LeadingModel.AUTO, flashx.textLayout.formats.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 AUTO.

See also

TextLayoutFormat: 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 flash.text.engine.LigatureLevel.MINIMUM, flash.text.engine.LigatureLevel.COMMON, flash.text.engine.LigatureLevel.UNCOMMON, flash.text.engine.LigatureLevel.EXOTIC, flashx.textLayout.formats.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 COMMON.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.LineBreak.EXPLICIT, flashx.textLayout.formats.LineBreak.TO_FIT, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of TO_FIT.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.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%.

TextLayoutFormat: If true, applies strikethrough, a line drawn through the middle of the text.

Legal values are true, false and flashx.textLayout.formats.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.

TextLayoutFormat: 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.

TextLayoutFormat: Botttom inset in pixels (adopts default value if undefined during cascade). Space between the bottom edge of the container and the text. Value is a Number.

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 are numbers from 0 to 1000 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of 0.

TextLayoutFormat: Left inset in pixels (adopts default value if undefined during cascade). Space between the left edge of the container and the text. Value is a Number.

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 are numbers from 0 to 1000 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of 0.

TextLayoutFormat: Right inset in pixels (adopts default value if undefined during cascade). Space between the right edge of the container and the text. Value is a Number.

Legal values are numbers from 0 to 1000 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of 0.

TextLayoutFormat: Top inset in pixels (adopts default value if undefined during cascade). Space between the top edge of the container and the text. Value is a Number.

Legal values are numbers from 0 to 1000 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of 0.

TextLayoutFormat: 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 1000 and flashx.textLayout.formats.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.

TextLayoutFormat: 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 1000 and flashx.textLayout.formats.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.

TextLayoutFormat: 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 1000 and flashx.textLayout.formats.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.

TextLayoutFormat: 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 1000 and flashx.textLayout.formats.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.

TextLayoutFormat: The rendering mode used for this text. Applies only to embedded fonts (fontLookup property is set to FontLookup.EMBEDDED_CFF).

Legal values are flash.text.engine.RenderingMode.NORMAL, flash.text.engine.RenderingMode.CFF, flashx.textLayout.formats.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 CFF.

See also

Returns the root element that appears in the container. The root element could be a DivElement or TextFlow instance, for example.

See also

TextLayoutFormat: Specifies the tab stops associated with the paragraph. Setters can take an array of flashx.textLayout.formats.TabStopFormat, a condensed string representation, undefined, or FormatValue.INHERIT. The condensed string representation is always converted into an array of flashx.textLayout.formats.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.

If no tab stops are specified, a tab action defaults to the end of the line.

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.

TextLayoutFormat: 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 flashx.textLayout.formats.TextAlign.LEFT, flashx.textLayout.formats.TextAlign.RIGHT, flashx.textLayout.formats.TextAlign.CENTER, flashx.textLayout.formats.TextAlign.JUSTIFY, flashx.textLayout.formats.TextAlign.START, flashx.textLayout.formats.TextAlign.END, flashx.textLayout.formats.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 START.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.TextAlign.LEFT, flashx.textLayout.formats.TextAlign.RIGHT, flashx.textLayout.formats.TextAlign.CENTER, flashx.textLayout.formats.TextAlign.JUSTIFY, flashx.textLayout.formats.TextAlign.START, flashx.textLayout.formats.TextAlign.END, flashx.textLayout.formats.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 START.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.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.

TextLayoutFormat: Decoration on text. Use to apply underlining; default is none.

Legal values are flashx.textLayout.formats.TextDecoration.NONE, flashx.textLayout.formats.TextDecoration.UNDERLINE, flashx.textLayout.formats.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 NONE.

See also

Returns the TextFlow object whose content appears in the container. Either the textFlow and rootElement values are the same, or this is the root element's TextFlow object. For example, if the container's root element is a DivElement, the value would be the TextFlow object to which the DivElement belongs.

See also

TextLayoutFormat: 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 -1000 to 1000 and flashx.textLayout.formats.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.

TextLayoutFormat: 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 flashx.textLayout.formats.TextJustify.INTER_WORD, flashx.textLayout.formats.TextJustify.DISTRIBUTE, flashx.textLayout.formats.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 INTER_WORD.

See also

Returns the total number of characters in the container. This can include text that is not currently in view, if the container is scrollable. This value is updated when the text is composed (when the IFlowComposer's compose() or updateAllControllers() methods are called).

See also

TextLayoutFormat: Determines the number of degrees to rotate this text.

Legal values are flash.text.engine.TextRotation.ROTATE_0, flash.text.engine.TextRotation.ROTATE_180, flash.text.engine.TextRotation.ROTATE_270, flash.text.engine.TextRotation.ROTATE_90, flash.text.engine.TextRotation.AUTO, flashx.textLayout.formats.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 AUTO.

See also

TextLayoutFormat: 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 flashx.textLayout.formats.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.

TextLayoutFormat: 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 flashx.textLayout.formats.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.

TextLayoutFormat: The type of typographic case used for this text. Here are some examples:

Legal values are flashx.textLayout.formats.TLFTypographicCase.DEFAULT, flashx.textLayout.formats.TLFTypographicCase.CAPS_TO_SMALL_CAPS, flashx.textLayout.formats.TLFTypographicCase.UPPERCASE, flashx.textLayout.formats.TLFTypographicCase.LOWERCASE, flashx.textLayout.formats.TLFTypographicCase.LOWERCASE_TO_SMALL_CAPS, flashx.textLayout.formats.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 DEFAULT.

See also

The userStyles object for a ContainerController instance. The getter makes a copy of the userStyles object, which is an array of stylename-value pairs.

TextLayoutFormat: Vertical alignment or justification (adopts default value if undefined during cascade). Determines how TextFlow elements align within the container.

Legal values are flashx.textLayout.formats.VerticalAlign.TOP, flashx.textLayout.formats.VerticalAlign.MIDDLE, flashx.textLayout.formats.VerticalAlign.BOTTOM, flashx.textLayout.formats.VerticalAlign.JUSTIFY, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of TOP.

See also

Specifies the vertical scrolling policy, which you can set by assigning one of the constants of the ScrollPolicy class: ON, OFF, or, AUTO.

See also

Specifies the current vertical scroll location on the stage. The value specifies the number of pixels from the top.

TextLayoutFormat: 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 flashx.textLayout.formats.WhiteSpaceCollapse.PRESERVE, flashx.textLayout.formats.WhiteSpaceCollapse.COLLAPSE, flashx.textLayout.formats.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 COLLAPSE.

See also

Constructor - creates a ContainerController instance. The ContainerController has a default compositionWidth and compositionHeight so that some text appears in the container if you don't specify its width height.

Processes the Event.ACTIVATE event when the client manages events.

Parameters

See also

package flashx.textLayout.container.examples
{
    import flash.display.Sprite;
     import flash.events.Event;
     import flashx.textLayout.container.ContainerController;
     
    public class ContainerController_activateHandlerExample extends ContainerController
    {
        public function ContainerController_activateHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100)
        {
            super(container, compositionWidth, compositionHeight);
        }
        override public function activateHandler(event:Event):void
        {    
            // run the TLF handler for the activate event
            super.activateHandler(event);
            // and add your own code for the event 
            trace("You are in activateHandler()");        
        }
    }
}

Adds a flash.display.Shape object on which background shapes (such as background color) are drawn. The default implementation of this method, which may be overriden, adds the object to container just before the first flash.text.engine.TextLine child, if one exists, and after the last exisiting child otherwise.

Parameters

See also

Adds a flash.display.DisplayObjectContainer object to which selection shapes (such as block selection highlight, cursor etc.) are added. The default implementation of this method, which may be overriden, has the following behavior: The object is added just before first flash.text.engine.TextLine child of container if one exists and the object is opaque and has normal blend mode. In all other cases, it is added as the last child of container.

Parameters

See also

Adds a flash.text.engine.TextLine object as a descendant of container. The default implementation of this method, which may be overriden, adds the object as a direct child of container at the specified index.

Parameters

See also

Handle a scroll event during a "drag" selection.

Parameters

Called to request clients to begin the forwarding of mouseup and mousemove events from outside a security sandbox.

Clears the style specified by styleProp from this FlowElement. Sets the value to undefined.

Parameters

Creates a context menu for the ContainerController. Use the methods of the ContextMenu class to add items to the menu.

You can override this method to define a custom context menu.

See also

Processes the Event.DEACTIVATE event when the client manages events.

Parameters

See also

Processes an edit event (CUT, COPY, PASTE, SELECT_ALL) when the client manages events.

Parameters

See also

package flashx.textLayout.container.examples 
{
    import flash.events.Event;
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    
    public class ContainerController_editHandlerExample extends ContainerController
    {
        public function ContainerController_editHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100)
        {
            super(container, compositionWidth, compositionHeight);
        }
        override public function editHandler(event:Event):void
        {    
            // run the TLF handler for the focus event
            super.editHandler(event);
            // and add your own code for the event 
            trace("You are in editHandler()");        
        }
    }
}

Called to inform clients that the the forwarding of mouseup and mousemove events from outside a security sandbox is no longer needed.

Processes the FocusEvent.KEY_FOCUS_CHANGE and FocusEvent.MOUSE_FOCUS_CHANGE events when the client manages events.

Parameters

See also

Processes the FocusEvent.FOCUS_IN event when the client manages events.

Parameters

See also

package flashx.textLayout.container.examples 
{
    import flash.events.FocusEvent;
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    
    public class ContainerController_focusInHandlerExample extends ContainerController
    {
        public function ContainerController_focusInHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100)
        {
            super(container, compositionWidth, compositionHeight);
        }
        override public function focusInHandler(event:FocusEvent):void
        {    
            // run the TLF handler for the focus event
            super.focusInHandler(event);
            // and add your own code for the event 
            trace("You are in focusInHandler()");        
        }
    }
}

Processes the FocusEvent.FOCUS_OUT event when the client manages events.

Parameters

See also

Returns the area that the text occupies, as reflected by the last compose or update operation. The width and the height might be estimated, if the container is scrollable and the text exceeds the visible area.

See also

package flashx.textLayout.container.examples
{
    import flash.geom.Rectangle;
    import flash.display.Sprite;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.conversion.TextConverter;

    public class ContainerController_getContentBoundsExample extends Sprite
    {    
        private const textMarkup:String = "<flow:TextFlow xmlns:flow='http://ns.adobe.com/textLayout/2008' fontSize='08' " + 
            "textIndent='10' paragraphSpaceBefore='6' paddingTop='8' paddingLeft='8' paddingRight='8'>" +
            "<flow:p paragraphSpaceBefore='inherit'>" +
            "<flow:span>There are many </flow:span>" + 
            "<flow:span fontStyle='italic'>such</flow:span>" + 
            "<flow:span> lime-kilns in that tract of country, for the purpose of burning the white" + 
            " marble which composes a large part of the substance of the hills. Some of them, built " + 
            "years ago, and long deserted, with weeds growing in the vacant round of the interior, " + 
            "which is open to the sky, and grass and wild-flowers rooting themselves into the chinks" + 
            "of the stones, look already like relics of antiquity, and may yet be overspread with the" + 
            " lichens of centuries to come.</flow:span>" +
            "</flow:p>" +
            "</flow:TextFlow>";
        
        public function ContainerController_getContentBoundsExample(textFlow:TextFlow):void
        {        
            // Body text TextFlow and flow composer
            var textFlow:TextFlow = new TextFlow();
            textFlow = TextConverter.importToFlow(textMarkup, TextConverter.TEXT_LAYOUT_FORMAT);
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController(container, 120, 200);
            container.x = 150;
            container.y = 50;
            // Add controller to text flow; add container to stage and display text
            textFlow.flowComposer.addController(controller);
            addChild(container);
            textFlow.flowComposer.updateAllControllers();
            // draw a border around the text
            drawBorder(controller);
        }
        
        private function drawBorder(controller:ContainerController):void
        {
            // get the rectangle that makes up the bounds of the content
            var bounds:Rectangle = controller.getContentBounds();
            // retrieve the container and draw the border 
            var container:Sprite = controller.container as Sprite;
            container.graphics.lineStyle(.5);
            container.graphics.moveTo(bounds.left,bounds.top);
            container.graphics.lineTo(bounds.right,bounds.top);
            container.graphics.lineTo(bounds.right,bounds.bottom);
            container.graphics.lineTo(bounds.left,bounds.bottom);
            container.graphics.lineTo(bounds.left,bounds.top);
            container.graphics.drawRect(bounds.left, bounds.top, bounds.width, bounds.height );
        }
    }
}

        

Gets the index at which the first text line must appear in its parent. The default implementation of this method, which may be overriden, returns the child index of the first flash.text.engine.TextLine child of container if one exists, and that of the last child of container otherwise.

See also

Figure out the scroll distance required to scroll up or down by the specified number of lines. Negative numbers scroll upward, bringing more of the top of the TextFlow into view. Positive numbers scroll downward, bringing the next line from the bottom into full view.

When scrolling up, for example, the method makes the next line fully visible. If the next line is partially obscured and the number of lines specified is 1, the partially obscured line becomes fully visible.

Parameters

Returns the value of the style specified by the styleProp parameter.

Parameters

Processes the IMEEvent.IME_START_COMPOSITION event when the client manages events.

Parameters

See also

Marks all the text in this container as needing composing.

package flashx.textLayout.container.examples 
{
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.conversion.TextConverter;
    
    public class ContainerController_invalidateContentsExample extends Sprite
    {
        public function ContainerController_invalidateContentsExample()
        {
            // create container, text flow, composer, paragraph, and span
            var container:Sprite = new Sprite();
            var textFlow:TextFlow = new TextFlow();
            var paragraph:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement;
            // add container to the stage; create controller and add it to the text flow
            addChild(container);
            container.x = 100;
            container.y = 50;
            var controller:ContainerController = new ContainerController(container, 200, 200);
            textFlow.flowComposer.addController(controller);
            // set font size and add text to the span; add the span to the paragraph
            textFlow.fontSize = 16;
            span.text = "Does invalidateContents() cause this text to be damaged?";
            paragraph.addChild(span);
            textFlow.addChild(paragraph);  
            //update controller to display text
            textFlow.flowComposer.updateAllControllers(); 
            // invalidate the controller contents and check to see if they are damaged
            controller.invalidateContents();
            if(controller.isDamaged())
                span.text += "\nYes, it does.";
            else
                span.text += "\nNo, it doesn't";
            textFlow.flowComposer.updateAllControllers();   
        }
    }
}

Determines whether the container has text that requires composing.

 

package flashx.textLayout.container.examples 
{
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.conversion.TextConverter;
    
    public class ContainerController_isDamagedExample extends Sprite
    {
        public function ContainerController_isDamagedExample()
        {
            // create container, composer, text flow, paragraph, and span
            var container:Sprite = new Sprite();
            var textFlow:TextFlow = new TextFlow();
            var paragraph:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement;
            // add container to the stage; create controller and add it to the text flow
            addChild(container);
            var controller:ContainerController = new ContainerController(container, 200, 700 );
            textFlow.flowComposer.addController(controller);
            //set font size, add text to the span and the paragraph to the text flow
                        textFlow.fontSize = 24;
            span.text = "Does this text flow need to be composed?";
            paragraph.addChild(span);
            textFlow.addChild(paragraph); 
            // display the text               
            textFlow.flowComposer.updateAllControllers();
            // replace 'this' with 'your' and check to see if text flow is damaged
            span.replaceText(5, 9, "your");
            if(controller.isDamaged())
            {
                span.text += " Yes it does.";
            }
            textFlow.flowComposer.updateAllControllers();   
        }
    }
}

Processes the KeyboardEvent.KEY_DOWN event when the client manages events.

Parameters

See also

Processes the FocusEvent.KEY_FOCUS_CHANGE event when the client manages events.

Parameters

See also

Processes the Keyboard.KEY_UP event when the client manages events.

Parameters

See also

package flashx.textLayout.container.examples  
{
    import flash.events.KeyboardEvent;
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    
    public class ContainerController_keyUpHandlerExample extends ContainerController
    {
        public function ContainerController_keyUpHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100)
        {
            super(container, compositionWidth, compositionHeight);
        }
        override public function keyUpHandler(event:KeyboardEvent):void
        {    
            // run the TLF handler for the KEY_UP event
            super.keyUpHandler(event);
            // and add your own code for the event 
            trace("You are in keyUpHandler()");        
        }
    }
}

Processes the ContextMenuEvent.MENU_SELECT event when the client manages events.

Parameters

See also

package flashx.textLayout.container.examples 
{
    import flash.events.ContextMenuEvent;
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
     
    public class ContainerController_menuSelectHandlerExample extends ContainerController
    {
        public function ContainerController_menuSelectHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100)
         {
             super(container, compositionWidth, compositionHeight);
         }
        override public function menuSelectHandler(event:ContextMenuEvent):void
        {    
            // run the TLF handler for the MENU_SELECT event
            super.menuSelectHandler(event);
            // and add your own code for the event 
            trace("You are in menuSelectHandler()");        
        }
    }
}

Processes the MouseEvent.DOUBLE_CLICK event when the client manages events.

Parameters

See also

package flashx.textLayout.container.examples  
{
    import flash.events.MouseEvent;
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    
    public class ContainerController_mouseDoubleClickHandlerExample extends ContainerController
    {
        public function ContainerController_mouseDoubleClickHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100)
        {
            super(container, compositionWidth, compositionHeight);
        }
        override public function mouseDoubleClickHandler(event:MouseEvent):void
        {    
            // run the TLF handler for the MOUSE_OVER event
            super.mouseDoubleClickHandler(event);
            // and add your own code for the event 
            trace("You are in mouseDoubleClickHandler()");        
        }
    }
}

Processes the MouseEvent.MOUSE_DOWN event when the client manages events.

Parameters

See also

Processes the MouseEvent.MOUSE_MOVE event when the client manages events.

Parameters

See also

Client call to forward a mouseMove event from outside a security sandbox. Coordinates of the mouse move are not needed.

Parameters

Processes the MouseEvent.MOUSE_OUT event when the client manages events.

Parameters

See also

Processes the MouseEvent.MOUSE_OVER event when the client manages events.

Parameters

See also

package flashx.textLayout.container.examples  
{
    import flash.events.MouseEvent;
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    
    public class ContainerController_mouseOverHandlerExample extends ContainerController
    {
        public function ContainerController_mouseOverHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100)
        {
            super(container, compositionWidth, compositionHeight);
        }
        override public function mouseOverHandler(event:MouseEvent):void
        {    
            // run the TLF handler for the MOUSE_OVER event
            super.mouseOverHandler(event);
            // and add your own code for the event 
            trace("You are in mouseOverHandler()");        
        }
    }
}

Processes the MouseEvent.MOUSE_UP event when the client manages events.

Parameters

See also

Client call to forward a mouseUp event from outside a security sandbox. Coordinates of the mouse up are not needed.

Parameters

Processes the MouseEvent.MOUSE_WHEEL event when the client manages events.

Parameters

See also

Removes the flash.display.DisplayObjectContainer object which contains selection shapes (such as block selection highlight, cursor etc.). The default implementation of this method, which may be overriden, removes the object from its parent if one exists.

Parameters

See also

Removes a flash.text.engine.TextLine object from its parent. The default implementation of this method, which may be overriden, removes the object from container if it is a direct child of the latter. This method may be called even if the object is not a descendant of container. Any implementation of this method must ensure that no action is taken in this case.

Parameters

See also

Scrolls so that the text range is visible in the container.

Parameters

Sets the range of selected text in a component implementing ITextSupport. If either of the arguments is out of bounds the selection should not be changed. Components which wish to support inline IME should call into this method.

Parameters

Sets the width and height allowed for text in the container.

Parameters

package flashx.textLayout.container.examples 
{
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.conversion.TextConverter;
    
    public class ContainerController_setCompositionSizeExample extends Sprite
    {
        public function ContainerController_setCompositionSizeExample()
        {
            // create container, text flow, composer, paragraph, and span
            var container:Sprite = new Sprite();
            var textFlow:TextFlow = new TextFlow();
            var paragraph:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement;
            // add container to the stage; create controller and add it to the text flow
            addChild(container);
            container.x = 100;
            container.y = 50;
            var controller:ContainerController = new ContainerController(container);
            textFlow.flowComposer.addController(controller);
            // set font size and add text to the span; add the span to the paragraph
            textFlow.fontSize = 12;
            controller.setCompositionSize(250, 200);
            span.text = "This example uses setCompositionSize() to set compositionWidth (";
            span.text += controller.compositionWidth; 
            span.text += ") and compositionHeight ("
            span.text += controller.compositionHeight;
            span.text += "), rather than setting them with:\nnew ContainerController()";
            paragraph.addChild(span);
            // add paragraph to text flow, and display text
            textFlow.addChild(paragraph);            
            textFlow.flowComposer.updateAllControllers();       
        }
    }
}

Sets the value of the style specified by the styleProp parameter to the value specified by the newValue parameter.

Parameters

Processes the TextEvent.TEXT_INPUT event when the client manages events.

Parameters

See also

package flashx.textLayout.container.examples   
{
    import flash.events.TextEvent;
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
 
    public class ContainerController_textInputHandlerExample extends ContainerController
    {
        public function ContainerController_textInputHandlerExample(container:Sprite, compositionWidth:Number=100, compositionHeight:Number=100)
         {
             super(container, compositionWidth, compositionHeight);
         }
        override public function textInputHandler(event:TextEvent):void
        {    
            // run the TLF handler for the textInput event
            super.textInputHandler(event);
            // and add your own code for the event - e.g. only allow alpha characters
            trace("You are in textInputHandler()");
            
        }
    }
}

If scrolling, sets the scroll rectangle to the container rectangle so that any lines that are halfway in view are clipped to the scrollable region. If not scrolling, clear the scroll rectangle so that no clipping occurs.