ContainerFormattedElement

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

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ContainerFormattedElement is the root class for all container-level block elements, such as DivElement and TextFlow objects. Container-level block elements are grouping elements for other FlowElement objects.

Default MXML PropertymxmlChildren

Related API Elements

DivElement
TextFlow

Public Properties

	Property		Defined By
		alignmentBaseline : * TextLayoutFormat: Specifies the baseline to which the dominant baseline aligns.	FlowElement
		backgroundAlpha : * TextLayoutFormat: Alpha (transparency) value for the background (adopts default value if undefined during cascade).	FlowElement
		backgroundColor : * TextLayoutFormat: Background color of the text (adopts default value if undefined during cascade).	FlowElement
		baselineShift : * TextLayoutFormat: Amount to shift the baseline from the dominantBaseline value.	FlowElement
		blockProgression : * TextLayoutFormat: Specifies a vertical or horizontal progression of line placement.	FlowElement
		breakOpportunity : * TextLayoutFormat: Controls where lines are allowed to break when breaking wrapping text into multiple lines.	FlowElement
		cffHinting : * TextLayoutFormat: The type of CFF hinting used for this text.	FlowElement
		clearFloats : * TextLayoutFormat: Controls how text wraps around a float.	FlowElement
		color : * TextLayoutFormat: Color of the text.	FlowElement
		columnCount : * TextLayoutFormat: Number of text columns (adopts default value if undefined during cascade).	FlowElement
		columnGap : * TextLayoutFormat: Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade).	FlowElement
		columnWidth : * TextLayoutFormat: Column width in pixels (adopts default value if undefined during cascade).	FlowElement
		computedFormat : flashx.textLayout.formats:ITextLayoutFormat [read-only] Returns the computed format attributes that are in effect for this element.	FlowElement
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		coreStyles : Object [read-only] Returns the coreStyles on this FlowElement.	FlowElement
		digitCase : * TextLayoutFormat: The type of digit case used for this text.	FlowElement
		digitWidth : * TextLayoutFormat: Type of digit width used for this text.	FlowElement
		direction : * TextLayoutFormat: Specifies the default bidirectional embedding level of the text in the text block.	FlowElement
		dominantBaseline : * TextLayoutFormat: Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.	FlowElement
		firstBaselineOffset : * TextLayoutFormat: Specifies the baseline position of the first line in the container.	FlowElement
		fontFamily : * TextLayoutFormat: The name of the font to use, or a comma-separated list of font names.	FlowElement
		fontLookup : * TextLayoutFormat: Font lookup to use.	FlowElement
		fontSize : * TextLayoutFormat: The size of the text in pixels.	FlowElement
		fontStyle : * TextLayoutFormat: Style of text.	FlowElement
		fontWeight : * TextLayoutFormat: Weight of text.	FlowElement
		format : flashx.textLayout.formats:ITextLayoutFormat TextLayoutFormat properties applied directly to this element.	FlowElement
		id : String Assigns an identifying name to the element, making it possible to set a style for the element by referencing the id.	FlowElement
		justificationRule : * TextLayoutFormat: Rule used to justify text in a paragraph.	FlowElement
		justificationStyle : * TextLayoutFormat: The style used for justification of the paragraph.	FlowElement
		kerning : * TextLayoutFormat: Kerning adjusts the pixels between certain character pairs to improve readability.	FlowElement
		leadingModel : * TextLayoutFormat: Specifies the leading model, which is a combination of leading basis and leading direction.	FlowElement
		ligatureLevel : * TextLayoutFormat: Controls which of the ligatures that are defined in the font may be used in the text.	FlowElement
		lineBreak : * TextLayoutFormat: Controls word wrapping within the container (adopts default value if undefined during cascade).	FlowElement
		lineHeight : * TextLayoutFormat: Leading controls for the text.	FlowElement
		lineThrough : * TextLayoutFormat: If true, applies strikethrough, a line drawn through the middle of the text.	FlowElement
		linkActiveFormat : * TextLayoutFormat: Defines the formatting attributes used for links in normal state.	FlowElement
		linkHoverFormat : * TextLayoutFormat: Defines the formatting attributes used for links in hover state, when the mouse is within the bounds (rolling over) a link.	FlowElement
		linkNormalFormat : * TextLayoutFormat: Defines the formatting attributes used for links in normal state.	FlowElement
		listAutoPadding : * TextLayoutFormat: This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto.	FlowElement
		listMarkerFormat : * TextLayoutFormat: Defines the formatting attributes list markers.	FlowElement
		listStylePosition : * TextLayoutFormat: Legal values are ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor.	FlowElement
		listStyleType : * TextLayoutFormat: Legal values are ListStyleType.UPPER_ALPHA, ListStyleType.LOWER_ALPHA, ListStyleType.UPPER_ROMAN, ListStyleType.LOWER_ROMAN, ListStyleType.NONE, ListStyleType.DISC, ListStyleType.CIRCLE, ListStyleType.SQUARE, ListStyleType.BOX, ListStyleType.CHECK, ListStyleType.DIAMOND, ListStyleType.HYPHEN, ListStyleType.ARABIC_INDIC, ListStyleType.BENGALI, ListStyleType.DECIMAL, ListStyleType.DECIMAL_LEADING_ZERO, ListStyleType.DEVANAGARI, ListStyleType.GUJARATI, ListStyleType.GURMUKHI, ListStyleType.KANNADA, ListStyleType.PERSIAN, ListStyleType.THAI, ListStyleType.URDU, ListStyleType.CJK_EARTHLY_BRANCH, ListStyleType.CJK_HEAVENLY_STEM, ListStyleType.HANGUL, ListStyleType.HANGUL_CONSTANT, ListStyleType.HIRAGANA, ListStyleType.HIRAGANA_IROHA, ListStyleType.KATAKANA, ListStyleType.KATAKANA_IROHA, ListStyleType.LOWER_ALPHA, ListStyleType.LOWER_GREEK, ListStyleType.LOWER_LATIN, ListStyleType.UPPER_ALPHA, ListStyleType.UPPER_GREEK, ListStyleType.UPPER_LATIN, FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor.	FlowElement
		locale : * TextLayoutFormat: The locale of the text.	FlowElement
		mxmlChildren : Array Appends an array of children to this object.	FlowGroupElement
		numChildren : int [read-only] Returns the number of FlowElement children that this FlowGroupElement object has.	FlowGroupElement
		paddingBottom : * TextLayoutFormat: Bottom inset in pixels.	FlowElement
		paddingLeft : * TextLayoutFormat: Left inset in pixels.	FlowElement
		paddingRight : * TextLayoutFormat: Right inset in pixels.	FlowElement
		paddingTop : * TextLayoutFormat: Top inset in pixels.	FlowElement
		paragraphEndIndent : * TextLayoutFormat: A Number that specifies, in pixels, the amount to indent the paragraph's end edge.	FlowElement
		paragraphSpaceAfter : * TextLayoutFormat: A Number that specifies the amount of space, in pixels, to leave after the paragraph.	FlowElement
		paragraphSpaceBefore : * TextLayoutFormat: A Number that specifies the amount of space, in pixels, to leave before the paragraph.	FlowElement
		paragraphStartIndent : * TextLayoutFormat: A Number that specifies, in pixels, the amount to indent the paragraph's start edge.	FlowElement
		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
		renderingMode : * TextLayoutFormat: The rendering mode used for this text.	FlowElement
		styleName : * TextLayoutFormat: Assigns an identifying class to the element, making it possible to set a style for the element by referencing the styleName.	FlowElement
		styles : Object [read-only] Returns the styles on this FlowElement.	FlowElement
		tabStops : * TextLayoutFormat: Specifies the tab stops associated with the paragraph.	FlowElement
		textAlign : * TextLayoutFormat: Alignment of lines in the paragraph relative to the container.	FlowElement
		textAlignLast : * TextLayoutFormat: Alignment of the last (or only) line in the paragraph relative to the container in justified text.	FlowElement
		textAlpha : * TextLayoutFormat: Alpha (transparency) value for the text.	FlowElement
		textDecoration : * TextLayoutFormat: Decoration on text.	FlowElement
		textIndent : * TextLayoutFormat: A Number that specifies, in pixels, the amount to indent the first line of the paragraph.	FlowElement
		textJustify : * TextLayoutFormat: Specifies options for justifying text.	FlowElement
		textLength : int [read-only] Returns the total length of text owned by this FlowElement object and its children.	FlowElement
		textRotation : * TextLayoutFormat: Determines the number of degrees to rotate this text.	FlowElement
		tracking : Object [write-only] Sets the tracking and is synonymous with the trackingRight property.	FlowElement
		trackingLeft : * 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.	FlowElement
		trackingRight : * 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.	FlowElement
		typeName : String Each FlowElement has a typeName.	FlowElement
		typographicCase : * TextLayoutFormat: The type of typographic case used for this text.	FlowElement
		userStyles : Object Allows you to read and write user styles on a FlowElement object.	FlowElement
		verticalAlign : * TextLayoutFormat: Vertical alignment or justification (adopts default value if undefined during cascade).	FlowElement
		whiteSpaceCollapse : * TextLayoutFormat: Collapses or preserves whitespace when importing text into a TextFlow.	FlowElement
		wordSpacing : * TextLayoutFormat: Specifies the optimum, minimum, and maximum spacing (as a multiplier of the width of a normal space) between words to use during justification.	FlowElement

Public Methods

	Method		Defined By
		addChild(child:FlowElement):FlowElement Appends a child FlowElement object.	FlowGroupElement
		addChildAt(index:uint, child:FlowElement):FlowElement Adds a child FlowElement object at the specified index position.	FlowGroupElement
		clearStyle(styleProp:String):void Clears the style specified by the styleProp parameter from this FlowElement object.	FlowElement
		deepCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement Makes a deep copy of this FlowElement object, including any children, copying the content between the two specified character positions and returning the copy as a FlowElement object.	FlowElement
		equalUserStyles(otherElement:FlowElement):Boolean Compare the userStyles of this with otherElement's userStyles.	FlowElement
		findChildIndexAtPosition(relativePosition:int):int Given a relative text position, find the index of the first child FlowElement that contains the 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
		getCharAtPosition(relativePosition:int):String Returns the character at the specified position, relative to this FlowElement object.	FlowElement
		getCharCodeAtPosition(relativePosition:int):int Returns the character code at the specified position, relative to this FlowElement.	FlowElement
		getChildAt(index: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
		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 group.	FlowGroupElement
		getLastLeaf():FlowLeafElement Returns the last FlowLeafElement descendent of this group.	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
		getStyle(styleProp:String):* Returns the value of the style specified by the styleProp parameter, which specifies the style name and can include any user style name.	FlowElement
		getText(relativeStart:int = 0, relativeEnd:int = -1, paragraphSeparator:String = " "):String [override]	FlowGroupElement
		getTextFlow():flashx.textLayout.elements: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
		initialized(document:Object, id:String):void Called for MXML objects after the implementing object has been created and all component properties specified on the MXML tag have been initialized.	FlowElement
		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):FlowElement Removes the specified child FlowElement object from the group.	FlowGroupElement
		removeChildAt(index:uint):FlowElement Removes the 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
		setStyle(styleProp:String, newValue:*):void Sets the style specified by the styleProp parameter to the value specified by the newValue parameter.	FlowElement
		shallowCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement Makes a copy of this FlowElement object, copying the content between two specified character positions.	FlowElement
		splitAtIndex(childIndex:int):FlowGroupElement Splits this object at the position specified by the childIndex parameter.	FlowGroupElement
		splitAtPosition(relativePosition:int):FlowElement Splits this FlowElement object at the position specified by the relativePosition parameter, which is a relative position in the text for this element.	FlowElement
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Legal Notices | Online Privacy Policy

ContainerFormattedElement - AS3

Classes x