Specifies the number of pixels from the baseline to the top of the tallest characters in the line. For a TextLine that contains only a graphic element, ascent is set to 0.

The number of atoms in the line, which is the number of indivisible elements, including spaces and graphic elements.

Accessing this property causes the player to create the atom data if it does not yet exist.

See also

Specifies the number of pixels from the baseline to the bottom of the lowest-descending characters in the line. For a TextLine that contains only a graphic element, descent is set to 0.

Indicates whether the text line contains any graphic elements.

See also

A Vector containing the TextLineMirrorRegion objects associated with the line, or null if none exist.

See also

The next TextLine in the TextBlock, or null if this is the last line in the block or the validity of the line is TextLineValidity.STATIC.

See also

The previous TextLine in the TextBlock, or null if the line is the first line in the block or the validity of the line is TextLineValidity.STATIC.

See also

The length of the raw text in the text block that became the line, including the U+FDEF characters representing graphic elements and any trailing spaces, which are part of the line but not actually displayed.

See also

The width specified to the TextBlock.createTextLine() method when it created the line. This value is useful when deciding if a change requires rebreaking the line.

See also

The TextBlock containing this text line, or null if the validity of the line is TextLineValidity.STATIC.

See also

The index of the first character of the line in the raw text of the text block.

See also

The logical height of the text line, which is equal to ascent + descent. To get the inked height, access the inherited height property.

The value is calculated based on the difference between the baselines that bound the line, either ideo top/bottom or ascent/descent depending on whether TextBlock.baselineZero is ideo or not. Graphic elements are not considered when computing these baselines.

See also

The logical width of the text line, which is the width that the text engine uses to lay out the line. Access the inherited width property to get the actual width of the bounding box of all the drawn pixels.

See also

 
package {
import flash.display.Sprite;
import flash.text.engine.TextBlock;
import flash.text.engine.TextElement;
import flash.text.engine.TextLine;
import flash.text.engine.FontDescription;
import flash.text.engine.ElementFormat;
import flash.text.engine.FontPosture;

    public class TextLine_textWidthExample extends Sprite {
        
        public function TextLine_textWidthExample() {
            
            var str:String = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, ";
            var yPos:Number = 20;
            var fontDescription:FontDescription = new FontDescription();
            var textBlock:TextBlock = new TextBlock();
            fontDescription.fontPosture = FontPosture.NORMAL;
            var format:ElementFormat = new ElementFormat(fontDescription, 12);
            var textElement:TextElement = new TextElement(str, format);
            textBlock.content = textElement;
            createLine(textBlock, yPos);
            fontDescription.fontPosture = FontPosture.ITALIC;
            format = new ElementFormat(fontDescription, 12);
            textElement = new TextElement(str, format);
            textBlock.content = textElement;
            createLine(textBlock, yPos + 20);
        }

        private function createLine(textBlock:TextBlock, yPos:Number):void {
            var textLine:TextLine = textBlock.createTextLine (null, 500);
            trace("specifiedWidth is: " + textLine.specifiedWidth);
            trace("textWidth is: " + textLine.textWidth);
            trace("width is: " + textLine.width);
            addChild(textLine);
            textLine.x = 15;
            textLine.y = yPos;     
        }
    }
}

The width of the line if it was not justified. For unjustified text, this value is the same as textWidth. For justified text, this value is what the length would have been without justification and textWidth represents the actual line width. For example, when the following String is justified and submitted to TextBlock.createTextLine() with a width of 500, it has an actual width of 500 but an unjustified width of 268.9921875.

See also

  var str = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, ";
  

Provides a way for the author to associate arbitrary data with the text line.

Specifies the current validity of the text line. System values for this property are found in the members of the TextLineValidity class. The rules for setting this property are as follows:

A line is considered USER_INVALID if validity is set to any string which is not a member of TextLineValidity. USER_INVALID is an abstraction used here to represent any such value.

When the contents of the TextBlock are modified, player code marks affected text lines, the previous line, and all following lines as INVALID. The previous line must be marked invalid when a change allows the previous line to absorb part of the content that was originally on the first affected line.

Newly broken lines are always VALID. The player code might change following lines from VALID to POSSIBLY_INVALID or INVALID. It might change POSSIBLY_INVALID lines to VALID if the line breaks match up, or to INVALID if they don't.

User code can mark VALID lines as INVALID or USER_INVALID, and can mark USER_INVALID lines as VALID. User code cannot mark lines POSSIBLY_INVALID.

User code can mark any line STATIC. Doing so causes the block member to become null. It also clears the atom data of the line and prevents it from being re-created. Any graphic elements in a STATIC text line is removed and reparented if they are part of a new text line broken from the text block from which the STATIC text line originally derived.

See also

Dumps the underlying contents of the TextLine as an XML string. This can be useful in automated testing, and includes text, formatting, and rendering information. It is only available in the debugger Flash Player.

For a description of the output, see the TextBlock.dump() method.

Note: The content and format of the output from this method could change in the future. Adobe does not guarantee backward compatibility for this method.

See also

Releases the atom data of the line for garbage collection. The term atom refers to the indivisible entities that make up a text line. Atom data is generated by the atomCount property and the various methods in this class that retrieve information about an individual atom.

See also

Gets the bidirectional level of the atom at the specified index. The value is determined by a combination of TextBlock.bidiLevel and the Unicode bidirectional properties of the characters in the block that combine to form the line.

For example, if you start a text block with some Hebrew text, you set TextBlock.bidiLevel to 1, establishing a default of right to left. If within the text you have a quote in English (left to right), that text has an AtomBidiLevel of 2. If within the English you have a bit of Arabic (right to left), AtomBidiLevel for that run goes to 3. If within the Arabic a number (left to right) occurs, the AtomBidiLevel setting for the number is 4. It does not matter in which line the atoms end up; the Hebrew atoms will be AtomBidiLevel 1, the English atoms will be AtomBidiLevel 2, Arabic atoms will be AtomBidiLevel 3, and the number atoms will be AtomBidiLevel 4.

Calling this method causes the player to create the atom data if it does not yet exist.

Parameters

See also

Gets the bounds of the atom at the specified index relative to the text line. The bounds of the specified atom consist of its horizontal position (x) in the line, its vertical position in the line (y), its width (w) and its height (h). All values are in pixels.

Calling this method causes the player to create the atom data if it does not yet exist.

Parameters

See also

Gets the center of the atom as measured along the baseline at the specified index.

Calling this method causes the player to create the atom data, if it does not yet exist.

Parameters

See also

Gets the graphic of the atom at the specified index, or null if the atom is a character.

Calling this method causes the player to create the atom data if it does not yet exist.

Parameters

See also

Returns the index of the atom containing the character specified by the charIndex parameter, or -1 if the character does not contribute to any atom in the line. The charIndex is relative to the entire contents of the text block containing the line.

Calling this method causes the player to create the atom data if it does not yet exist.

Parameters

See also

Returns the index of the atom at the point specified by the x and y parameters, or -1 if no atom exists at that point.

Calling this method causes the player to create the atom data if it does not yet exist.

This method takes global coordinates so that it may easily be used with MouseEvent.stageX and MouseEvent.stageY.

Parameters

See also

Gets the text block begin index of the atom at the specified index.

Calling this method causes the player to create the atom data if it does not yet exist.

Parameters

See also

Gets the text block end index of the atom at the specified index.

Calling this method causes the player to create the atom data if it does not yet exist.

Parameters

See also

Gets the rotation of the atom at the specified index. TextRotation constants are used for this property. The rotation of the atom is the cumulative rotations of the glyph (as determined by ElementFormat.textRotation and / or TextBlock.glyphRotation), the element, and the line.

Calling this method causes the player to create the atom data if it does not yet exist.

Parameters

See also

Indicates whether a word boundary occurs to the left of the atom at the specified index. Word boundaries are determined based on the Unicode properties of the characters which contributed to the line.

Calling this method causes the player to create the atom data if it does not yet exist.

Parameters

See also

Gets the position of the specified baseline, relative to TextBlock.baselineZero.

Parameters

See also

Returns the first TextLineMirrorRegion on the line whose mirror property matches that specified by the mirror parameter, or null if no match exists.

Even a single TextElement can produce multiple TextLineMirrorRegion objects on one or more lines, depending on bi-di and line breaking. All the mirror regions generated from one text element are linked by their next and previous references.

Parameters

See also

The maximum requested width of a text line, in pixels. The TextBlock.createTextLine() method uses this constant as the default value for the width parameter, if you do not specify a value.

See also

1. Add the NumericStepper component to the library.
2. Save this code as TextLineExample.as in the same directory as your FLA.
3. Set the DocumentClass in the FLA to TextLineExample.

package {
    import flash.display.Sprite;
    import flash.text.engine.TextBlock;
    import flash.text.engine.TextElement;
    import flash.text.engine.TextLine;
    import flash.text.engine.ElementFormat;
    import flash.text.engine.FontDescription;
    import flash.text.engine.FontPosture;
    import fl.controls.NumericStepper;
    import flash.events.Event;
    import flash.geom.Rectangle;
    
    public class TextLineExample extends Sprite {
        
        private var atomStepper:NumericStepper = new NumericStepper();
        private var atomDataContainer:Sprite;
        private var fontDescription:FontDescription = new FontDescription("Arial");
        private var textBlock:TextBlock = new TextBlock();
        private var textLine:TextLine;
        
        public function TextLineExample():void {
            
            var myText:String = "I am a TextElement, created from a String and assigned " +
            "to the content property of a TextBlock. From the text block, " +
            "the createTextLine() method created these lines, 300 pixels wide, "  +
            "for display." ;
            
            atomStepper.minimum = 0;
            atomStepper.value = 0;
            atomStepper.width = 50;
            addChild(atomStepper);
            atomStepper.x = 20;
            atomStepper.y = 120;
            atomStepper.addEventListener(Event.CHANGE, nsChange);
            
            var directions:String = "Click up / down arrows to frame atoms in text block above.";
            
            fontDescription.fontPosture = FontPosture.ITALIC;
            var format:ElementFormat = new ElementFormat(fontDescription);
            format.fontSize = 12;
            var textElement1:TextElement = new TextElement(directions, format);
            textBlock.content = textElement1;
            createLines(textBlock, 15, 160, 400, this);
            
            var textElement2:TextElement = new TextElement(myText, format);
            fontDescription.fontPosture = FontPosture.NORMAL;
            format.fontSize = 16;
            textBlock.content = textElement2;
            createLines(textBlock, 15.0, 20.0, 300, this);
            textLine = textBlock.firstLine;
            atomStepper.maximum = textLine.atomCount - 1;
            showAtom(textLine, 0);
        }
            
        private function nsChange(event:Event):void
        {
            removeAtom(textLine);
            if (atomStepper.value == textLine.atomCount - 1)
            {
                if(textLine != textBlock.lastLine)
                {
                    textLine = textLine.nextLine;
                    atomStepper.maximum = textLine.atomCount - 1;
                    atomStepper.value = 0;
                }
            }
            showAtom(textLine, atomStepper.value);
        }
            
        private function createLines(textBlock, startX, startY, width, container)
        {
            var textLine:TextLine = textBlock.createTextLine (null, width);
            while (textLine)
            {
                textLine.x = startX;
                textLine.y = startY;
                startY += textLine.height + 2;
                container.addChild(textLine);
                textLine = textBlock.createTextLine (textLine, width);
            }
        }
            
        private function showAtom(textLine, i):void
        {
            var box:Sprite = new Sprite();
            var mcGraphics = box.graphics;
            var bounds:Rectangle = textLine.getAtomBounds(i);
            mcGraphics.lineStyle(1, 0xFF0000, 1.0);
            mcGraphics.drawRect(bounds.left, bounds.top, bounds.width, bounds.height);
            textLine.userData = textLine.addChild(box);
            displayAtomData(textLine,i);
        }
            
        private function displayAtomData(textLine, i)
        {
            if(atomDataContainer != null)
                removeChild(atomDataContainer);
            atomDataContainer=new Sprite();
            var format:ElementFormat = new ElementFormat(fontDescription);
            fontDescription.fontPosture = FontPosture.NORMAL;
            format.fontSize = 12;
            format.color = 0x00000FF;
            var n:int = 0;
            var nxtY:Number = 0;
            var atomInfo:String = "value of getAtomBidiLevel() is: " + textLine.getAtomBidiLevel(i)+"\n"
            +"value of getAtomCenter() is: " + textLine.getAtomCenter(i)+"\n"
            +"value of getAtomIndexAtCharIndex() is: " + textLine.getAtomIndexAtCharIndex(i)+"\n"
            +"value of getAtomTextBlockBeginIndex() is: " + textLine.getAtomTextBlockBeginIndex(i)+"\n"
            +"value of getAtomTextBlockEndIndex() is: " + textLine.getAtomTextBlockEndIndex(i)+"\n"
            +"value of getAtomTextRotation() is: " + textLine.getAtomTextRotation(i)+"\n";
            var atomtextBlock:TextBlock = new TextBlock();
            var te3:TextElement = new TextElement(atomInfo, format);
            atomtextBlock.content = te3;
            createLines(atomtextBlock,20,200,500, atomDataContainer)
            addChild(atomDataContainer);
        }
            
        private function removeAtom(textLine):void
        {
            textLine.removeChild(textLine.userData);
        }
    }    
}