flashx.textLayout.elements.ParagraphElement

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
		borderBottomColor : * TextLayoutFormat: Color of the bottom border (adopts default value if undefined during cascade).	FlowElement
		borderBottomPriority : * TextLayoutFormat: Specifies the priority when drawing cell boundaries.	FlowElement
		borderBottomWidth : * 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
		borderLeftColor : * TextLayoutFormat: Color of the left border (adopts default value if undefined during cascade).	FlowElement
		borderLeftPriority : * TextLayoutFormat: Specifies the priority when drawing cell boundaries.	FlowElement
		borderLeftWidth : * 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
		borderRightColor : * TextLayoutFormat: Color of the right border (adopts default value if undefined during cascade).	FlowElement
		borderRightPriority : * TextLayoutFormat: Specifies the priority when drawing cell boundaries.	FlowElement
		borderRightWidth : * 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
		borderTopColor : * TextLayoutFormat: Color of the top border (adopts default value if undefined during cascade).	FlowElement
		borderTopPriority : * TextLayoutFormat: Specifies the priority when drawing cell boundaries.	FlowElement
		borderTopWidth : * 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
		breakOpportunity : * TextLayoutFormat: Controls where lines are allowed to break when breaking wrapping text into multiple lines.	FlowElement
		cellPadding : * TextLayoutFormat: cellPadding specifies the amount of space between the border of the cell and its contents.	FlowElement
		cellSpacing : * 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
		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
		columnBreakAfter : * TextLayoutFormat: Controls column after before the element.	FlowElement
		columnBreakBefore : * TextLayoutFormat: Controls column break before the element.	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 : ITextLayoutFormat [read-only] Returns the computed format attributes that are in effect for this element.	FlowElement
		containerBreakAfter : * TextLayoutFormat: Controls container after before the element.	FlowElement
		containerBreakBefore : * TextLayoutFormat: Controls container break before the element.	FlowElement
		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 : ITextLayoutFormat TextLayoutFormat properties applied directly to this element.	FlowElement
		frame : * TextLayoutFormat: frame specifies which sides of the frame surrounding a table will be visible.	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
		marginBottom : * TextLayoutFormat: bottom margin in pixels (adopts default value if undefined during cascade).	FlowElement
		marginLeft : * TextLayoutFormat: left margin in pixels(adopts default value if undefined during cascade).	FlowElement
		marginRight : * TextLayoutFormat: right margin in pixels (adopts default value if undefined during cascade).	FlowElement
		marginTop : * TextLayoutFormat: top margin in pixels (adopts default value if undefined during cascade).	FlowElement
		maxCellHeight : * TextLayoutFormat: Maximum height of a table cell.	FlowElement
		minCellHeight : * TextLayoutFormat: Minimum height of a table cell.	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
		rules : * TextLayoutFormat: rules specifies which rules will appear between cells within a table.	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
		tableColumnWidth : * TextLayoutFormat: Width of table column specifies a default width for each column spanned by the current COL element.	FlowElement
		tableWidth : * TextLayoutFormat: Width of table element specifies the desired width of the entire table and is intended for visual user agents.	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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ParagraphElement() Constructor - represents a paragraph in a text flow.	ParagraphElement
		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
		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
		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
		getNextParagraph():ParagraphElement Returns the paragraph that follows this one, or null if there are no more paragraphs.	ParagraphElement
		getNextSibling():FlowElement Returns the next FlowElement sibling in the text flow hierarchy.	FlowElement
		getParagraph():ParagraphElement Returns the ParagraphElement object associated with this element.	FlowElement
		getParentCellElement():TableCellElement	FlowElement
		getPreviousParagraph():ParagraphElement Returns the paragraph that precedes this one, or null, if this paragraph is the first one in the TextFlow.	ParagraphElement
		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():TextFlow Climbs the text flow hierarchy to return the root TextFlow object for the element.	FlowElement
		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
		isInTable():Boolean	FlowElement
		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
		setBorderColor(color:uint):void	FlowElement
		setBorderWidth(width:Number):void	FlowElement
		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 [override]	ParagraphElement

Property Detail

interactiveChildrenCount

property

interactiveChildrenCount:int [read-only]

Implementation
tlf_internal function get interactiveChildrenCount():int

terminatorSpan

property

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()

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

getNextParagraph()

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

Wed Nov 15 2017, 09:50 AM +01:00

Apache Flex 4.16.1 API Reference	All Packages \| All Classes \| Index \| Frames No Frames
ParagraphElement	Properties \| Methods

Package	flashx.textLayout.elements
Class	public final class ParagraphElement
Inheritance	ParagraphElement ParagraphFormattedElement FlowGroupElement FlowElement Object