Packageflashx.textLayout.elements
Classpublic final class ParagraphElement
InheritanceParagraphElement Inheritance ParagraphFormattedElement Inheritance FlowGroupElement Inheritance FlowElement Inheritance Object

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

The ParagraphElement class represents a paragraph in the text flow hierarchy. Its parent is a ParagraphFormattedElement, and its children can include spans (SpanElement), images (inLineGraphicElement), links (LinkElement) and TCY (Tatechuuyoko - ta-tae-chu-yo-ko) elements (TCYElement). The paragraph text is stored in one or more SpanElement objects, which define ranges of text that share the same attributes. A TCYElement object defines a small run of Japanese text that runs perpendicular to the line, as in a horizontal run of text in a vertical line. A TCYElement can also contain multiple spans.

Default MXML PropertymxmlChildren

See also

InlineGraphicElement
LinkElement
SpanElement
TCYElement
TextFlow


Public Properties
 PropertyDefined By
 InheritedalignmentBaseline : *
TextLayoutFormat: Specifies the baseline to which the dominant baseline aligns.
FlowElement
 InheritedbackgroundAlpha : *
TextLayoutFormat: Alpha (transparency) value for the background (adopts default value if undefined during cascade).
FlowElement
 InheritedbackgroundColor : *
TextLayoutFormat: Background color of the text (adopts default value if undefined during cascade).
FlowElement
 InheritedbaselineShift : *
TextLayoutFormat: Amount to shift the baseline from the dominantBaseline value.
FlowElement
 InheritedblockProgression : *
TextLayoutFormat: Specifies a vertical or horizontal progression of line placement.
FlowElement
 InheritedborderBottomColor : *
TextLayoutFormat: Color of the bottom border (adopts default value if undefined during cascade).
FlowElement
 InheritedborderBottomPriority : *
TextLayoutFormat: Specifies the priority when drawing cell boundaries.
FlowElement
 InheritedborderBottomWidth : *
TextLayoutFormat: Bottom border width in pixels (adopts default value if undefined during cascade) Legal values are numbers from 0 to 128 and FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will have a value of 0.
FlowElement
 InheritedborderLeftColor : *
TextLayoutFormat: Color of the left border (adopts default value if undefined during cascade).
FlowElement
 InheritedborderLeftPriority : *
TextLayoutFormat: Specifies the priority when drawing cell boundaries.
FlowElement
 InheritedborderLeftWidth : *
TextLayoutFormat: Left border width in pixels (adopts default value if undefined during cascade) Legal values are numbers from 0 to 128 and FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will have a value of 0.
FlowElement
 InheritedborderRightColor : *
TextLayoutFormat: Color of the right border (adopts default value if undefined during cascade).
FlowElement
 InheritedborderRightPriority : *
TextLayoutFormat: Specifies the priority when drawing cell boundaries.
FlowElement
 InheritedborderRightWidth : *
TextLayoutFormat: Right border width in pixels (adopts default value if undefined during cascade) Legal values are numbers from 0 to 128 and FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will have a value of 0.
FlowElement
 InheritedborderTopColor : *
TextLayoutFormat: Color of the top border (adopts default value if undefined during cascade).
FlowElement
 InheritedborderTopPriority : *
TextLayoutFormat: Specifies the priority when drawing cell boundaries.
FlowElement
 InheritedborderTopWidth : *
TextLayoutFormat: Top border width in pixels (adopts default value if undefined during cascade) Legal values are numbers from 0 to 128 and FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will have a value of 0.
FlowElement
 InheritedbreakOpportunity : *
TextLayoutFormat: Controls where lines are allowed to break when breaking wrapping text into multiple lines.
FlowElement
 InheritedcellPadding : *
TextLayoutFormat: cellPadding specifies the amount of space between the border of the cell and its contents.
FlowElement
 InheritedcellSpacing : *
TextLayoutFormat: cellSpacing specifies how much space the user agent should leave between the left side of the table and the left-hand side of the leftmost column, the top of the table and the top side of the topmost row, and so on for the right and bottom of the table.
FlowElement
 InheritedcffHinting : *
TextLayoutFormat: The type of CFF hinting used for this text.
FlowElement
 InheritedclearFloats : *
TextLayoutFormat: Controls how text wraps around a float.
FlowElement
 Inheritedcolor : *
TextLayoutFormat: Color of the text.
FlowElement
 InheritedcolumnBreakAfter : *
TextLayoutFormat: Controls column after before the element.
FlowElement
 InheritedcolumnBreakBefore : *
TextLayoutFormat: Controls column break before the element.
FlowElement
 InheritedcolumnCount : *
TextLayoutFormat: Number of text columns (adopts default value if undefined during cascade).
FlowElement
 InheritedcolumnGap : *
TextLayoutFormat: Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade).
FlowElement
 InheritedcolumnWidth : *
TextLayoutFormat: Column width in pixels (adopts default value if undefined during cascade).
FlowElement
 InheritedcomputedFormat : ITextLayoutFormat
[read-only] Returns the computed format attributes that are in effect for this element.
FlowElement
 InheritedcontainerBreakAfter : *
TextLayoutFormat: Controls container after before the element.
FlowElement
 InheritedcontainerBreakBefore : *
TextLayoutFormat: Controls container break before the element.
FlowElement
 InheritedcoreStyles : Object
[read-only] Returns the coreStyles on this FlowElement.
FlowElement
 InheriteddigitCase : *
TextLayoutFormat: The type of digit case used for this text.
FlowElement
 InheriteddigitWidth : *
TextLayoutFormat: Type of digit width used for this text.
FlowElement
 Inheriteddirection : *
TextLayoutFormat: Specifies the default bidirectional embedding level of the text in the text block.
FlowElement
 InheriteddominantBaseline : *
TextLayoutFormat: Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.
FlowElement
 InheritedfirstBaselineOffset : *
TextLayoutFormat: Specifies the baseline position of the first line in the container.
FlowElement
 InheritedfontFamily : *
TextLayoutFormat: The name of the font to use, or a comma-separated list of font names.
FlowElement
 InheritedfontLookup : *
TextLayoutFormat: Font lookup to use.
FlowElement
 InheritedfontSize : *
TextLayoutFormat: The size of the text in pixels.
FlowElement
 InheritedfontStyle : *
TextLayoutFormat: Style of text.
FlowElement
 InheritedfontWeight : *
TextLayoutFormat: Weight of text.
FlowElement
 Inheritedformat : ITextLayoutFormat
TextLayoutFormat properties applied directly to this element.
FlowElement
 Inheritedframe : *
TextLayoutFormat: frame specifies which sides of the frame surrounding a table will be visible.
FlowElement
 Inheritedid : String
Assigns an identifying name to the element, making it possible to set a style for the element by referencing the id.
FlowElement
 InheritedjustificationRule : *
TextLayoutFormat: Rule used to justify text in a paragraph.
FlowElement
 InheritedjustificationStyle : *
TextLayoutFormat: The style used for justification of the paragraph.
FlowElement
 Inheritedkerning : *
TextLayoutFormat: Kerning adjusts the pixels between certain character pairs to improve readability.
FlowElement
 InheritedleadingModel : *
TextLayoutFormat: Specifies the leading model, which is a combination of leading basis and leading direction.
FlowElement
 InheritedligatureLevel : *
TextLayoutFormat: Controls which of the ligatures that are defined in the font may be used in the text.
FlowElement
 InheritedlineBreak : *
TextLayoutFormat: Controls word wrapping within the container (adopts default value if undefined during cascade).
FlowElement
 InheritedlineHeight : *
TextLayoutFormat: Leading controls for the text.
FlowElement
 InheritedlineThrough : *
TextLayoutFormat: If true, applies strikethrough, a line drawn through the middle of the text.
FlowElement
 InheritedlinkActiveFormat : *
TextLayoutFormat: Defines the formatting attributes used for links in normal state.
FlowElement
 InheritedlinkHoverFormat : *
TextLayoutFormat: Defines the formatting attributes used for links in hover state, when the mouse is within the bounds (rolling over) a link.
FlowElement
 InheritedlinkNormalFormat : *
TextLayoutFormat: Defines the formatting attributes used for links in normal state.
FlowElement
 InheritedlistAutoPadding : *
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
 InheritedlistMarkerFormat : *
TextLayoutFormat: Defines the formatting attributes list markers.
FlowElement
 InheritedlistStylePosition : *
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
 InheritedlistStyleType : *
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
 Inheritedlocale : *
TextLayoutFormat: The locale of the text.
FlowElement
 InheritedmarginBottom : *
TextLayoutFormat: bottom margin in pixels (adopts default value if undefined during cascade).
FlowElement
 InheritedmarginLeft : *
TextLayoutFormat: left margin in pixels(adopts default value if undefined during cascade).
FlowElement
 InheritedmarginRight : *
TextLayoutFormat: right margin in pixels (adopts default value if undefined during cascade).
FlowElement
 InheritedmarginTop : *
TextLayoutFormat: top margin in pixels (adopts default value if undefined during cascade).
FlowElement
 InheritedmaxCellHeight : *
TextLayoutFormat: Maximum height of a table cell.
FlowElement
 InheritedminCellHeight : *
TextLayoutFormat: Minimum height of a table cell.
FlowElement
 InheritedmxmlChildren : Array
Appends an array of children to this object.
FlowGroupElement
 InheritednumChildren : int
[read-only] Returns the number of FlowElement children that this FlowGroupElement object has.
FlowGroupElement
 InheritedpaddingBottom : *
TextLayoutFormat: Bottom inset in pixels.
FlowElement
 InheritedpaddingLeft : *
TextLayoutFormat: Left inset in pixels.
FlowElement
 InheritedpaddingRight : *
TextLayoutFormat: Right inset in pixels.
FlowElement
 InheritedpaddingTop : *
TextLayoutFormat: Top inset in pixels.
FlowElement
 InheritedparagraphEndIndent : *
TextLayoutFormat: A Number that specifies, in pixels, the amount to indent the paragraph's end edge.
FlowElement
 InheritedparagraphSpaceAfter : *
TextLayoutFormat: A Number that specifies the amount of space, in pixels, to leave after the paragraph.
FlowElement
 InheritedparagraphSpaceBefore : *
TextLayoutFormat: A Number that specifies the amount of space, in pixels, to leave before the paragraph.
FlowElement
 InheritedparagraphStartIndent : *
TextLayoutFormat: A Number that specifies, in pixels, the amount to indent the paragraph's start edge.
FlowElement
 Inheritedparent : FlowGroupElement
[read-only] Returns the parent of this FlowElement object.
FlowElement
 InheritedparentRelativeEnd : int
[read-only] Returns the relative end of this FlowElement object in the parent.
FlowElement
 InheritedparentRelativeStart : int
[read-only] Returns the relative start of this FlowElement object in the parent.
FlowElement
 InheritedrenderingMode : *
TextLayoutFormat: The rendering mode used for this text.
FlowElement
 Inheritedrules : *
TextLayoutFormat: rules specifies which rules will appear between cells within a table.
FlowElement
 InheritedstyleName : *
TextLayoutFormat: Assigns an identifying class to the element, making it possible to set a style for the element by referencing the styleName.
FlowElement
 Inheritedstyles : Object
[read-only] Returns the styles on this FlowElement.
FlowElement
 InheritedtableColumnWidth : *
TextLayoutFormat: Width of table column specifies a default width for each column spanned by the current COL element.
FlowElement
 InheritedtableWidth : *
TextLayoutFormat: Width of table element specifies the desired width of the entire table and is intended for visual user agents.
FlowElement
 InheritedtabStops : *
TextLayoutFormat: Specifies the tab stops associated with the paragraph.
FlowElement
 InheritedtextAlign : *
TextLayoutFormat: Alignment of lines in the paragraph relative to the container.
FlowElement
 InheritedtextAlignLast : *
TextLayoutFormat: Alignment of the last (or only) line in the paragraph relative to the container in justified text.
FlowElement
 InheritedtextAlpha : *
TextLayoutFormat: Alpha (transparency) value for the text.
FlowElement
 InheritedtextDecoration : *
TextLayoutFormat: Decoration on text.
FlowElement
 InheritedtextIndent : *
TextLayoutFormat: A Number that specifies, in pixels, the amount to indent the first line of the paragraph.
FlowElement
 InheritedtextJustify : *
TextLayoutFormat: Specifies options for justifying text.
FlowElement
 InheritedtextLength : int
[read-only] Returns the total length of text owned by this FlowElement object and its children.
FlowElement
 InheritedtextRotation : *
TextLayoutFormat: Determines the number of degrees to rotate this text.
FlowElement
 Inheritedtracking : Object
[write-only] Sets the tracking and is synonymous with the trackingRight property.
FlowElement
 InheritedtrackingLeft : *
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
 InheritedtrackingRight : *
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
 InheritedtypeName : String
Each FlowElement has a typeName.
FlowElement
 InheritedtypographicCase : *
TextLayoutFormat: The type of typographic case used for this text.
FlowElement
 InheriteduserStyles : Object
Allows you to read and write user styles on a FlowElement object.
FlowElement
 InheritedverticalAlign : *
TextLayoutFormat: Vertical alignment or justification (adopts default value if undefined during cascade).
FlowElement
 InheritedwhiteSpaceCollapse : *
TextLayoutFormat: Collapses or preserves whitespace when importing text into a TextFlow.
FlowElement
 InheritedwordSpacing : *
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
 MethodDefined By
  
Constructor - represents a paragraph in a text flow.
ParagraphElement
 Inherited
Appends a child FlowElement object.
FlowGroupElement
 Inherited
Adds a child FlowElement object at the specified index position.
FlowGroupElement
 Inherited
clearStyle(styleProp:String):void
Clears the style specified by the styleProp parameter from this FlowElement object.
FlowElement
 Inherited
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
 Inherited
equalUserStyles(otherElement:FlowElement):Boolean
Compare the userStyles of this with otherElement's userStyles.
FlowElement
 Inherited
findChildIndexAtPosition(relativePosition:int):int
Given a relative text position, find the index of the first child FlowElement that contains the relative position.
FlowGroupElement
 Inherited
findLeaf(relativePosition:int):FlowLeafElement
Given a relative text position, find the leaf element that contains the position.
FlowGroupElement
  
findNextAtomBoundary(relativePosition:int):int
Scans ahead from the supplied position to find the location in the text of the next atom and returns the index.
ParagraphElement
  
findNextWordBoundary(relativePosition:int):int
Returns the index of the next word boundary in the text.
ParagraphElement
  
findPreviousAtomBoundary(relativePosition:int):int
Scans backward from the supplied position to find the location in the text of the previous atom and returns the index.
ParagraphElement
  
findPreviousWordBoundary(relativePosition:int):int
Returns the index of the previous word boundary in the text.
ParagraphElement
 Inherited
Returns the start location of the element in the text flow as an absolute index.
FlowElement
 Inherited
getCharAtPosition(relativePosition:int):String
Returns the character at the specified position, relative to this FlowElement object.
FlowElement
 Inherited
getCharCodeAtPosition(relativePosition:int):int
Returns the character code at the specified position, relative to this FlowElement.
FlowElement
 Inherited
Returns the FlowElement child at the specified index.
FlowGroupElement
 Inherited
Searches in children for the specified FlowElement object and returns its index position.
FlowGroupElement
 Inherited
Returns the start of this element relative to an ancestor element.
FlowElement
 Inherited
Returns the first FlowLeafElement descendant of this group.
FlowGroupElement
 Inherited
Returns the last FlowLeafElement descendent of this group.
FlowGroupElement
  
Returns the paragraph that follows this one, or null if there are no more paragraphs.
ParagraphElement
 Inherited
Returns the next FlowElement sibling in the text flow hierarchy.
FlowElement
 Inherited
Returns the ParagraphElement object associated with this element.
FlowElement
 Inherited
FlowElement
  
Returns the paragraph that precedes this one, or null, if this paragraph is the first one in the TextFlow.
ParagraphElement
 Inherited
Returns the previous FlowElement sibling in the text flow hierarchy.
FlowElement
 Inherited
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
 Inherited
getText(relativeStart:int = 0, relativeEnd:int = -1, paragraphSeparator:String = ):String
[override]
FlowGroupElement
 Inherited
Climbs the text flow hierarchy to return the root TextFlow object for the element.
FlowElement
 Inherited
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
 Inherited
isInTable():Boolean
FlowElement
 Inherited
Removes the specified child FlowElement object from the group.
FlowGroupElement
 Inherited
Removes the child FlowElement object at the specified index position.
FlowGroupElement
 Inherited
replaceChildren(beginChildIndex:int, endChildIndex:int, ... rest):void
Replaces child elements in the group with the specified new elements.
FlowGroupElement
 Inherited
setBorderColor(color:uint):void
FlowElement
 Inherited
setBorderWidth(width:Number):void
FlowElement
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets the style specified by the styleProp parameter to the value specified by the newValue parameter.
FlowElement
 Inherited
shallowCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement
Makes a copy of this FlowElement object, copying the content between two specified character positions.
FlowElement
 Inherited
Splits this object at the position specified by the childIndex parameter.
FlowGroupElement
  
splitAtPosition(relativePosition:int):FlowElement
[override]
ParagraphElement
Property Detail
interactiveChildrenCountproperty
interactiveChildrenCount:int  [read-only]


Implementation
    tlf_internal function get interactiveChildrenCount():int
terminatorSpanproperty 
terminatorSpan:SpanElement  [read-only]


Implementation
    tlf_internal function get terminatorSpan():SpanElement
Constructor Detail
ParagraphElement()Constructor
public function ParagraphElement()

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Constructor - represents a paragraph in a text flow.

Method Detail
decInteractiveChildrenCount()method
tlf_internal function decInteractiveChildrenCount():void

findNextAtomBoundary()method 
public function findNextAtomBoundary(relativePosition:int):int

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Scans ahead from the supplied position to find the location in the text of the next atom and returns the index. The term atom refers to both graphic elements and characters (including groups of combining characters), the indivisible entities that make up a text line.

Parameters

relativePosition:int — position in the text to start from, counting from 0

Returns
int — index in the text of the following atom

See also

flash.text.engine.TextLine
findNextWordBoundary()method 
public function findNextWordBoundary(relativePosition:int):int

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Returns the index of the next word boundary in the text.

Scans ahead from the supplied position to find the next position in the text that starts or ends a word.

Parameters

relativePosition:int — position in the text to start from, counting from 0

Returns
int — index in the text of the next word boundary
findPreviousAtomBoundary()method 
public function findPreviousAtomBoundary(relativePosition:int):int

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Scans backward from the supplied position to find the location in the text of the previous atom and returns the index. The term atom refers to both graphic elements and characters (including groups of combining characters), the indivisible entities that make up a text line.

Parameters

relativePosition:int — position in the text to start from, counting from 0

Returns
int — index in the text of the previous cluster

See also

flash.text.engine.TextLine
findPreviousWordBoundary()method 
public function findPreviousWordBoundary(relativePosition:int):int

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Returns the index of the previous word boundary in the text.

Scans backward from the supplied position to find the previous position in the text that starts or ends a word.

Parameters

relativePosition:int — position in the text to start from, counting from 0

Returns
int — index in the text of the previous word boundary
getNextParagraph()method 
public function getNextParagraph():ParagraphElement

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Returns the paragraph that follows this one, or null if there are no more paragraphs.

Returns
ParagraphElement — the next paragraph or null if there are no more paragraphs.

See also

getPreviousParagraph()method 
public function getPreviousParagraph():ParagraphElement

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Returns the paragraph that precedes this one, or null, if this paragraph is the first one in the TextFlow.

Returns
ParagraphElement

See also

getTextBlockAbsoluteStart()method 
tlf_internal function getTextBlockAbsoluteStart(tb:TextBlock):int

Parameters

tb:TextBlock

Returns
int
getTextBlocks()method 
tlf_internal function getTextBlocks():Vector.<TextBlock>

Returns
Vector.<TextBlock>
getTextBlockStart()method 
tlf_internal function getTextBlockStart(tb:TextBlock):int

Parameters

tb:TextBlock

Returns
int
hasInteractiveChildren()method 
tlf_internal function hasInteractiveChildren():Boolean

Returns
Boolean
incInteractiveChildrenCount()method 
tlf_internal function incInteractiveChildrenCount():void

removeEmptyTerminator()method 
tlf_internal function removeEmptyTerminator():void

splitAtPosition()method 
override public function splitAtPosition(relativePosition:int):FlowElement

Parameters

relativePosition:int

Returns
FlowElement