flashx.textLayout.elements.FlowLeafElement - Adobe® Flex® 4 Language Reference (Flex 4)

Package	flashx.textLayout.elements
Class	public class FlowLeafElement
Inheritance	FlowLeafElement FlowElement Object
Subclasses	InlineGraphicElement, SpanElement

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Base class for FlowElements that appear at the lowest level of the flow hierarchy. FlowLeafElement objects have no children and include InlineGraphicElement objects and SpanElement objects.

See also

InlineGraphicElement
SpanElement

Public Properties

Hide Inherited Public Properties

Show Inherited 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
		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 [override] [read-only] The computed text format attributes that are in effect for this element.	FlowLeafElement
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		coreStyles : Object [read-only] Returns the core styles on a FlowElement instance.	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 : * Defines the formatting attributes used for links in active state, when the mouse is down on a link.	FlowElement
		linkHoverFormat : * Defines the formatting attributes used for links in hover state, when the mouse is within the bounds (rolling over) a link.	FlowElement
		linkNormalFormat : * Defines the formatting attributes used for links in normal state.	FlowElement
		locale : * TextLayoutFormat: The locale of the text.	FlowElement
		paddingBottom : * TextLayoutFormat: Botttom inset in pixels (adopts default value if undefined during cascade).	FlowElement
		paddingLeft : * TextLayoutFormat: Left inset in pixels (adopts default value if undefined during cascade).	FlowElement
		paddingRight : * TextLayoutFormat: Right inset in pixels (adopts default value if undefined during cascade).	FlowElement
		paddingTop : * TextLayoutFormat: Top inset in pixels (adopts default value if undefined during cascade).	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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		renderingMode : * TextLayoutFormat: The rendering mode used for this text.	FlowElement
		styleName : String Assigns an identifying class to the element, making it possible to set a style for the element by referencing the styleName.	FlowElement
		tabStops : * TextLayoutFormat: Specifies the tab stops associated with the paragraph.	FlowElement
		text : String [read-only] The text associated with the FlowLeafElement: The value for SpanElement subclass will be one character less than textLength if this is the last span in a ParagraphELement. The value for BreakElement subclass is a U+2028 The value for TabElement subclass is a tab The value for InlineGraphicElement subclass is U+FDEF	FlowLeafElement
		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
		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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		FlowLeafElement() Base class - invoking new FlowLeafElement() throws an error exception.	FlowLeafElement
		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
		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
		getComputedFontMetrics():FontMetrics Returns the FontMetrics object for the span.	FlowLeafElement
		getElementRelativeStart(ancestorElement:FlowElement):int Returns the start of this element relative to an ancestor element.	FlowElement
		getNextLeaf(limitElement:FlowGroupElement = null):FlowLeafElement Returns the next FlowLeafElement object.	FlowLeafElement
		getNextSibling():FlowElement Returns the next FlowElement sibling in the text flow hierarchy.	FlowElement
		getParagraph():ParagraphElement Returns the ParagraphElement object associated with this element.	FlowElement
		getPreviousLeaf(limitElement:FlowGroupElement = null):FlowLeafElement Returns the previous FlowLeafElement object.	FlowLeafElement
		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 Gets the specified range of text from a flow element.	FlowElement
		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
		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
		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

Property Detail

computedFormat

property

computedFormat:flashx.textLayout.formats:ITextLayoutFormat [read-only] [override]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The computed text format attributes that are in effect for this element. Takes into account the inheritance of attributes.

Implementation
override public function get computedFormat():flashx.textLayout.formats:ITextLayoutFormat

text

property

text:String [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The text associated with the FlowLeafElement:

The value for SpanElement subclass will be one character less than textLength if this is the last span in a ParagraphELement.
The value for BreakElement subclass is a U+2028
The value for TabElement subclass is a tab
The value for InlineGraphicElement subclass is U+FDEF

Implementation
public function get text():String

Constructor Detail

FlowLeafElement

()

Constructor

public function FlowLeafElement()

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Base class - invoking new FlowLeafElement() throws an error exception.

Method Detail

getComputedFontMetrics

()

method

public function getComputedFontMetrics():FontMetrics

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Returns the FontMetrics object for the span. The properties of the FontMetrics object describe the emBox, strikethrough position, strikethrough thickness, underline position, and underline thickness for the specified font.

Returns

FontMetrics — font metrics associated with the span

getNextLeaf

()

method

public function getNextLeaf(limitElement:FlowGroupElement = null):FlowLeafElement

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Returns the next FlowLeafElement object.

Parameters

limitElement:FlowGroupElement (default = null) — Specifies FlowGroupElement on whose last leaf to stop looking. A value of null (default) means search till no more elements.

Returns

FlowLeafElement — next FlowLeafElement or null if at the end

Example ( How to use this example )

This example creates three paragraphs, each with three SpanElement objects. The example finds the first FlowLeafElement object and calls getNextLeaf() to iterate forward through each leaf element and trace its text, up to and including paragraph p2.


package flashx.textLayout.elements.examples {
    import flash.display.Sprite;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.container.ContainerController;
    
    public class FlowLeafElement_getNextLeafExample extends Sprite{    
        private var textFlow:TextFlow = new TextFlow();

        public function FlowLeafElement_getNextLeafExample(){
            var fontSize:Number = 12;
            var textFlow:TextFlow = new TextFlow();
            
            var p1:ParagraphElement = new ParagraphElement();
            var p2:ParagraphElement = new ParagraphElement();
            var p3:ParagraphElement = new ParagraphElement();
            var p1Span1:SpanElement = new SpanElement();
            var p1Span2:SpanElement = new SpanElement();
            var p1Span3:SpanElement = new SpanElement();
            var p2Span1:SpanElement = new SpanElement();
            var p2Span2:SpanElement = new SpanElement();
            var p2Span3:SpanElement = new SpanElement();
            var p3Span1:SpanElement = new SpanElement();
            var p3Span2:SpanElement = new SpanElement();
            var p3Span3:SpanElement = new SpanElement();
            p1Span1.text = "Breathe.";
            p1Span1.fontSize = fontSize;
            p1Span2.text = "Walk.";
            p1Span2.fontSize = fontSize + 1;
            p1Span3.text = "Play.";
            p1Span3.fontSize = fontSize + 2;
            p1.addChild(p1Span1);
            p1.addChild(p1Span2);
            p1.addChild(p1Span3);
            p2Span1.text = "Study.";
            p2Span1.fontSize = fontSize + 3;
            p2Span2.text = "Work.";
            p2Span2.fontSize = fontSize + 4;
            p2Span3.text = "Marry.";
            p2Span3.fontSize = fontSize + 5;
            p2.fontSize = fontSize + 6;
            p2.addChild(p2Span1);
            p2.addChild(p2Span2);
            p2.addChild(p2Span3);
            p3Span1.text = "Retire.";
            p3Span1.fontSize = fontSize + 6;
            p3Span2.text = "Travel.";
            p3Span2.fontSize = fontSize + 7;
            p3Span3.text = "Rock." ;
            p3Span3.fontSize = fontSize + 8;
            p3.addChild(p3Span1);
            p3.addChild(p3Span2);
            p3.addChild(p3Span3);
            textFlow.addChild(p1);
            textFlow.addChild(p2);
            textFlow.addChild(p3);
            textFlow.flowComposer.addController(new ContainerController(this,600,600));
            textFlow.flowComposer.updateAllControllers();
            var leaf:SpanElement = new SpanElement();
            leaf = SpanElement(textFlow.getFirstLeaf());
            trace(leaf.text);
            while(leaf = SpanElement(leaf.getNextLeaf(p2)))
                trace(leaf.text);
        }
    }
}

getPreviousLeaf

()

method

public function getPreviousLeaf(limitElement:FlowGroupElement = null):FlowLeafElement

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Returns the previous FlowLeafElement object.

Parameters

limitElement:FlowGroupElement (default = null) — Specifies the FlowGroupElement on whose first leaf to stop looking. null (default) means search till no more elements.

Returns

FlowLeafElement — previous leafElement or null if at the end

Example ( How to use this example )

This example creates three paragraphs, each with three SpanElement objects. The example finds the last FlowLeafElement object, and calls getPreviousLeaf() to iterate backward through each leaf element and trace its text, through the limit element, paragraph p3.

package flashx.textLayout.elements.examples 
{    
    import flash.display.Sprite;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.container.ContainerController;
    
    public class FlowLeafElement_getPreviousLeafExample extends Sprite
    {    
        public function FlowLeafElement_getPreviousLeafExample(){
            var textFlow:TextFlow = new TextFlow();
            var fontSize:Number = 12;
            
            var p1:ParagraphElement = new ParagraphElement();
            var p2:ParagraphElement = new ParagraphElement();
            var p3:ParagraphElement = new ParagraphElement();
            var p1Span1:SpanElement = new SpanElement();
            var p1Span2:SpanElement = new SpanElement();
            var p1Span3:SpanElement = new SpanElement();
            var p2Span1:SpanElement = new SpanElement();
            var p2Span2:SpanElement = new SpanElement();
            var p2Span3:SpanElement = new SpanElement();
            var p3Span1:SpanElement = new SpanElement();
            var p3Span2:SpanElement = new SpanElement();
            var p3Span3:SpanElement = new SpanElement();
            p1Span1.text = "Breathe.";
            p1Span1.fontSize = fontSize;
            p1Span2.text = "Walk.";
            p1Span2.fontSize = fontSize + 1;
            p1Span3.text = "Play.";
            p1Span3.fontSize = fontSize + 2;
            p1.addChild(p1Span1);
            p1.addChild(p1Span2);
            p1.addChild(p1Span3);
            p2Span1.text = "Study.";
            p2Span1.fontSize = fontSize + 3;
            p2Span2.text = "Work.";
            p2Span2.fontSize = fontSize + 4;
            p2Span3.text = "Marry.";
            p2Span3.fontSize = fontSize + 5;
            p2.addChild(p2Span1);
            p2.addChild(p2Span2);
            p2.addChild(p2Span3);
            p3Span1.text = "Retire.";
            p3Span1.fontSize = fontSize + 6;
            p3Span2.text = "Travel.";
            p3Span2.fontSize = fontSize + 7;
            p3Span3.text = "Rock.";
            p3Span3.fontSize = fontSize + 8;
            p3.addChild(p3Span1);
            p3.addChild(p3Span2);
            p3.addChild(p3Span3);
            textFlow.addChild(p1);
            textFlow.addChild(p2);
            textFlow.addChild(p3);
            textFlow.flowComposer.addController(new ContainerController(this,600,600));
            textFlow.flowComposer.updateAllControllers();
            var leaf:SpanElement = new SpanElement();
            leaf = SpanElement(textFlow.getLastLeaf());
            trace(leaf.text);
            while(leaf = SpanElement(leaf.getPreviousLeaf(p3)))
                trace(leaf.text);
        }
    }
}