CharacterFormat: Specifies the line baseline to which the element baseline specified by the elementBaseline property should align to determine the vertical position of the element on 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.

Default value is USE_DOMINANT_BASELINE.

Values may be null indicating not set.

See also

CharacterFormat: Amount to shift the baseline from the elementBaseline . Units are in pixels, or a percentage of the fontSize (in which case, enter a string value, like 140%). Positive values shift the line down for horizontal text (left for vertical) and negative values shift it up for horizontal (right for vertical).

Legal values are flashx.textLayout.formats.BaselineShift.SUPERSCRIPT, flashx.textLayout.formats.BaselineShift.SUBSCRIPT.

Legal values as a number are from -1000 to 1000.

Legal values as a percent are from -1000 to 1000.

Default value is 0.0.

Values may be null indicating not set.

See also

CharacterFormat: Controls where lines are allowed to break when wrapping text is broken into multiple lines. AUTOMATIC is for setting text normally. NONE means that the line breaker will not break the text unless there are no other places to break the line and the text would otherwise overrun the measure. ANY allows the line to break anywhere, not just between words. ALL means that each typographic cluster will be 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.

Default value is AUTO.

Values may be null indicating not set.

See also

CharacterFormat: The type of CFF hinting used for this text. CFF hinting determines whether Flash Player forces strong horizontal stems to fit to a sub pixel grid or not. This property applies only if the renderingMode property is set to flash.text.engine.RenderingMode.CFF, and the font is embedded ( fontLookup property is set to flash.text.engine.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.

Default value is HORIZONTAL_STEM.

Values may be null indicating not set.

See also

CharacterFormat properties applied directly to this element.

Each element may have properties applied to it as part of its format. Properties applied to this element override properties inherited from the parent. Properties applied to this element will in turn be inherited by element's children if they are not overridden on the child. If no properties are applied to the element, this will be null.

See also

CharacterFormat: Color of the text. An integer containing three 8-bit RGB components; for example, 0xFF0000 is red and 0x00FF00 is green.

Default value is 0.

Values may be null indicating not set.

CharacterFormat: The type of digit case used for this text. The OLD_STYLE setting 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 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.

Default value is DEFAULT.

Values may be null indicating not set.

See also

CharacterFormat: Type of digit width used for this text. This can be PROPORTIONAL, which looks best for individual numbers, or 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.

Default value is DEFAULT.

Values may be null indicating not set.

See also

CharacterFormat: Specifies which of the baselines of the element snaps to the alignmentBaseline to determine the vertical position of the element on the line. These baseline choices are determined by the choice of font and the font size.

Legal values are flash.text.engine.TextBaseline.ROMAN, flash.text.engine.TextBaseline.ASCENT, flash.text.engine.TextBaseline.DESCENT, flash.text.engine.TextBaseline.IDEOGRAPHIC_TOP, flash.text.engine.TextBaseline.IDEOGRAPHIC_CENTER, flash.text.engine.TextBaseline.IDEOGRAPHIC_BOTTOM.

Default value is ROMAN.

Values may be null indicating not set.

See also

CharacterFormat: The name of the font to use, or a comma-separated list of font names. Flash Player 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 Times New Roman.

Values may be null indicating not set.

CharacterFormat: Font lookup to use. Specifying a Device font 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 an Embedded_CFF font uses font outlines embedded in the published SWF file. Embedded fonts increase the size of the SWF file (sometimes dramatically), text is consistently displayed in the chosen font.

Legal values are flash.text.engine.FontLookup.DEVICE, flash.text.engine.FontLookup.EMBEDDED_CFF.

Default value is DEVICE.

Values may be null indicating not set.

See also

CharacterFormat: The size of the text in pixels.

Legal values are from 1 to 720.

Default value is 12.

Values may be null indicating not set.

CharacterFormat: Style of text. May be normal, for use in plain text, or italic. 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.

Default value is NORMAL.

Values may be null indicating not set.

See also

CharacterFormat: Weight of text. May be normal, for use in plain text, or 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.

Default value is NORMAL.

Values may be null indicating not set.

See also

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

Default value is ON.

Values may be null indicating not set.

See also

CharacterFormat: 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 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.NONE, flash.text.engine.LigatureLevel.MINIMUM, flash.text.engine.LigatureLevel.COMMON, flash.text.engine.LigatureLevel.UNCOMMON, flash.text.engine.LigatureLevel.EXOTIC.

Default value is COMMON.

Values may be null indicating not set.

See also

CharacterFormat: Leading controls for the text. The distance from the baseline of the previous or the next line (based on LeadingDirection ) 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 0 to 720.

Legal values as a percent are from 0% to 1000%.

Default value is 120%.

Values may be null indicating not set.

CharacterFormat: Strikethrough. If true, a line is drawn throught the middle of the text.

Legal values are from false to true.

Default value is false.

Values may be null indicating not set.

CharacterFormat: The locale of the text. Controls case transformations and shaping. Standard locale identifiers are used. For example en, en_US and en-US are all English, ja is Japanese.

Default value is en.

Values may be null indicating not set.

Returns the parent of this FlowElement object. Every FlowElement has at most one parent.

Returns the relative end of this FlowElement object in the parent. If the parent is null this is always equal to textLength . If the parent is not null, the value is the sum of the text lengths of this and all previous siblings, which is effectively the first character in the next FlowElement object.

See also

Returns the relative start of this FlowElement object in the parent. If parent is null, this value is always zero. If parent is not null, the value is the sum of the text lengths of all previous siblings.

See also

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

Legal values are flash.text.engine.RenderingMode.NORMAL, flash.text.engine.RenderingMode.CFF.

Default value is CFF.

Values may be null indicating not set.

See also

CharacterFormat: Alpha (transparency) value for the text. 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 from 0 to 1.

Default value is 1.

Values may be null indicating not set.

CharacterFormat: Decoration on text. By default this is none, but underline may be applied.

Legal values are flashx.textLayout.formats.TextDecoration.NONE, flashx.textLayout.formats.TextDecoration.UNDERLINE.

Default value is NONE.

Values may be null indicating not set.

See also

Returns the total length of text owned by this FlowElement object and its children. If an element has no text, the value of textLength is usually zero.

ParagraphElement objects have a final span with a paragraph terminator character for the last SpanElement object.The paragraph terminator is included in the value of the textLength of that SpanElement object and all its parents. It is not included in text property of the SpanElement object.

See also

CharacterFormat: Determines the amount 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.

Default value is AUTO.

Values may be null indicating not set.

See also

Sets the tracking and is synonymous with the trackingRight property. Specified as a number of pixels or a percent of fontSize .

See also

CharacterFormat: 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 -100 to 100.

Legal values as a percent are from -100% to 100%.

Default value is 0.

Values may be null indicating not set.

CharacterFormat: 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 -100 to 100.

Legal values as a percent are from -100% to 100%.

Default value is 0.

Values may be null indicating not set.

CharacterFormat: The type of typographic case used for this text. Below are some examples:

Legal values are flash.text.engine.TypographicCase.DEFAULT, flash.text.engine.TypographicCase.TITLE, flash.text.engine.TypographicCase.CAPS, flash.text.engine.TypographicCase.SMALL_CAPS, flash.text.engine.TypographicCase.UPPERCASE, flash.text.engine.TypographicCase.LOWERCASE, flash.text.engine.TypographicCase.CAPS_AND_SMALL_CAPS.

Default value is DEFAULT.

Values may be null indicating not set.

See also

CharacterFormat: The setting used to collapse or preserve whitespace when importing text into a TextFlow. PRESERVE retains all whitespace characters. When using COLLAPSE, within a block of imported text, newlines, tabs, and leading/trailing spaces will be removed. Line break tags () and Unicode line separator characters are retained.

Legal values are flashx.textLayout.formats.WhiteSpaceCollapse.PRESERVE, flashx.textLayout.formats.WhiteSpaceCollapse.COLLAPSE.

Default value is COLLAPSE.

Values may be null indicating not set.

See also

Base class - invoking new FlowElement() throws an error exception.

Makes a deep copy of the portion of a FlowElement object between two character positions, including any children, and returns it as a FlowElement object.

With no arguments, deepCopy() defaults to copying the entire element.

Parameters

See also

Returns the start location of the element in the text flow as an absolute index. The first character in the flow is position 0.

See also

package {
    import flash.display.Sprite;
    
    import flashx.textLayout.container.DisplayObjectContainerController;
    import flashx.textLayout.container.IContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.CharacterFormat;

    public class FlowElement_getAbsoluteStartExample extends Sprite
    {
        public function FlowElement_getAbsoluteStartExample()
        {
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            span1.text = "Hello, ";
            span2.text = "World!";
            p.fontSize = 48;
            p.addChild(span1);
            p.addChild(span2);
            textFlow.addChild(p);
            trace(span2.getAbsoluteStart());  // 7

            textFlow.flowComposer.addController(new DisplayObjectContainerController(this,400,200));
            textFlow.flowComposer.updateAllContainers(); 
        }
    }
}

Returns the ContainerFormattedElement that specifies its containers for filling. This ContainerFormattedElement object has its own columns and can control ColumnDirection and BlockProgression.

Returns the character at the specified position, relative to this FlowElement object. The first character is at relative position 0.

Parameters

Returns the character code at the specified position, relative to this FlowElement. The first character is at relative position 0.

Parameters

Returns the start of this element relative to an ancestor element. Assumes that the ancestor element is in the parent chain. If the ancestor element is the parent, this is the same as this.parentRelativeStart . If the ancestor element is the grandparent, this is the same as parentRelativeStart plus parent.parentRelativeStart and so on.

Parameters

Returns the next FlowElement sibling in the text flow hierarchy.

package {
    import flash.display.Sprite;
    
    import flashx.textLayout.container.DisplayObjectContainerController;
    import flashx.textLayout.container.IContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.elements.FlowElement;
    import flashx.textLayout.formats.CharacterFormat;

    public class FlowElement_getNextSiblingExample extends Sprite
    {
        public function FlowElement_getNextSiblingExample()
        {
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            var nextSpanElement:SpanElement = new SpanElement();
            span1.text = "Hello, ";
            span2.text = "World!";
            p.fontSize = 48;
            p.addChild(span1);
            p.addChild(span2);
            textFlow.addChild(p);
            nextSpanElement = SpanElement(span1.getNextSibling());
            trace(nextSpanElement.text);     // World!

            textFlow.flowComposer.addController(new DisplayObjectContainerController(this,400,200));
            textFlow.flowComposer.updateAllContainers(); 
        }
    }
}

Returns the ParagraphElement object associated with this element. It looks up the text flow hierarchy and returns the first ParagraphElement object.

Returns the previous FlowElement sibling in the text flow hierarchy.

package {
    import flash.display.Sprite;
    
    import flashx.textLayout.container.DisplayObjectContainerController;
    import flashx.textLayout.container.IContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.elements.FlowElement;
    import flashx.textLayout.formats.CharacterFormat;

    public class FlowElement_getPreviousSiblingExample extends Sprite
    {
        public function FlowElement_getPreviousSiblingExample()
        {
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            var prevSpanElement:SpanElement = new SpanElement();
            span1.text = "Hello, ";
            span2.text = "World!";
            p.fontSize = 48;
            p.addChild(span1);
            p.addChild(span2);
            textFlow.addChild(p);
            prevSpanElement = SpanElement(span2.getPreviousSibling());
            trace(prevSpanElement.text);     // Hello,

            textFlow.flowComposer.addController(new DisplayObjectContainerController(this,400,200));
            textFlow.flowComposer.updateAllContainers(); 
        }
    }
}

Climbs the text flow hierarchy to return the root TextFlow object for the element.

See also

Makes a copy of the content of this FlowElement object that occurs between two character positions. It returns the copy of the content as a new FlowElement object. Unlike deepCopy() , shallowCopy() does not copy any of the children of this FlowElement. With no arguments, shallowCopy() defaults to copying all of the content.

Parameters

See also