TextFlow  - AS3

Obiekt Configuration dla tego obiektu TextFlow. Obiekt Configuration określa początkowe formaty dla znaków i akapitów, początkowy format kontenera, a także atrybuty dla podświetlania, łączy, fokusu i przewijania zaznaczenia.

Jeśli obiekt Configuration nie zostanie określony, specyfikacja Text Layout Framework wykorzysta domyślny obiekt Configuration, do którego będzie się odwoływać właściwość defaultConfiguration.

Powiązane elementy interfejsu API

Domyślna konfiguracja dla wszystkich nowych obiektów TextFlow, jeśli konfiguracja nie jest określona.

Powiązane elementy interfejsu API

Zarządza kontenerami dla danego elementu.

Tworzone z elementu obiekty TextLine pojawiają się jako elementy podrzędne kontenera flowComposer zarządza kontenerami, a w miarę edytowania tekstu edytuje i usuwa wiersze z kontenerów. Ponadto flowComposer śledzi niektóre krytyczne atrybuty, takie jak maksymalna szerokość i wysokość układu, aktywność przewijania itp.

Kontener i układacz flowComposer są ze sobą blisko powiązane. W przypadku zresetowania układacza flowComposer kontener zostanie zresetowany do postaci nowego kontenera flowComposer. I podobnie — jeśli dojdzie do zresetowania kontenera, układacz flowComposer zostanie zresetowany do postaci nowego układacza flowComposer kontenera.

Powiązane elementy interfejsu API

Funkcja wywołania zwrotnego przeznaczona do rozwiązywania stylów elementu. Z tej funkcji można skorzystać na przykład w celu udostępniania stylów CSS lub nazwanych stylów.

Powiązane elementy interfejsu API

Numer generowania dla obiektu TextFlow. Operacje cofania i ponawiania wykorzystują ten numer generowania w celu sprawdzenia, czy wycofanie lub ponowienie operacji jest dozwolone. Numery generowania muszą być zgodne.

Każda zmiana modelu powoduje zwiększenie wartości generation, więc w przypadku zmiany numeru generowania wiadomo, że zmianie uległ model TextFlow.

Obiekt TextLayoutFormat dla danego obiektu TextFlow. Umożliwia wykonanie kilku operacji optymalizacji dla ponownego wykorzystania formatów hosta. Na przykład;

        textFlowA.hostFormat = textFlowB.hostFormat
        

        format = new TextLayoutFormat()
        textFlow.hostFormat = format
        format.fontSize = 24;
        

Powiązane elementy interfejsu API

InteractionManager skojarzony z obiektem TextFlow.

Określa wszystkie operacje zaznaczania i edycji w tekście. Jeśli nie można zaznaczyć obiektu TextFlow, interactionManager ma wartość null. Aby umożliwić edycję obiektu TextFlow, należy przypisać obiekt interactionManager, który jest jednocześnie ISelectionManager oraz IEditManager. Aby utworzyć obiekt TextFlow dostępny tylko do odczytu, w którym możliwe jest zaznaczanie, należy przypisać obiekt interactionManager będący tylko ISelectionManager.

Powiązane elementy interfejsu API

Konstruktor — tworzy nową instancję klasy TextFlow.

W przypadku udostępnienia parametru config zawartość obiektu Configuration zostaje skopiowana i nie można wprowadzić zmian. Dostęp do ustawień konfiguracji można uzyskać tylko za pośrednictwem właściwości configuration. Jeśli parametr config ma wartość null, dostęp do domyślnych ustawień konfiguracji można uzyskać za pośrednictwem właściwości defaultConfiguration.

Obiekt Configuration udostępnia mechanizm przeznaczony do ustawiania w TextFlow domyślnych atrybutów, które można konfigurować. Obiektu Configuration nie można zmieniać, ale w razie potrzeby można przesłaniać atrybuty domyślne poprzez ustawianie atrybutów obiektu TextFlow oraz jego elementów podrzędnych.

Powiązane elementy interfejsu API

Rejestruje obiekt detektora zdarzenia w obiekcie EventDispatcher, dzięki czemu detektor będzie otrzymywał powiadomienia o zdarzeniu. We wszystkich węzłach listy wyświetlania można rejestrować detektory zdarzeń reagujące na zdarzenia konkretnego typu, znajdujące się w określonej fazie i mające określony priorytet.

Po pomyślnym zarejestrowaniu detektora zdarzeń nie można zmienić jego priorytetu przez dodatkowe wywołania metody addEventListener(). Aby zmienić priorytet detektora, należy najpierw wywołać metodę removeEventListener(). Następnie można ponownie zarejestrować detektor z nowym poziomem priorytetu.

Po zarejestrowaniu detektora późniejsze wywołania metody addEventListener() z różnymi wartościami type albo useCapture powodują rejestrowanie odrębnych detektorów. Na przykład detektor zarejestrowany z parametrem useCapture ustawionym na true wykrywa tylko zdarzenia w fazie przechwytywania. Po ponownym wywołaniu metody addEventListener() z tym samym obiektem detektora, ale z parametrem useCapture ustawionym na false będą istniały dwa odrębne detektory: jeden wykrywający zdarzenia w fazie przechwytywania, a drugi wykrywający zdarzenia w fazach miejsca docelowego i propagacji.

Nie można zarejestrować detektora zdarzeń, który wykrywałby tylko zdarzenia w fazie miejsca docelowego lub tylko zdarzenia w fazie propagacji. Te fazy są sprzężone podczas rejestracji, ponieważ propagacja zachodzi tylko w przodkach węzła miejsca docelowego.

Gdy detektor zdarzeń przestanie być potrzebny, należy go usunąć, wywołując metodę EventDispatcher.removeEventListener(); w przeciwnym razie mogą wystąpić problemy w zarządzaniu pamięcią. Obiekty z zarejestrowanymi detektorami zdarzeń nie są automatycznie usuwane z pamięci, ponieważ proces porządkowania pamięci nie usuwa obiektów, do których istnieją odwołania.

Skopiowanie instancji klasy EventDispatcher nie powoduje skopiowania detektorów zdarzeń dołączonych do tej instancji. (Jeśli utworzono nowy węzeł, dla którego potrzebny jest detektor zdarzeń, należy dołączyć detektor po utworzeniu węzła). Jednak przeniesienie instancji klasy EventDispatcher powoduje również przeniesienia dołączonych do niej detektorów zdarzeń

Jeśli detektor zdarzeń jest rejestrowany w węźle w momencie, gdy ten węzeł przetwarza zdarzenie, detektor nie zostanie wywołany w bieżącej fazie, ale może być wywołany w późniejszej fazie przepływu zdarzeń, np. w fazie propagacji.

Jeśli detektor zdarzeń zostanie usunięty z węzła w momencie, gdy ten węzeł przetwarza zdarzenie, zostanie mimo tego wywołany przez bieżące operacje. Raz usunięty detektor zdarzeń nie jest nigdy ponownie wywoływany (chyba że zostanie ponownie zarejestrowany na potrzeby dalszego etapu wykonania programu).

Parametry

Wywołuje zdarzenie, tj. kieruje je do przepływu zdarzeń. Miejscem docelowym zdarzenia jest obiekt EventDispatcher, względem którego wywołano metodę dispatchEvent().

Parametry

Zwraca element, którego właściwość id jest zgodna z parametrem idName. Umożliwia zastosowanie stylu opartego na właściwości id.

Na przykład: poniższy wiersz ustawia styl "color" na 0xFF0000 (czerwony) dla elementu o właściwości id równej span1.

         textFlow.getElementByID("span1").setStyle("color", 0xFF0000);
         

Uwaga: W poniższym kodzie p.addChild(s) usuwa s z oryginalnego elementu nadrzędnego i dodaje s do p, nowego elementu nadrzędnego.

         var s:SpanElement = new SpanElement();
         var p:ParagraphElement = new ParagraphElement();
         ...
         s = textFlow.getElementByID("span3") as SpanElement;
         p.addChild(s);
         textFlow.addChild(p);
         

Parametry

Powiązane elementy interfejsu API

package flashx.textLayout.elements.examples {
    import flash.display.Sprite;
    
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class TextFlow_getElementByIDExample extends Sprite
    {
        public function TextFlow_getElementByIDExample()
        {    
            // create the TextFlow object
            var textFlow:TextFlow = new TextFlow();
            
            // xml markup that defines the attributes and contents of a text flow
            var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
            "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+
                "<flow:p>"+
                    "<flow:span id='span1'>In the first paragraph of the </flow:span>"+
                    "<flow:span id='span2' fontStyle=\"italic\">cheap </flow:span>"+
                    "<flow:span id='span3'>Western novel, a cowboy meets a saloon girl.</flow:span>"+
                "</flow:p>"+
            "</flow:TextFlow>";
            var s:SpanElement = new SpanElement();
            var s2:SpanElement = new SpanElement();
            var p:ParagraphElement = new ParagraphElement();
            // import the xml markup into a TextFlow object and display it on the stage
            textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT);
            // get element with ID of span3, make a copy of it
            textFlow.getElementByID("span3").setStyle("color", 0xFF0000); 
            textFlow.flowComposer.addController(new ContainerController(this, 200, 800));
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

            
            

Zwraca wszystkie elementy, dla których styleName jest ustawione na styleNameValue.

Parametry

Powiązane elementy interfejsu API

Zwraca wszystkie elementy, dla których właściwość typeName jest ustawiona na typeNameValue.

Parametry

Powiązane elementy interfejsu API

Sprawdza, czy obiekt EventDispatcher zawiera jakiekolwiek detektory zarejestrowane dla konkretnego typu zdarzeń. Umożliwia to określenie, w którym miejscu hierarchii przepływu zdarzeń w obiekcie EventDispatcher zmodyfikowana jest obsługa zdarzeń danego typu. Aby sprawdzić, czy zdarzenie określonego typu faktycznie wywoła detektor zdarzeń, należy użyć metody IEventDispatcher.willTrigger().

Różnica między metodą hasEventListener() a metodą willTrigger() polega na tym, że metoda hasEventListener() sprawdza tylko obiekt, do którego należy, natomiast metoda willTrigger() sprawdza cały przepływ zdarzenia określonego parametrem type.

Parametry

Unieważnia wszystkie dane formatowania dla TextFlow, wymuszając ponowne przetworzenie tych danych. Tę metodę należy wywołać w przypadku zmiany stylów.

Powiązane elementy interfejsu API

Usuwa detektor z obiektu EventDispatcher. Jeśli w obiekcie EventDispatcher nie ma zarejestrowanego zgodnego detektora zdarzeń, wywołanie tej metody nie odnosi żadnego skutku.

Parametry

Sprawdza, czy detektor zdarzeń określonego typu jest zarejestrowany w tym obiekcie EventDispatcher lub jego przodkach. Ta metoda zwraca wartość true, jeśli detektor zdarzeń będzie wywoływany w dowolnej fazie przepływu zdarzeń, gdy zdarzenie określonego typu zostanie wywołane w obiekcie EventDispatcher lub dowolnym z jego przodków.

Różnica między metodą hasEventListener() a metodą willTrigger() polega na tym, że metoda hasEventListener() sprawdza tylko obiekt, do którego należy, natomiast metoda willTrigger() sprawdza cały przepływ zdarzenia określonego parametrem type.

Parametry

Wywoływane po kliknięciu dowolnego łącza.

Wywoływane po każdej zmianie układu.

Wywoływane przez obiekt TextFlow za każdym razem, gdy zostanie on uszkodzony. Za pomocą tego zdarzenia można dowiedzieć się o zmianie obiektu TextFlow, ale po wysłaniu zdarzenia nie można uzyskać dostępu do samego obiektu TextFlow. To zdarzenie jest wysyłane, gdy zmiany obiektu TextFlow zostaną częściowo zakończone, dzięki czemu jego stan może być niejednakowy: niektóre zmiany zostały już zrealizowane, a inne nadal oczekują. Ze zdarzenia można pobrać wymagane informacje, a następnie wprowadzić żądane zmiany, gdy kontrolowanie aplikacji stanie się możliwe.

Zmiana operacji w takim czasie (po wykonaniu) może zakończyć się niepowodzeniem.

Wywoływane w przypadku zmiany rozmiaru InlineGraphicElement z powodu ustawienia dla szerokości lub wysokości opcji auto lub wartości procentowej, po zakończeniu ładowania grafiki.

Wywoływane po naciśnięciu przycisku myszy na dowolnym łączu.

Wywoływane przy przesunięciu wskaźnika myszy nad dowolnym łączem.

Wywoływane po zwolnieniu przycisku myszy nad dowolnym łączem.

Wywoływane po odsunięciu wskaźnika myszy poza łącze.

Wywoływane przy pierwszym ustawieniu wskaźnika myszy na dowolnym łączu.

Wywoływane przez obiekt TextFlow po przewinięciu tekstu w kontenerze kontrolera.

Wywoływane w przypadku zmiany zaznaczenia. Używane głównie do aktualizowania interfejsu użytkownika zależnego od zaznaczenia. Może także służyć do zmiany zaznaczenia, ale nie do zmiany samego obiektu TextFlow.

Wywoływane przez obiekt TextFlow za każdym razem, gdy do kontenera zostaną dodane nowe obiekty DisplayObject lub gdy obiekty te zostaną zaktualizowane w wyniku określania układu.