ActionScript® 3.0 Referenzhandbuch für die Adobe® Flash®-Plattform
Home  |  Liste der Pakete und Klassen ausblenden |  Pakete  |  Klassen  |  Neue Funktionen  |  Stichwortverzeichnis  |  Anhänge  |  Warum auf Englisch?
Filter: Daten werden vom Server abgerufen...
Daten werden vom Server abgerufen...
flashx.textLayout.events 

FlowOperationEvent  - AS3

Paketflashx.textLayout.events
Klassepublic class FlowOperationEvent
VererbungFlowOperationEvent Inheritance Event Inheritance Object

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Eine TextFlow-Instanz löst dieses Ereignis aus, direkt bevor ein Vorgang beginnt und direkt nachdem der Vorgang abgeschlossen wurde. Obwohl das Ereignisobjekt, das in beiden Klassen ausgelöst wurde, eine Instanz von FlowOperationEvent ist, unterscheiden sich die vor und nach dem Vorgang ausgelösten Ereignisse in signifikanter Weise.

Bevor ein Vorgang durchgeführt wird, löst ein TextFlow-Objekt ein FlowOperationEvent aus, wobei dessen type-Eigenschaft auf Folgendes gesetzt ist: FlowOperationEvent.FLOW_OPERATION_BEGIN. Sie können bestimmen, welcher Vorgangstyp gerade beginnt, indem Sie die operation-Eigenschaft überprüfen. Ereignisse vom Typ FLOW_OPERATION_BEGIN können abgebrochen werden, d. h., wenn Sie entscheiden, dass dieser Vorgang abgebrochen werden soll, können Sie Event.PreventDefault() zum Abbruch des Vorgangs aufrufen. Wenn Sie den Vorgang abbrechen, wird der Vorgang nicht durchgeführt und das FLOW_OPERATION_END-Ereignis wird nicht ausgelöst. Sie können auch einen Rückruf in den EditManager ausführen, um einen weiteren Vorgang auszuführen, bevor der Vorgang, der das Ereignis ausgelöst hat, abgeschlossen ist. In diesem Fall werden die in Ihrer Ereignisprozedur gestarteten Vorgänge zusammen mit dem Vorgang, der das Ereignis ausgelöst hat, rückgängig gemacht.

Wenn Sie den Vorgang fortsetzen, löst TextFlow nach Abschluss des Vorgangs ein FlowOperationEvent aus, wobei seine type-Eigenschaft auf FlowOperationEvent.FLOW_OPERATION_END gesetzt ist. Dieses Ereignis wird ausgelöst, bevor Flash Player Fehler ausgibt, die möglicherweise als Ergebnis des Vorgangs aufgetreten sind. Dies gibt Ihnen die Möglichkeit, den Fehler zu verarbeiten, bevor Flash Player ihn ausgibt. Sie können auf den Fehler über die error-Eigenschaft des Ereignisses zugreifen. Wenn Sie sich entscheiden, den Fehler in Ihrer Ereignisprozedur zu verarbeiten, können Sie Flash Player daran hindern, den Fehler auszugeben, indem Sie das FLOW_OPERATION_END-Ereignis durch Aufrufen von Event.preventDefault() abbrechen. Sie können auch einen Rückruf in den EditManager ausführen, um einige zusätzliche Vorgänge auszuführen. In diesem Fall werden die resultierenden Vorgänge als eine Einheit mit dem Vorgang, der das Ereignis ausgelöst hat, rückgängig gemacht.

Beispiele anzeigen

Verwandte API-Elemente



Öffentliche Eigenschaften
 EigenschaftDefiniert von
 Inheritedbubbles : Boolean
[schreibgeschützt] Gibt an, ob es sich bei dem Ereignis um ein Bubbling-Ereignis handelt.
Event
 Inheritedcancelable : Boolean
[schreibgeschützt] Gibt an, ob das mit dem Ereignis verknüpfte Verhalten verhindert werden kann.
Event
 Inheritedconstructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.
Object
 InheritedcurrentTarget : Object
[schreibgeschützt] Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
Event
  error : Error
Der ggf. während eines Vorgangs ausgegebene Fehler.
FlowOperationEvent
 InheritedeventPhase : uint
[schreibgeschützt] Die aktuelle Phase im Ereignisablauf.
Event
  level : int
Operationen können durch Verschachteln zu zusammengesetzten Operationen zusammengeführt werden.
FlowOperationEvent
  operation : FlowOperation
Der Vorgang, der aktuell startet oder gerade beendet wurde.
FlowOperationEvent
 Inheritedtarget : Object
[schreibgeschützt] Das Ereignis-Ziel.
Event
 Inheritedtype : String
[schreibgeschützt] Der Ereignistyp.
Event
Öffentliche Methoden
 MethodeDefiniert von
  
FlowOperationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, operation:FlowOperation = null, level:int = 0, error:Error = null)
Erstellt ein Ereignis-Objekt, das Informationen über einen flow-Vorgang enthält.
FlowOperationEvent
 Inherited
Dupliziert eine Instanz einer Event-Unterklasse.
Event
 Inherited
formatToString(className:String, ... arguments):String
Eine Dienstprogrammfunktion zur Implementierung der toString()-Methode in benutzerdefinierten ActionScript 3.0 Event-Klassen.
Event
 Inherited
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.
Object
 Inherited
Überprüft, ob die preventDefault()-Methode bei dem Ereignis aufgerufen wurde.
Event
 Inherited
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.
Object
 Inherited
Bricht das Standardverhalten eines Ereignisses ab, wenn dieses Verhalten abgebrochen werden kann.
Event
 Inherited
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.
Object
 Inherited
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.
Object
 Inherited
Verhindert die Verarbeitung von Ereignis-Listenern im aktuellen Knoten und in Knoten, die dem aktuellen Knoten im Ereignisablauf nachfolgen.
Event
 Inherited
Verhindert die Verarbeitung von Ereignis-Listenern in Knoten, die dem aktuellen Knoten im Ereignisablauf nachfolgen.
Event
 Inherited
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.
Object
 Inherited
Gibt eine Zeichenfolge zurück, die alle Eigenschaften des Ereignisobjekts enthält.
Event
 Inherited
Gibt den Grundwert des angegebenen Objekts zurück.
Object
Öffentliche Konstanten
 KonstanteDefiniert von
  FLOW_OPERATION_BEGIN : String = "flowOperationBegin"
[statisch] Definiert den Wert der type-Eigenschaft eines flowOperationBegin-Ereignisobjekts.
FlowOperationEvent
  FLOW_OPERATION_COMPLETE : String = "flowOperationComplete"
[statisch] Definiert den Wert der type-Eigenschaft eines flowOperationComplete-Ereignisobjekts.
FlowOperationEvent
  FLOW_OPERATION_END : String = "flowOperationEnd"
[statisch] Definiert den Wert der type-Eigenschaft eines flowOperationEnd-Ereignisobjekts.
FlowOperationEvent
Eigenschaftendetails

error

Eigenschaft
error:Error

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Der ggf. während eines Vorgangs ausgegebene Fehler. Wenn während eines Vorgangs ein Fehler auftritt, wird ein Verweis zum error-Objekt an das FLOW_OPERATION_END-Event angefügt. Dies gibt Ihnen die Möglichkeit, den Fehler zu verarbeiten, bevor Flash Player ihn ausgibt. Wenn Sie das Ereignis abbrechen, gibt Flash Player keinen Fehler aus.



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

level

Eigenschaft 
level:int

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Operationen können durch Verschachteln zu zusammengesetzten Operationen zusammengeführt werden. Dieser Kennzeichner beschreibt die Verschachtelungsebene der Operation.



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

operation

Eigenschaft 
operation:FlowOperation

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Der Vorgang, der aktuell startet oder gerade beendet wurde.



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

Verwandte API-Elemente

Konstruktordetails

FlowOperationEvent

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

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Erstellt ein Ereignis-Objekt, das Informationen über einen flow-Vorgang enthält.

Parameter
type:String — Der Ereignistyp. Ereignis-Listener können über die übernommene Eigenschaft type auf diese Informationen zugreifen. Es gibt zwei Typen: FlowOperationEvent.FLOW_OPERATION_BEGIN; FlowOperationEvent.FLOW_OPERATION_END.
 
bubbles:Boolean (default = false) — Gibt an, ob ein Ereignis propagiert werden kann. Dieses Ereignis propagiert nicht.
 
cancelable:Boolean (default = false) — Gibt an, ob das mit dem Ereignis verknüpfte Verhalten verhindert werden kann. Dieses Ereignis kann abgebrochen werden, indem Sie die Event.preventDefault()-Methode in Ihrer Ereignisprozedur-Funktion aufrufen.
 
operation:FlowOperation (default = null) — Die FlowOperation, die aktuell startet oder gerade beendet wurde.
 
level:int (default = 0) — Ein Fehler, der während des Vorgangs auftrat.
 
error:Error (default = null)
Konstantendetails

FLOW_OPERATION_BEGIN

Konstante
public static const FLOW_OPERATION_BEGIN:String = "flowOperationBegin"

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Definiert den Wert einer type-Eigenschaft eines flowOperationBegin-Ereignisobjekts, das vor der Ausführung eines Vorgangs ausgelöst wird. Der Abbruch dieses Ereignisses blockt den Vorgang.

FLOW_OPERATION_COMPLETE

Konstante 
public static const FLOW_OPERATION_COMPLETE:String = "flowOperationComplete"

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Definiert den Wert der type-Eigenschaft eines flowOperationComplete-Ereignisobjekts. Wird abgesetzt, nachdem alle Operationen einschließlich ausstehender und zusammengesetzter Operationen abgeschlossen sind, der Satz fertig gestellt und die Anzeige gescrollt wurde.

FLOW_OPERATION_END

Konstante 
public static const FLOW_OPERATION_END:String = "flowOperationEnd"

Sprachversion: ActionScript 3.0
Laufzeitversionen: Flash Player 10, AIR 1.5

Definiert den Wert einer type-Eigenschaft eines flowOperationEnd-Ereignisobjekts, das nach der Beendigung eines Vorgangs ausgelöst wird. Fehler werden in OperationEvent.error gespeichert. Falls ein Fehler auftritt, blockiert der Abbruch dieses Ereignisses die erneute Ausgabe des Fehlers. Im Allgemeinen haben Fehler fatale Folgen.

Das Ändern eines Vorgangs an dieser Stelle (nachdem er ausgeführt wurde) schlägt möglicherweise fehl.

FlowOperationEvent_example.as

In diesem Beispiel wird beschrieben, wie eine Ereignisprozedur erstellt wird, die auf den Anfang und das Ende eines Texflussvorgangs wartet. Die zwei entscheidenden Schritte sind, die addEventListener()-Methode für den Textfluss aufzurufen und eine Ereignisprozedur-Funktion zu erstellen.

Der Aufruf an addEventListener() wird an die TextFlow-Instanz gerichtet. Sie können den einfachen String "flowOperationBegin" oder "flowOperationEnd" verwenden, aber es ist sicherer, die statische Konstante FlowOperationEvent.FLOW_OPERATION_BEGIN bzw. FlowOperationEvent.FLOW_OPERATION_END zu verwenden.

Die Ereignisprozedurfunktionen in diesem Beispiel heißen opBeginHandler() und opEndHandler(). Die opBeginHandler()-Methode verwendet die trace()-Funktion, um eine trace-Anweisung zu erstellen, die bedeutet, dass ein Einfügevorgang gestartet wurde. Die opEndHandler()-Methode verwendet auch die trace()-Funktion, aber erstellt nur eine trace-Anweisung, wenn ein Fehler auftritt.

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 ]Warum auf Englisch?
Inhalt des ActionScript 3.0-Referenzhandbuchs wird in englischer Sprache angezeigt

Nicht alle Teile des ActionScript 3.0-Referenzhandbuchs wurden in alle Sprachen übersetzt. Wenn der Text zu einem Sprachelement nicht übersetzt wurde, wird er auf Englisch angezeigt. Zum Beispiel wurden die Informationen zur ga.controls.HelpBox-Klasse nicht in andere Sprachen übersetzt. In der deutschen Version des Referenzhandbuchs erscheint der Abschnitt zur ga.controls.HelpBox-Klasse deshalb auf Englisch.