ActionScript® 3.0 — dokumentacja dla platformy Adobe® Flash®
Strona główna  |  Ukryj listę pakietów i klas |  Pakiety  |  Klasy  |  Nowości  |  Indeks  |  Dodatki  |  Dlaczego język angielski?
Filtry: Pobieranie danych z serwera...
Pobieranie danych z serwera...
flashx.textLayout.events 

FlowOperationEvent  - AS3

Pakietflashx.textLayout.events
Klasapublic class FlowOperationEvent
DziedziczenieFlowOperationEvent Inheritance Event Inheritance Object

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Instancja klasy TextFlow wywołuje to zdarzenie tuż przed rozpoczęciem operacji oraz tuż po zakończeniu operacji. Obiekt zdarzenia wywoływany w obydwu klasach jest instancją klasy FlowOperationEvent, ale zdarzenia wywoływane przed operacją i po operacji znacznie się od siebie różnią.

Przed wykonaniem operacji obiekt TextFlow wywołuje zdarzenie FlowOperationEvent, którego właściwość type jest ustawiona na FlowOperationEvent.FLOW_OPERATION_BEGIN. Typ operacji rozpoczęcia można określić, sprawdzając właściwość operation. Zdarzenia typu FLOW_OPERATION_BEGIN mogą być anulowane, co oznacza, że jeśli użytkownik zdecyduje o tym, że operacja nie powinna być kontynuowana, może wywołać metodę Event.PreventDefault() w celu anulowania operacji. Po anulowaniu operacja nie jest wykonywana, a zdarzenie FLOW_OPERATION_END nie jest wywoływane. Możliwe jest również zwrotne wywołanie menedżera EditManager w celu wykonania dodatkowej operacji przed wykonaniem konkretnej operacji w zdarzeniu. W takim przypadku operacje inicjowane w funkcji obsługi zdarzenia zostaną wycofane jako pojedyncza operacja razem z operacją wywołującą zdarzenie.

Jeśli użytkownik zezwoli na wykonanie operacji, wówczas klasa TextFlow wywoła zdarzenie FlowOperationEvent po zakończeniu operacji z właściwością type ustawioną na FlowOperationEvent.FLOW_OPERATION_END. To zdarzenie zostanie wywołane, zanim program Flash Player zgłosi błędy, które mogły wystąpić w wyniku tej operacji. Dzięki temu użytkownik może przetworzyć błąd, zanim program Flash Player go zgłosi. Dostęp do błędu można uzyskać za pośrednictwem właściwości error zdarzenia. Jeśli użytkownik wybierze opcję obsługi zdarzenia w procedurze obsługi zdarzeń, może zapobiec zgłoszeniu błędu przez program Flash Player. W tym celu należy anulować zdarzenie FLOW_OPERATION_END, wywołując metodę Event.preventDefault(). Możliwe jest również wywołanie zwrotne menedżera EditManager w celu wykonania dodatkowych operacji. W takim przypadku operacje wynikowe zostaną wycofane razem z operacją wywołującą zdarzenie.

Wyświetl przykłady

Powiązane elementy interfejsu API



Właściwości publiczne
 WłaściwośćZdefiniowane przez
 Inheritedbubbles : Boolean
[tylko do odczytu] Określa, czy zdarzenie może przechodzić fazę propagacji.
Event
 Inheritedcancelable : Boolean
[tylko do odczytu] Wskazuje, czy można uniemożliwić operacje skojarzone ze zdarzeniem.
Event
 Inheritedconstructor : Object
Odwołanie do obiektu klasy lub funkcji konstruktora, dotyczące danej instancji obiektu.
Object
 InheritedcurrentTarget : Object
[tylko do odczytu] Obiekt przetwarzający aktywnie obiekt Event za pomocą detektora zdarzeń.
Event
  error : Error
Błąd zgłaszany (jeśli się pojawił) podczas operacji.
FlowOperationEvent
 InheritedeventPhase : uint
[tylko do odczytu] Bieżąca faza przepływu zdarzeń.
Event
  level : int
Operacje mogą być scalane w operacje złożone poprzez zagnieżdżanie.
FlowOperationEvent
  operation : FlowOperation
Operacja, która ma zostać rozpoczęta lub która właśnie się zakończyła.
FlowOperationEvent
 Inheritedtarget : Object
[tylko do odczytu] Miejsce docelowe zdarzenia.
Event
 Inheritedtype : String
[tylko do odczytu] Typ zdarzenia.
Event
Metody publiczne
 MetodaZdefiniowane przez
  
FlowOperationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, operation:FlowOperation = null, level:int = 0, error:Error = null)
Tworzy obiekt zdarzenia, który zawiera informacje o operacji przepływu.
FlowOperationEvent
 Inherited
Powiela instancję podklasy Event.
Event
 Inherited
formatToString(className:String, ... arguments):String
Funkcja narzędziowa umożliwiająca implementację metody toString() w niestandardowych klasach Event w języku ActionScript 3.0.
Event
 Inherited
Wskazuje, czy dla obiektu zdefiniowano określoną właściwość.
Object
 Inherited
Sprawdza, czy w odniesieniu do tego zdarzenia wywołano metodę preventDefault().
Event
 Inherited
Wskazuje, czy instancja klasy Object należy do łańcucha prototypów obiektu określonego jako parametr.
Object
 Inherited
Anuluje domyślne ustawienia zdarzenia, o ile zachowanie to może być anulowane.
Event
 Inherited
Wskazuje, czy określona właściwość istnieje i jest przeliczalna.
Object
 Inherited
Ustawia dostępność właściwości dynamicznej używanej w pętlach.
Object
 Inherited
Zapobiega przetwarzaniu wszelkich detektorów zdarzeń w węźle bieżącym i węzłach następujących po nim.
Event
 Inherited
Zapobiega przetwarzaniu wszelkich detektorów zdarzeń w węzłach następujących po węźle bieżącym w przepływie zdarzeń.
Event
 Inherited
Zwraca ciąg reprezentujący obiekt — sformatowany zgodnie z konwencjami właściwymi dla ustawień regionalnych.
Object
 Inherited
Zwraca ciąg znaków, który zawiera wszystkie właściwości obiektu Event.
Event
 Inherited
Zwraca pierwotną wartość dla określonego obiektu.
Object
Stałe publiczne
 StałaZdefiniowane przez
  FLOW_OPERATION_BEGIN : String = "flowOperationBegin"
[statyczny] Definiuje wartość właściwości type obiektu zdarzenia flowOperationBegin.
FlowOperationEvent
  FLOW_OPERATION_COMPLETE : String = "flowOperationComplete"
[statyczny] Definiuje wartość właściwości type obiektu zdarzenia flowOperationComplete.
FlowOperationEvent
  FLOW_OPERATION_END : String = "flowOperationEnd"
[statyczny] Definiuje wartość właściwości type obiektu zdarzenia flowOperationEnd.
FlowOperationEvent
Szczegół właściwości

error

właściwość
error:Error

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Błąd zgłaszany (jeśli się pojawił) podczas operacji. Jeśli błąd pojawi się podczas operacji, wówczas do zdarzenia FLOW_OPERATION_END zostanie dołączone odniesienie do obiektu błędu. Dzięki temu użytkownik może zająć się błędem, zanim program Flash Player go zgłosi. W przypadku anulowania zdarzenia program Flash Player nie zgłasza błędu.



Implementacja
    public function get error():Error
    public function set error(value:Error):void

level

właściwość 
level:int

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Operacje mogą być scalane w operacje złożone poprzez zagnieżdżanie. Ta flaga określa poziom zagnieżdżania operacji.



Implementacja
    public function get level():int
    public function set level(value:int):void

operation

właściwość 
operation:FlowOperation

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Operacja, która ma zostać rozpoczęta lub która właśnie się zakończyła.



Implementacja
    public function get operation():FlowOperation
    public function set operation(value:FlowOperation):void

Powiązane elementy interfejsu API

Konstruktor Szczegół

FlowOperationEvent

()Konstruktor
public function FlowOperationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, operation:FlowOperation = null, level:int = 0, error:Error = null)

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Tworzy obiekt zdarzenia, który zawiera informacje o operacji przepływu.

Parametry
type:String — Typ zdarzenia. Detektory zdarzeń mogą uzyskiwać dostęp do tej informacji za pośrednictwem dziedziczonej właściwości type. Istnieją dwa typy zdarzeń: FlowOperationEvent.FLOW_OPERATION_BEGIN; FlowOperationEvent.FLOW_OPERATION_END.
 
bubbles:Boolean (default = false) — Określa, czy zdarzenie jest zdarzeniem propagowanym. To zdarzenie nie jest propagowane.
 
cancelable:Boolean (default = false) — Wskazuje, czy można uniemożliwić operacje skojarzone ze zdarzeniem. To zdarzenie można anulować poprzez wywołanie metody Event.preventDefault() w funkcji procedury obsługi zdarzeń.
 
operation:FlowOperation (default = null) — Operacja FlowOperation, która ma zostać rozpoczęta lub która właśnie się zakończyła.
 
level:int (default = 0) — Błąd generowania podczas operacji.
 
error:Error (default = null)
Szczegół stałej

FLOW_OPERATION_BEGIN

Stała
public static const FLOW_OPERATION_BEGIN:String = "flowOperationBegin"

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Definiuje wartość właściwości type obiektu zdarzenia flowOperationBegin wywołanego przed wykonaniem operacji. Anulowanie tego zdarzenia powoduje zablokowanie operacji.

FLOW_OPERATION_COMPLETE

Stała 
public static const FLOW_OPERATION_COMPLETE:String = "flowOperationComplete"

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Definiuje wartość właściwości type obiektu zdarzenia flowOperationComplete. Wywoływane po zakończeniu wszystkich operacji, w tym operacji oczekujących i określania układu, po zakończeniu określania układu i przewinięcia ekranu.

FLOW_OPERATION_END

Stała 
public static const FLOW_OPERATION_END:String = "flowOperationEnd"

Wersja języka: ActionScript 3.0
Wersje środowiska wykonawczego: Flash Player 10, AIR 1.5

Definiuje wartość właściwości type obiektu zdarzenia flowOperationEnd wywoływanego po wykonaniu operacji. Wszelkie błędy są zapisywane we właściwości OperationEvent.error. W przypadku błędu anulowanie tego zdarzenia powoduje zablokowanie ponownego generowania zdarzenia. Zasadniczo każdy błąd może być fatalny.

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

FlowOperationEvent_example.as

Ten przykład przedstawia, w jaki sposób utworzyć detektor zdarzeń do wykrywania początku i końca operacji przepływu tekstu. Dwa główne kroki są przeznaczone do wywołania metody addEventListener() w przepływie tekstu oraz do utworzenia funkcji procedury obsługi zdarzenia.

Wywołanie metody addEventListener() jest realizowane w instancji klasy TextFlow. Można użyć prostego ciągu "flowOperationBegin" lub "flowOperationEnd", ale bezpieczniejsze jest użycie odpowiednio statycznej stałej FlowOperationEvent.FLOW_OPERATION_BEGIN lub FlowOperationEvent.FLOW_OPERATION_END.

Funkcje detektora zdarzeń w tym przykładzie mają nazwy opBeginHandler() i opEndHandler(). Metoda opBeginHandler() używa funkcji trace() w celu wyświetlenia tekstu informującego o rozpoczęciu operacja wklejania. Metoda opEndHandler() również używa funkcji trace(), jednak tekst jest wyświetlany tylko w przypadku wystąpienia błędu.

package flashx.textLayout.events.examples
{
    import flash.display.Sprite;
    
    import flashx.textLayout.compose.StandardFlowComposer;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.edit.EditManager;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.events.FlowOperationEvent;
    import flashx.textLayout.operations.FlowOperation;
    import flashx.textLayout.operations.PasteOperation;
    import flashx.undo.UndoManager;

    public class FlowOperationEvent_example extends Sprite
    {
        private var inputContainer:Sprite;
        private var inputTextFlow:TextFlow;
        private var inputController:ContainerController;
        private var inputEditManager:EditManager;
        private var inputUndoManager:UndoManager;

        public function FlowOperationEvent_example()
        {
            var replaceText:String = "paste text here";
            inputTextFlow = new TextFlow();

            inputContainer = new Sprite();
            inputContainer.x = 30;
            inputContainer.y = 100;

             this.stage.addChild( inputContainer );

            inputController = new ContainerController(inputContainer, 225, 20);
            inputController.verticalScrollPolicy = flashx.textLayout.container.ScrollPolicy.OFF;

            inputTextFlow = TextConverter.importToFlow(replaceText, TextConverter.PLAIN_TEXT_FORMAT);
            inputTextFlow.flowComposer = new StandardFlowComposer(); 
            inputTextFlow.flowComposer.addController(inputController);

            inputUndoManager = new UndoManager();
            inputEditManager = new EditManager(inputUndoManager);
            inputTextFlow.interactionManager = inputEditManager;

            inputTextFlow.addEventListener(FlowOperationEvent.FLOW_OPERATION_BEGIN, opBeginHandler);
            inputTextFlow.addEventListener(FlowOperationEvent.FLOW_OPERATION_END, opEndHandler);
            inputTextFlow.flowComposer.updateAllControllers();
        }

        private function opBeginHandler(evt:FlowOperationEvent):void { 
            var flowOp:FlowOperation = evt.operation; 
            if(flowOp is PasteOperation) {
                trace("You can cancel or modify the paste operation in this event handler.");
            }
        }

        private function opEndHandler(evt:FlowOperationEvent):void { 
            var flowOp:FlowOperation = evt.operation; 
            if(evt.error) {
                trace("You can handle the error here and call preventDefault().");
            }
        }
    }
}




[ X ]Dlaczego język angielski?
Treść dokumentacji języka ActionScript 3.0 wyświetlana w języku angielskim

Niektóre części dokumentacji języka ActionScript 3.0 nie są przetłumaczone na poszczególne języki. Gdy element nie jest przetłumaczony na dany język, jest wyświetlany tekst angielski. Na przykład opis klasy ga.controls.HelpBox nie jest przetłumaczony na żaden dodatkowy język. Z tego powodu polska wersja dokumentacji zawiera opis klasy ga.controls.HelpBox w języku angielskim.