flashx.textLayout.elements.ContainerFormattedElement (Text Layout Framework)

Public Properties

	Property		Defined By
		alignmentBaseline : String [write-only] 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.	FlowElement
		baselineShift : Object [write-only] CharacterFormat: Amount to shift the baseline from the elementBaseline.	FlowElement
		blockProgression : String [write-only] ContainerFormat: Settings for line layout.	ContainerFormattedElement
		breakOpportunity : String [write-only] CharacterFormat: Controls where lines are allowed to break when wrapping text is broken into multiple lines.	FlowElement
		cffHinting : String [write-only] CharacterFormat: The type of CFF hinting used for this text.	FlowElement
		characterFormat : ICharacterFormat CharacterFormat properties applied directly to this element.	FlowElement
		color : Object [write-only] CharacterFormat: Color of the text.	FlowElement
		columnCount : Object [write-only] ContainerFormat: Number of text columns.	ContainerFormattedElement
		columnGap : Object [write-only] ContainerFormat: Gutter space between the columns in pixels.	ContainerFormattedElement
		columnWidth : Object [write-only] ContainerFormat: Width of column in pixels.	ContainerFormattedElement
		computedContainerFormat : IContainerFormat [read-only] Returns computed values of the container attributes.	ContainerFormattedElement
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		containerFormat : IContainerFormat ContainerFormat properties applied directly to this element.	ContainerFormattedElement
		digitCase : String [write-only] CharacterFormat: The type of digit case used for this text.	FlowElement
		digitWidth : String [write-only] CharacterFormat: Type of digit width used for this text.	FlowElement
		direction : String [write-only] ParagraphFormat: Specifies the default bidi embedding level of the text in the text block.	ParagraphFormattedElement
		dominantBaseline : String [write-only] CharacterFormat: Specifies which of the baselines of the element snaps to the alignmentBaseline to determine the vertical position of the element on the line.	FlowElement
		firstBaselineOffset : Object [write-only] ContainerFormat: Position of the baseline of first line in the container (in pixels).	ContainerFormattedElement
		firstBaselineOffsetBasis : String [write-only] ContainerFormat: Specifies the baseline to which the firstBaselineOffset property refers.	ContainerFormattedElement
		fontFamily : String [write-only] CharacterFormat: The name of the font to use, or a comma-separated list of font names.	FlowElement
		fontLookup : String [write-only] CharacterFormat: Font lookup to use.	FlowElement
		fontSize : Object [write-only] CharacterFormat: The size of the text in pixels.	FlowElement
		fontStyle : String [write-only] CharacterFormat: Style of text.	FlowElement
		fontWeight : String [write-only] CharacterFormat: Weight of text.	FlowElement
		justificationRule : String [write-only] ParagraphFormat: Rule used to generate paragraph justification.	ParagraphFormattedElement
		justificationStyle : String [write-only] ParagraphFormat: The style used for justification of the paragraph.	ParagraphFormattedElement
		kerning : String [write-only] CharacterFormat: Kerning adjusts the pixels between certain character pairs to improve readability.	FlowElement
		leadingBasis : String [write-only] ParagraphFormat: Specifies the baseline to which the lineHeight property refers.	ParagraphFormattedElement
		leadingDirection : String [write-only] ParagraphFormat: Specifies the direction in which leading space is applied.	ParagraphFormattedElement
		ligatureLevel : String [write-only] CharacterFormat: Controls which of the ligatures that are defined in the font may be used in the text.	FlowElement
		lineBreak : String [write-only] ContainerFormat: Controls word wrapping within the container.	ContainerFormattedElement
		lineHeight : Object [write-only] CharacterFormat: Leading controls for the text.	FlowElement
		lineThrough : Object [write-only] CharacterFormat: Strikethrough.	FlowElement
		locale : String [write-only] CharacterFormat: The locale of the text.	FlowElement
		marginBottom : Object [write-only] ParagraphFormat: Amount of space in pixels to leave after the paragraph (a Number).	ParagraphFormattedElement
		marginLeft : Object [write-only] ParagraphFormat: Amount in pixels to indent the paragraph (a Number).	ParagraphFormattedElement
		marginRight : Object [write-only] ParagraphFormat: Amount in pixels to indent the right edge of the paragraph (a Number).	ParagraphFormattedElement
		marginTop : Object [write-only] ParagraphFormat: Amount of space in pixels to leave before the paragraph (a Number).	ParagraphFormattedElement
		numChildren : int [read-only] Returns the number of FlowElement children that this FlowGroupElement object has.	FlowGroupElement
		paddingBottom : Object [write-only] ContainerFormat: Botttom inset in pixels.	ContainerFormattedElement
		paddingLeft : Object [write-only] ContainerFormat: Left inset in pixels.	ContainerFormattedElement
		paddingRight : Object [write-only] ContainerFormat: Right inset in pixels.	ContainerFormattedElement
		paddingTop : Object [write-only] ContainerFormat: Top inset in pixels.	ContainerFormattedElement
		paragraphFormat : IParagraphFormat ParagraphFormat properties applied directly to this element.	ParagraphFormattedElement
		parent : FlowGroupElement [read-only] Returns the parent of this FlowElement object.	FlowElement
		parentRelativeEnd : int [read-only] Returns the relative end of this FlowElement object in the parent.	FlowElement
		parentRelativeStart : int [read-only] Returns the relative start of this FlowElement object in the parent.	FlowElement
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		renderingMode : String [write-only] CharacterFormat: The rendering mode used for this text.	FlowElement
		tabStops : Array [write-only] ParagraphFormat: Specifies the tab stops associated with the paragraph.	ParagraphFormattedElement
		textAlign : String [write-only] ParagraphFormat: Alignment of lines in the paragraph relative to the container.	ParagraphFormattedElement
		textAlignLast : String [write-only] ParagraphFormat: Alignment of the last (or only) line in the paragraph relative to the container in justified text.	ParagraphFormattedElement
		textAlpha : Object [write-only] CharacterFormat: Alpha (transparency) value for the text.	FlowElement
		textDecoration : String [write-only] CharacterFormat: Decoration on text.	FlowElement
		textIndent : Object [write-only] ParagraphFormat: Amount in pixels to indent the first line of the paragraph (a Number).	ParagraphFormattedElement
		textLength : int [read-only] Returns the total length of text owned by this FlowElement object and its children.	FlowElement
		textRotation : String [write-only] CharacterFormat: Determines the amount of degrees to rotate this text.	FlowElement
		tracking : Object [write-only] Sets the tracking and is synonymous with the trackingRight property.	FlowElement
		trackingLeft : Object [write-only] 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.	FlowElement
		trackingRight : Object [write-only] 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.	FlowElement
		typographicCase : String [write-only] CharacterFormat: The type of typographic case used for this text.	FlowElement
		verticalAlign : String [write-only] ContainerFormat: Vertical alignment or justification.	ContainerFormattedElement
		whiteSpaceCollapse : String [write-only] CharacterFormat: The setting used to collapse or preserve whitespace when importing text into a TextFlow.	FlowElement

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addChild(child:FlowElement):void Appends a child FlowElement object.	FlowGroupElement
		addChildAt(index:uint, child:FlowElement):void Adds a child FlowElement object at the specified index position.	FlowGroupElement
		deepCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement 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.	FlowElement
		findChildIndexAtPosition(relativePosition:int):int Given a relative text position, find the index of the first child FlowElement that contains relative position.	FlowGroupElement
		findLeaf(relativePosition:int):FlowLeafElement Given a relative text position, find the leaf element that contains the position.	FlowGroupElement
		getAbsoluteStart():int Returns the start location of the element in the text flow as an absolute index.	FlowElement
		getAncestorWithContainer():ContainerFormattedElement Returns the ContainerFormattedElement that specifies its containers for filling.	FlowElement
		getCharAtPosition(relativePos:int):String Returns the character at the specified position, relative to this FlowElement object.	FlowElement
		getCharCodeAtPosition(relativePos:int):int Returns the character code at the specified position, relative to this FlowElement.	FlowElement
		getChildAtIndex(i:int):FlowElement Returns the FlowElement child at the specified index.	FlowGroupElement
		getChildIndex(child:FlowElement):int Searches in children for the specified FlowElement object and returns its index position.	FlowGroupElement
		getComputedColumnDirection():String Return the effective column direction for this element.	ContainerFormattedElement
		getElementRelativeStart(ancestorElement:FlowElement):int Returns the start of this element relative to an ancestor element.	FlowElement
		getFirstLeaf():FlowLeafElement Returns the first FlowLeafElement descendant of this element.	FlowGroupElement
		getLastLeaf():FlowLeafElement Returns the last FlowLeafElement descendent of this element.	FlowGroupElement
		getNextSibling():FlowElement Returns the next FlowElement sibling in the text flow hierarchy.	FlowElement
		getParagraph():ParagraphElement Returns the ParagraphElement object associated with this element.	FlowElement
		getPreviousSibling():FlowElement Returns the previous FlowElement sibling in the text flow hierarchy.	FlowElement
		getTextFlow():TextFlow Climbs the text flow hierarchy to return the root TextFlow object for the element.	FlowElement
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeChild(child:FlowElement):void Removes the specified child FlowElement object.	FlowGroupElement
		removeChildAt(index:uint):void Removes a child FlowElement object at the specified index position.	FlowGroupElement
		replaceChildren(beginChildIndex:int, endChildIndex:int, ... rest):void Replaces child elements in the group with the specified new elements.	FlowGroupElement
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		shallowCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement Makes a copy of the content of this FlowElement object that occurs between two character positions.	FlowElement
		splitAtIndex(childIndex:int):FlowGroupElement Splits this object at the position specified by the childIndex parameter.	FlowGroupElement
		splitAtPosition(relativePosition:int):FlowGroupElement Splits this object at the position specified by the relativePosition parameter, where the relative position is a relative text position in this element.	FlowGroupElement
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

blockProgression

property

blockProgression:String [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ContainerFormat: Settings for line layout. Controls placement of lines. Lines are either placed top-to-bottom (TB, used for horizontal text) or right-to-left (RL, used for vertical text).

Legal values are flashx.textLayout.formats.BlockProgression.RL, flashx.textLayout.formats.BlockProgression.TB.

Default value is TB.

Values may be null indicating not set.

Implementation
public function set blockProgression(value:String):void

columnCount

property

columnCount:Object [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ContainerFormat: Number of text columns. The column number overrides the other column settings. Value is an Integer, or AUTO if unspecified. If columnCount is not specified, columnWidth is used to create as many columns as can fit in the container.

Legal values as a string are flashx.textLayout.formats.FormatValue.AUTO and from 1 to 50.

Default value is AUTO.

Values may be null indicating not set.

Implementation
public function set columnCount(value:Object):void

See also

flashx.textLayout.formats.FormatValue

columnGap

property

columnGap:Object [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ContainerFormat: Gutter space between the columns in pixels. Amount of space to leave between columns. Value is a Number

Legal values are from 0 to 1000.

Default value is 0.

Values may be null indicating not set.

Implementation
public function set columnGap(value:Object):void

columnWidth

property

columnWidth:Object [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ContainerFormat: Width of column in pixels. If you specify the width of the columns, but not the count, TextLayout will create as many columns of that width as possible given the the container width and columnGap settings. Any remainder space is left after the last column. Value is a Number.

Legal values as a string are flashx.textLayout.formats.FormatValue.AUTO and from 0 to 8000.

Default value is AUTO.

Values may be null indicating not set.

Implementation
public function set columnWidth(value:Object):void

See also

flashx.textLayout.formats.FormatValue

computedContainerFormat

property

computedContainerFormat:IContainerFormat [read-only]

Returns computed values of the container attributes. Returns the values of each container attribute, as applied for this container. Values are cascaded down the FlowElement hierarchy from the root. At any element, attributes may be overridden with local settings. Any attributes that are unset, will have values supplied from the default container settings.

Implementation
public function get computedContainerFormat():IContainerFormat

containerFormat

property

containerFormat:IContainerFormat [read-write]

ContainerFormat 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.

Implementation
public function get containerFormat():IContainerFormat
public function set containerFormat(value:IContainerFormat):void

firstBaselineOffset

property

firstBaselineOffset:Object [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ContainerFormat: Position of the baseline of first line in the container (in pixels). The offset from the top inset (or right inset if blockProgression is RL) of the container to the baseline of the first line can be either ASCENT, meaning equal to the ascent of the line, LINE_HEIGHT, equal to the height of that first line, or any fixed value number to specify an absolute distance. AUTO aligns the ascent of the line with the container top inset.

firstBaselineOffset1 firstBaselineOffset2 firstBaselineOffset3 firstBaselineOffset4

Legal values as a string are flashx.textLayout.formats.BaselineOffset.AUTO, flashx.textLayout.formats.BaselineOffset.ASCENT, flashx.textLayout.formats.BaselineOffset.LINE_HEIGHT and from 0 to 1000.

Default value is AUTO.

Values may be null indicating not set.

Implementation
public function set firstBaselineOffset(value:Object):void

firstBaselineOffsetBasis

property

firstBaselineOffsetBasis:String [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ContainerFormat: Specifies the baseline to which the firstBaselineOffset property refers. This property is ignored when firstBaselineOffset is AUTO.

firstBaselineOffsetBasis1 firstBaselineOffsetBasis2 firstBaselineOffsetBasis3 firstBaselineOffsetBasis4

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.

Implementation
public function set firstBaselineOffsetBasis(value:String):void

See also

flash.text.engine.TextBaseline

lineBreak

property

lineBreak:String [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ContainerFormat: Controls word wrapping within the container. Text in the container may be set to fit the width of the container (TO_FIT), or can be set to break only at explicit return/line feeds (EXPLICIT).

Legal values are flashx.textLayout.formats.LineBreak.EXPLICIT, flashx.textLayout.formats.LineBreak.TO_FIT.

Default value is TO_FIT.

Values may be null indicating not set.

Implementation
public function set lineBreak(value:String):void

See also

flashx.textLayout.formats.LineBreak

paddingBottom

property

paddingBottom:Object [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ContainerFormat: Botttom inset in pixels. Space between the bottom edge of the container and the text. Value is a Number.

Legal values are from 0 to 1000.

Default value is 0.

Values may be null indicating not set.

Implementation
public function set paddingBottom(value:Object):void

paddingLeft

property

paddingLeft:Object [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ContainerFormat: Left inset in pixels. Space between the left edge of the container and the text. Value is a Number.

Legal values are from 0 to 1000.

Default value is 0.

Values may be null indicating not set.

Implementation
public function set paddingLeft(value:Object):void

paddingRight

property

paddingRight:Object [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ContainerFormat: Right inset in pixels. Space between the right edge of the container and the text. Value is a Number.

Legal values are from 0 to 1000.

Default value is 0.

Values may be null indicating not set.

Implementation
public function set paddingRight(value:Object):void

paddingTop

property

paddingTop:Object [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ContainerFormat: Top inset in pixels. Space between the top edge of the container and the text. Value is a Number.

Legal values are from 0 to 1000.

Default value is 0.

Values may be null indicating not set.

Implementation
public function set paddingTop(value:Object):void

verticalAlign

property

verticalAlign:String [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ContainerFormat: Vertical alignment or justification. Determines how TextFlow elements align within the container.

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

Default value is TOP.

Values may be null indicating not set.

Implementation
public function set verticalAlign(value:String):void

See also

flashx.textLayout.formats.VerticalAlign

Method Detail

getComputedColumnDirection

()

method

public function getComputedColumnDirection():String

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Return the effective column direction for this element. The possible directions are right-to-left or left-to-right.Left-to-right is the default setting, and is used for most languages. Right-to-left is used for Middle Eastern languages such as Arabic and Hebrew. When applied to a container, direction controls the column direction and paragraphs in the container inherit the direction attribute.

The Direction class defines constants for specify the direction strings.

Returns

String

See also

flashx.textLayout.formats.Direction

Current page: http://livedocs.adobe.com/labs/textlayout/flashx/textLayout/elements/ContainerFormattedElement.html

Package	flashx.textLayout.elements
Class	public class ContainerFormattedElement
Inheritance	ContainerFormattedElement ParagraphFormattedElement FlowGroupElement FlowElement Object
Subclasses	DivElement, TextFlow