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.

See also

InlineGraphicElement
LinkElement
SpanElement
TCYElement
TextFlow

Public Properties
 PropertyDefined By
 InheritedalignmentBaseline : 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
 InheritedbaselineShift : Object
[write-only] CharacterFormat: Amount to shift the baseline from the elementBaseline.
FlowElement
 InheritedbreakOpportunity : String
[write-only] CharacterFormat: Controls where lines are allowed to break when wrapping text is broken into multiple lines.
FlowElement
 InheritedcffHinting : String
[write-only] CharacterFormat: The type of CFF hinting used for this text.
FlowElement
 InheritedcharacterFormat : ICharacterFormat
CharacterFormat properties applied directly to this element.
FlowElement
 Inheritedcolor : Object
[write-only] CharacterFormat: Color of the text.
FlowElement
  computedParagraphFormat : IParagraphFormat
[read-only] ParagraphElement attributes applied to this paragraph, either as attributes applied directly, or inherited from a parent element.
ParagraphElement
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheriteddigitCase : String
[write-only] CharacterFormat: The type of digit case used for this text.
FlowElement
 InheriteddigitWidth : String
[write-only] CharacterFormat: Type of digit width used for this text.
FlowElement
 Inheriteddirection : String
[write-only] ParagraphFormat: Specifies the default bidi embedding level of the text in the text block.
ParagraphFormattedElement
 InheriteddominantBaseline : 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
 InheritedfontFamily : String
[write-only] CharacterFormat: The name of the font to use, or a comma-separated list of font names.
FlowElement
 InheritedfontLookup : String
[write-only] CharacterFormat: Font lookup to use.
FlowElement
 InheritedfontSize : Object
[write-only] CharacterFormat: The size of the text in pixels.
FlowElement
 InheritedfontStyle : String
[write-only] CharacterFormat: Style of text.
FlowElement
 InheritedfontWeight : String
[write-only] CharacterFormat: Weight of text.
FlowElement
 InheritedjustificationRule : String
[write-only] ParagraphFormat: Rule used to generate paragraph justification.
ParagraphFormattedElement
 InheritedjustificationStyle : String
[write-only] ParagraphFormat: The style used for justification of the paragraph.
ParagraphFormattedElement
 Inheritedkerning : String
[write-only] CharacterFormat: Kerning adjusts the pixels between certain character pairs to improve readability.
FlowElement
 InheritedleadingBasis : String
[write-only] ParagraphFormat: Specifies the baseline to which the lineHeight property refers.
ParagraphFormattedElement
 InheritedleadingDirection : String
[write-only] ParagraphFormat: Specifies the direction in which leading space is applied.
ParagraphFormattedElement
 InheritedligatureLevel : String
[write-only] CharacterFormat: Controls which of the ligatures that are defined in the font may be used in the text.
FlowElement
 InheritedlineHeight : Object
[write-only] CharacterFormat: Leading controls for the text.
FlowElement
 InheritedlineThrough : Object
[write-only] CharacterFormat: Strikethrough.
FlowElement
 Inheritedlocale : String
[write-only] CharacterFormat: The locale of the text.
FlowElement
 InheritedmarginBottom : Object
[write-only] ParagraphFormat: Amount of space in pixels to leave after the paragraph (a Number).
ParagraphFormattedElement
 InheritedmarginLeft : Object
[write-only] ParagraphFormat: Amount in pixels to indent the paragraph (a Number).
ParagraphFormattedElement
 InheritedmarginRight : Object
[write-only] ParagraphFormat: Amount in pixels to indent the right edge of the paragraph (a Number).
ParagraphFormattedElement
 InheritedmarginTop : Object
[write-only] ParagraphFormat: Amount of space in pixels to leave before the paragraph (a Number).
ParagraphFormattedElement
 InheritednumChildren : int
[read-only] Returns the number of FlowElement children that this FlowGroupElement object has.
FlowGroupElement
 InheritedparagraphFormat : IParagraphFormat
ParagraphFormat properties applied directly to this element.
ParagraphFormattedElement
 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
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrenderingMode : String
[write-only] CharacterFormat: The rendering mode used for this text.
FlowElement
 InheritedtabStops : Array
[write-only] ParagraphFormat: Specifies the tab stops associated with the paragraph.
ParagraphFormattedElement
 InheritedtextAlign : String
[write-only] ParagraphFormat: Alignment of lines in the paragraph relative to the container.
ParagraphFormattedElement
 InheritedtextAlignLast : String
[write-only] ParagraphFormat: Alignment of the last (or only) line in the paragraph relative to the container in justified text.
ParagraphFormattedElement
 InheritedtextAlpha : Object
[write-only] CharacterFormat: Alpha (transparency) value for the text.
FlowElement
 InheritedtextDecoration : String
[write-only] CharacterFormat: Decoration on text.
FlowElement
 InheritedtextIndent : Object
[write-only] ParagraphFormat: Amount in pixels to indent the first line of the paragraph (a Number).
ParagraphFormattedElement
 InheritedtextLength : int
[read-only] Returns the total length of text owned by this FlowElement object and its children.
FlowElement
 InheritedtextRotation : String
[write-only] CharacterFormat: Determines the amount of degrees to rotate this text.
FlowElement
 Inheritedtracking : Object
[write-only] Sets the tracking and is synonymous with the trackingRight property.
FlowElement
 InheritedtrackingLeft : 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
 InheritedtrackingRight : 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
 InheritedtypographicCase : String
[write-only] CharacterFormat: The type of typographic case used for this text.
FlowElement
 InheritedwhiteSpaceCollapse : String
[write-only] CharacterFormat: The setting used to collapse or preserve whitespace when importing text into a TextFlow.
FlowElement
Public Methods
 MethodDefined By
  
ParagraphElement()
Constructor - represents a paragraph in a text flow.
ParagraphElement
 Inherited
addChild(child:FlowElement):void
Appends a child FlowElement object.
FlowGroupElement
 Inherited
addChildAt(index:uint, child:FlowElement):void
Adds a child FlowElement object at the specified index position.
FlowGroupElement
 Inherited
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
 Inherited
findChildIndexAtPosition(relativePosition:int):int
Given a relative text position, find the index of the first child FlowElement that contains relative position.
FlowGroupElement
 Inherited
findLeaf(relativePosition:int):FlowLeafElement
Given a relative text position, find the leaf element that contains the position.
FlowGroupElement
  
findNextAtomBoundary(relativePos: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(relativePos:int):int
Returns the index of the next word boundary in the text.
ParagraphElement
  
findPreviousAtomBoundary(relativePos: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(relativePos:int):int
Returns the index of the previous word boundary in the text.
ParagraphElement
 Inherited
getAbsoluteStart():int
Returns the start location of the element in the text flow as an absolute index.
FlowElement
 Inherited
getAncestorWithContainer():ContainerFormattedElement
Returns the ContainerFormattedElement that specifies its containers for filling.
FlowElement
 Inherited
getCharAtPosition(relativePos:int):String
Returns the character at the specified position, relative to this FlowElement object.
FlowElement
 Inherited
getCharCodeAtPosition(relativePos:int):int
Returns the character code at the specified position, relative to this FlowElement.
FlowElement
 Inherited
getChildAtIndex(i:int):FlowElement
Returns the FlowElement child at the specified index.
FlowGroupElement
 Inherited
getChildIndex(child:FlowElement):int
Searches in children for the specified FlowElement object and returns its index position.
FlowGroupElement
 Inherited
getElementRelativeStart(ancestorElement:FlowElement):int
Returns the start of this element relative to an ancestor element.
FlowElement
 Inherited
getFirstLeaf():FlowLeafElement
Returns the first FlowLeafElement descendant of this element.
FlowGroupElement
 Inherited
getLastLeaf():FlowLeafElement
Returns the last FlowLeafElement descendent of this element.
FlowGroupElement
 Inherited
getNextSibling():FlowElement
Returns the next FlowElement sibling in the text flow hierarchy.
FlowElement
 Inherited
getParagraph():ParagraphElement
Returns the ParagraphElement object associated with this element.
FlowElement
 Inherited
getPreviousSibling():FlowElement
Returns the previous FlowElement sibling in the text flow hierarchy.
FlowElement
 Inherited
getTextFlow():TextFlow
Climbs the text flow hierarchy to return the root TextFlow object for the element.
FlowElement
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeChild(child:FlowElement):void
Removes the specified child FlowElement object.
FlowGroupElement
 Inherited
removeChildAt(index:uint):void
Removes a 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
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
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
 Inherited
splitAtIndex(childIndex:int):FlowGroupElement
Splits this object at the position specified by the childIndex parameter.
FlowGroupElement
 Inherited
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
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail
computedParagraphFormatproperty
computedParagraphFormat:IParagraphFormat  [read-only]

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

ParagraphElement attributes applied to this paragraph, either as attributes applied directly, or inherited from a parent element.

See IParagraph for definitions of all paragraph attributes.



Implementation
    public function get computedParagraphFormat():IParagraphFormat

See also

flashx.textLayout.formats.IParagraphFormat
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
findNextAtomBoundary()method
public function findNextAtomBoundary(relativePos: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

relativePos: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(relativePos: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

relativePos: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(relativePos: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

relativePos: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(relativePos: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 ahead from the supplied position to find the previous position in the text that starts or ends a word.

Parameters

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

Returns
int — index in the text of the previous word boundary



© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Thu Nov 20 2008, 04:03 AM -08:00

 

Send me an e-mail when comments are added to this page | Comment Report

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