TextLine  - AS3

Określa liczbę pikseli od linii bazowej do górnego punktu najwyższych znaków w wierszu. Dla obiektu TextLine zawierającego wyłącznie elementy graficzne, wartośćascent wynosi 0.

Liczba atomów w wierszu, która stanowi liczbę niepodzielnych elementów, z uwzględnieniem odstępów oraz elementów graficznych.

Określa liczbę pikseli od linii bazowej do dolnego punktu najniżej sięgających znaków w wierszu. Dla obiektu TextLine zawierającego wyłącznie elementy graficzne wartośćdescent wynosi 0.

Wskazuje, czy wiersz tekstu zawiera elementy graficzne.

Powiązane elementy interfejsu API

Wskazuje, czy wiersz tekstu zawiera tabulatory.

Obiekt Vector zawierający obiekty TextLineMirrorRegion skojarzone z wierszem lub wartość null, jeśli takie obiekty nie istnieją.

Powiązane elementy interfejsu API

Następny obiekt TextLine w obiekcie TextBlock lub wartość null, jeśli bieżący wiersz to ostatni wiersz w bloku lub właściwość validity wiersza ma wartość TextLineValidity.STATIC.

Powiązane elementy interfejsu API

Poprzedni obiekt TextLine w obiekcie TextBlock lub wartość null, jeśli wiersz to pierwszy wiersz w bloku lub właściwość validity wiersza ma wartość TextLineValidity.STATIC.

Powiązane elementy interfejsu API

Długość nieprzetworzonego tekstu, który stał się wierszem, w tym znaki U+FDEF reprezentujące elementy graficzne oraz wszystkie odstępy końcowe stanowiące część wiesza, które nie są wyświetlane.

Powiązane elementy interfejsu API

Szerokość, która została określona dla metody TextBlock.createTextLine() podczas tworzenia wierszy. Ta wartość jest pomocna podczas podejmowania decyzji co do ponownego podziału wiersza po zmianie.

Powiązane elementy interfejsu API

Obiekt TextBlock zawierający ten wiersz tekstu lub null, jeśli ważność wiersza jest obecnie określona jako TextLineValidity.STATIC, czyli połączenie między wierszem a obiektem TextBlock zostało zerwane.

Powiązane elementy interfejsu API

Indeks pierwszego znaku wiersza nieprzetworzonego tekstu w bloku tekstu.

Powiązane elementy interfejsu API

Logiczna wysokość wiersza tekstu równa wartości ascent + descent. Aby pobrać wysokość widocznych elementów wiersza, należy uzyskać dostęp do właściwości dziedziczonej height

Wartość jest obliczona na podstawie różnicy pomiędzy liniami bazowymi stanowiącymi granicę dla wiersza, góry/dołu ideogramu lub wydłużenia dolnego/górnego w zależności od tego, czy wartość TextBlock.baselineZero jest właściwa dla ideogramów. Podczas obliczania tych linii bazowych nie bierze się pod uwagę elementów graficznych.

Powiązane elementy interfejsu API

Logiczna szerokość wiersza tekstu stanowiąca szerokość, którą wykorzystuje mechanizm tekstowy w celu rozplanowania wiersza. W celu pobrania rzeczywistej szerokości obwiedni dla wszystkich narysowanych pikseli należy uzyskać dostęp do dziedziczonej właściwości width.

Powiązane elementy interfejsu API

 
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);
            var fontDescriptionItalic = fontDescription.clone();
            fontDescriptionItalic.fontPosture = FontPosture.ITALIC;
            var formatItalic = new ElementFormat(fontDescriptionItalic, 12);
            textElement = new TextElement(str, formatItalic);
            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;     
        }
    }
}

Określa liczbę pikseli od linii bazowej do górnego punktu najwyższego znaku lub najwyższej grafiki w wierszu.

Określa liczbę pikseli od linii bazowej do dolnego punktu najniżej sięgającego znaku lub najniższej grafiki w wierszu.

Całkowita logiczna wysokość wiersza tekstu, równa sumie liczb totalAscent i totalDescent.

Szerokość wiersza bez justowania. W przypadku niewyjustowanego tekstu ta wartość jest równa textWidth. W przypadku wyjustowanego tekstu ta wartość przedstawia długość osiągniętą bez justowania, a textWidth rzeczywistą szerokość wiersza. Na przykład po wyjustowaniu następującego ciągu znaków i przekazaniu go za pomocą metody TextBlock.createTextLine() z wartością width wynoszącą 500 właściwa szerokość wynosi 500, a szerokość niewyjustowana — 268.9921875.

Powiązane elementy interfejsu API

     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.SpaceJustifier;
     import flash.text.engine.LineJustification;

     var str:String = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, ";
     var fontDescription:FontDescription = new FontDescription();
     var textBlock:TextBlock = new TextBlock();
     var format:ElementFormat = new ElementFormat(fontDescription, 12);
     var textElement:TextElement = new TextElement(str, format);
     textBlock.content = textElement;
     var spaceJustifier:SpaceJustifier = new SpaceJustifier("en", LineJustification.ALL_INCLUDING_LAST);
     textBlock.textJustifier = spaceJustifier;
     var textLine:TextLine = textBlock.createTextLine(null, 500);
     textLine.y = 20;

     addChild(textLine);
     trace("textWidth value is: " + textLine.textWidth);        // 500.00244140625
     trace("unjustifiedTextWidth is: " + textLine.unjustifiedTextWidth); // 268.9921875
     

Umożliwia aplikacji skojarzenie dowolnych danych z wierszem tekstu.

Określa bieżącą wartość właściwości validity wiesza tekstu. Wartości dla tej właściwości znajdują się w elementach należących do klasy TextLineValidity. Zasady ustawiania tej właściwości są następujące:

Wiersz ma status USER_INVALID, jeśli dla dowolnego ciągu znaków zostanie ustawiona wartość validity nienależąca do klasyTextLineValidity. USER_INVALID to wartość abstrakcyjna użyta tutaj w celu przedstawienia wszystkich takich wartości.

Po zmodyfikowaniu treści obiektu TextBlock środowisko wykonawcze Flash oznacza zmienione wiesze tekstu, wiesz poprzedni i następujące wiersze jako INVALID. Poprzednie wiersze muszą być oznaczone wartością INVALID, kiedy zmiana umożliwia wcześniejszemu wierszowi częściowe wchłonięcie treści pierwotnie znajdującej się w pierwszym zmienionym wierszu.

Nowo podzielone wiersze zawsze mają status VALID. Środowisko wykonawcze Flash może zmienić wiersze następujące ze statusu VALID na POSSIBLY_INVALID lub INVALID. Może zmienić wiersze POSSIBLY_INVALID na VALID, jeśli podziały wierszy są zgodne, lub na INVALID, jeśli nie są zgodne.

Kod aplikacji może oznaczać wiersze jako VALID lub USER_INVALID, a USER_INVALID jako VALID. Kod aplikacji nie może oznaczać wierszy jako POSSIBLY_INVALID.

Kod aplikacji może oznaczyć dowolny wiersz jako STATIC. Ta czynność spowoduje zmianę elementu block na wartość null. Wszystkie elementy graficzne w wierszu tekstu STATIC są usuwane i ponownie przydzielane do elementów nadrzędnych, jeśli stanowią cześć nowego wiersza tekstu powstałego w wyniku podziału bloku tekstu, do którego pierwotnie należał wiersz tekstu STATIC.

Powiązane elementy interfejsu API

Zapisuje podstawową treść obiektu TextLine jako ciąg znaków XML. Może to być przydatne przy testowaniu zautomatyzowanym; zapisany ciąg zawiera tekst, informacje o formatowaniu i układzie.

Poniżej opisano wyniki:

	 [LINE]
	 <line ascent=[Number] descent=[Number] rotation=[int]>
	 	<elements>
	 		[0-N ELEMENT]
	 	</elements>
	 	<clusters>
	 		[0-N CLUSTER]
	 	</clusters>
	 </line>
	 
	 [ELEMENT]
	 <glyph isEmbedded=[Boolean] fontName=[String] isBold=[Boolean] isItalic=[Boolean] gid=[int] pointSize=[Number] x=[Number] y=[Number] rotation=[int]/>
	 or
	 <graphic child=[int] x=[Number] y=[Number] rotation=[int]/>
	 or
	 <embeddedRun x=[Number] y=[Number]>
	 	[LINE]
	 </embeddedRun>
	 
	 [CLUSTER]
	 <cluster xLeft=[Number] xCenter=[Number] xRight=[Number] cursorOnLeft=[Boolean] cursorOnRight=[Boolean] wordBoundaryOnLeft=[Boolean] wordBoundaryOnRight=[Boolean]/>
	 

Uwaga: Treść i format wyniku tej metody może w przyszłości ulec zmianie. Firma Adobe nie gwarantuje kompatybilności wstecznej tej metody.

Powiązane elementy interfejsu API

Ta metoda jest przestarzała i nie odnosi żadnego skutku. Dane atomów są skompresowane i nie ma to wpływu na wydajność zarządzania pamięcią.

Powiązane elementy interfejsu API

Pobiera poziom dwukierunkowości atomu o określonym indeksie. Wartość zostaje określona przez połączenie właściwości TextBlock.bidiLevel oraz właściwości dwukierunkowości znaków Unicode tworzących wiersz.

Na przykład w przypadku rozpoczęcia bloku tekstowego od tekstu hebrajskiego należy ustawić dla właściwości TextBlock.bidiLevel wartość 1, ustalając kierunek domyślny od prawej do lewej. Jeśli w tekście znajduje się cytat w języku angielskim (od lewej do prawej), wartość właściwości AtomBidiLevel dla tego tekstu wynosi 2. Jeśli w tekście angielskim pojawi się fragment w języku arabskim (od prawej do lewej), wartość właściwości AtomBidiLevel w tym przypadku wynosi 3. Jeśli w tekście arabskim pojawi się liczba (od lewej do prawej), wartość ustawienia AtomBidiLevel wynosi 4. Wiersz, w którym zakończy się atom nie ma znaczenia; hebrajskie atomy mają właściwość AtomBidiLevel o wartości 1, angielskie atomy mają właściwość AtomBidiLevel o wartości 2, arabskie atomy mają właściwość AtomBidiLevel o wartości 3, a atomy liczb mają właściwość AtomBidiLevel o wartości 4.

Parametry

Powiązane elementy interfejsu API

Pobiera granice atomu o podanym indeksie względne wobec wiesza tekstu. Granice określonego atomu składają się z położenia poziomego (x) w wierszu, położenia pionowego w wierszu (y), szerokości (w) oraz wysokości (h). Wszystkie wartości podane są w pikselach.

Parametry

Pobiera środek atomu o określonym indeksie mierzony wzdłuż linii bazowej.

Parametry

Pobiera grafikę atomu o podanym indeksie lub wartość null, jeśli atom jest znakiem.

Parametry

Zwraca indeks atomu zawierającego znak określony przez parametr charIndex lub wartość -1, jeśli znak nie jest częścią atomu w wierszu. Parametr charIndex jest względny wobec całej treści bloku tekstowego zawierającego wiersz.

Parametry

Zwraca indeks atomu w punkcie określonym przez parametry x i y lub wartość -1, jeśli w tym punkcie nie istnieje żaden atom.

Ta metoda korzysta z globalnych współrzędnych, umożliwiając łatwe użycie właściwości MouseEvent.stageX oraz MouseEvent.stageY.

Parametry

Pobiera indeks atomu o określonym indeksie początkowym w bloku tekstu.

Parametry

Pobiera indeks końcowy atomu o określonym indeksie w bloku tekstu.

Parametry

Pobiera obrót atomu o określonym indeksie. Dla tej właściwości stosuje się stałe klasy TextRotation. Obrót atomu jest sumą obrotów elementu i wiersza. Podstawowym zastosowaniem obrotu jest określanie orientacji kursora tekstowego podczas interakcji z obiektem TextLine.

Parametry

Powiązane elementy interfejsu API

Wskazuje, czy granica wyrazu znajduje się po lewej stronie atomu o określonym indeksie. Granice wyrazu są określane w oparciu o właściwości Unicode znaku pojawiającego się w wierszu.

Parametry

Pobiera pozycję określonej linii bazowej względem wartości TextBlock.baselineZero

Parametry

Powiązane elementy interfejsu API

Zwraca pierwszy obiekt TextLineMirrorRegion w wierszu, którego właściwość mirror jest zgodna z określoną przez parametr mirror, lub wartość null w przypadku braku zgodności.

Nawet pojedynczy obiekt TextElement może wytwarzać wiele obiektów TextLineMirrorRegion w jednym lub większej liczbie wierszy w zależności od poziomu dwukierunkowości i sposobu podziałów wierszy. Właściwości nextRegion i previousRegion łączą wszystkie obszary odbicia utworzone z jednego elementu tekstowego.

Parametry

Powiązane elementy interfejsu API

Maksymalna żądana szerokość wiersza tekstu w pikselach. Metoda TextBlock.createTextLine() korzysta z tej stałej jako z wartości domyślnej dla parametru width, jeśli nie zostanie określona jego wartość.

Powiązane elementy interfejsu API

1. Dodaj składnik NumericStepper do biblioteki.
2. Zapisz ten kod jako plik TextLineExample.as w tym samym katalogu, co plik FLA.
3. Ustaw klasę w oknie Właściwości pliku FLA na wartość ListEventExample.

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 flash.text.engine.FontWeight;
    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 fontDescriptionItalic:FontDescription = new FontDescription("Arial", FontWeight.NORMAL, FontPosture.ITALIC);
        private var fontDescriptionNormal:FontDescription = new FontDescription("Arial", FontWeight.NORMAL , FontPosture.NORMAL);
        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.";
            
            var formatItalic:ElementFormat = new ElementFormat(fontDescriptionItalic);
            formatItalic.fontSize = 12;
            var textElement1:TextElement = new TextElement(directions, formatItalic);
            textBlock.content = textElement1;
            createLines(textBlock, 15, 160, 400, this);
            
            var formatNormal:ElementFormat = new ElementFormat(fontDescriptionNormal);
            formatNormal.fontSize = 16;
            var textElement2:TextElement = new TextElement(myText, formatNormal);
            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 = new ElementFormat(fontDescriptionNormal);
            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 textElement3:TextElement = new TextElement(atomInfo, format);
            atomtextBlock.content = textElement3;
            createLines(atomtextBlock,20,200,500, atomDataContainer)
            addChild(atomDataContainer);
        }
            
        private function removeAtom(textLine):void
        {
            textLine.removeChild(textLine.userData);
        }
    }    
}