flashx.textLayout.elements.ParagraphFormattedElement (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
		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
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		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
		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
		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
		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
		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
		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

direction

property

direction:String [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ParagraphFormat: Specifies the default bidi 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:

direction

Legal values are flashx.textLayout.formats.Direction.LTR, flashx.textLayout.formats.Direction.RTL.

Default value is LTR.

Values may be null indicating not set.

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

See also

flashx.textLayout.formats.Direction

justificationRule

property

justificationRule:String [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ParagraphFormat: Rule used to generate paragraph justification. Default value is SPACE, meaning that extra space in justification is added to the space characters. When EAST_ASIAN is used, Japanese style leading is employed, which applies bottom-down vs top-up in Roman. Another change is in the spacing of punctuation. In the Roman version, the comma and Japanese periods take a full character's width but only half in East Asian. Additionally, the spacing between sequential punctuation marks becomes tighter, obeying traditional East Asian typographic conventions. Another item to note in the example below is the leading, 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.

justificationRule

Legal values are flashx.textLayout.formats.JustificationRule.EAST_ASIAN, flashx.textLayout.formats.JustificationRule.SPACE.

Default value is SPACE.

Values may be null indicating not set.

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

justificationStyle

property

justificationStyle:String [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ParagraphFormat: The style used for justification of the paragraph. These constants specify options for handling kinsoku characters, which are Japanese characters that cannot appear at either the beginning or end of a line. Used only in conjunction with a justificationRule of EAST_ASIAN.

Legal values are flash.text.engine.JustificationStyle.PRIORITIZE_LEAST_ADJUSTMENT, flash.text.engine.JustificationStyle.PUSH_IN_KINSOKU, flash.text.engine.JustificationStyle.PUSH_OUT_ONLY.

Default value is PUSH_IN_KINSOKU.

Values may be null indicating not set.

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

See also

flash.text.engine.JustificationStyle

leadingBasis

property

leadingBasis:String [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ParagraphFormat: Specifies the baseline to which the lineHeight property refers. The default value of AUTO is interpreted as using the ROMAN setting for Western type and the IDEOGRAPHIC TOP setting for East Asian type.

leadingBasis1 leadingBasis2 leadingBasis3

Legal values are flashx.textLayout.formats.LineOffsetBasis.ROMAN, flashx.textLayout.formats.LineOffsetBasis.ASCENT, flashx.textLayout.formats.LineOffsetBasis.DESCENT, flashx.textLayout.formats.LineOffsetBasis.IDEOGRAPHIC_TOP, flashx.textLayout.formats.LineOffsetBasis.IDEOGRAPHIC_CENTER, flashx.textLayout.formats.LineOffsetBasis.IDEOGRAPHIC_BOTTOM, flashx.textLayout.formats.LineOffsetBasis.AUTO.

Default value is AUTO.

Values may be null indicating not set.

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

leadingDirection

property

leadingDirection:String [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ParagraphFormat: Specifies the direction in which leading space is applied. This determines whether lineHeight property refers to the distance of a line's baseline from that of the line before it or the line after it. A value of AUTO means the direction is chosen based on the justificationRule property.

leadingDirection1 leadingDirection2 leadingDirection3

Legal values are flashx.textLayout.formats.LeadingDirection.UP, flashx.textLayout.formats.LeadingDirection.DOWN, flashx.textLayout.formats.LeadingDirection.AUTO.

Default value is AUTO.

Values may be null indicating not set.

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

marginBottom

property

marginBottom:Object [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ParagraphFormat: Amount of space in pixels to leave after the paragraph (a Number). Also known as spaceAfter. Collapses in tandem with marginTop.

Legal values are from 0 to 1000.

Default value is 0.

Values may be null indicating not set.

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

marginLeft

property

marginLeft:Object [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ParagraphFormat: Amount in pixels to indent the paragraph (a Number).

Legal values are from 0 to 1000.

Default value is 0.

Values may be null indicating not set.

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

marginRight

property

marginRight:Object [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ParagraphFormat: Amount in pixels to indent the right edge of the paragraph (a Number).

Legal values are from 0 to 1000.

Default value is 0.

Values may be null indicating not set.

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

marginTop

property

marginTop:Object [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ParagraphFormat: Amount of space in pixels to leave before the paragraph (a Number). Also known as spaceBefore. Collapses in tandem with marginBottom.

Legal values are from 0 to 1000.

Default value is 0.

Values may be null indicating not set.

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

paragraphFormat

property

paragraphFormat:IParagraphFormat [read-write]

ParagraphFormat 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 paragraphFormat():IParagraphFormat
public function set paragraphFormat(value:IParagraphFormat):void

paragraphFormatForCascade

property

paragraphFormatForCascade:IParagraphFormat [read-only]

Implementation
tlf_internal function get paragraphFormatForCascade():IParagraphFormat

tabStops

property

tabStops:Array [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ParagraphFormat: Specifies the tab stops associated with the paragraph. An Array of flashx.textLayout.formats.TabStopFormat. If no tab stops are specified, a tab action defaults to the end of the line.

Default value is [].

Values may be null indicating not set.

Implementation
public function set tabStops(value:Array):void

textAlign

property

textAlign:String [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ParagraphFormat: Alignment of lines in the paragraph relative to the container. LEFT will align lines along the left edge of the container. RIGHT aligns on the right edge. CENTER will position the line equidistant from the left and right edges. JUSTIFY will spread the lines out so they fill the space. START is equivalent to setting left in left-to-right text, or right in right-to-left text. 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.

Default value is START.

Values may be null indicating not set.

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

See also

flashx.textLayout.formats.TextAlign

textAlignLast

property

textAlignLast:String [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ParagraphFormat: Alignment of the last (or only) line in the paragraph relative to the container in justified text. If textAlign is set to JUSTIFY, textAlignLast specifies how the last line (or only line, if this is a one line block) will be aligned. Values are similar to textAlign .

Default value is START.

Values may be null indicating not set.

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

See also

flashx.textLayout.formats.TextAlign

textIndent

property

textIndent:Object [write-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

ParagraphFormat: Amount in pixels to indent the first line of the paragraph (a Number). A negative indent will push the line into the margin, and possibly out of the container.

Legal values are from -1000 to 1000.

Default value is 0.

Values may be null indicating not set.

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

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

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