| Paket | mx.effects |
| Klasse | public class Effect |
| Vererbung | Effect  EventDispatcher Object |
| Implementiert | IEffect |
| Unterklassen | AddAction, AddChildAction, AddItemAction, Animate, CallAction, CompositeEffect, MaskEffect, RemoveAction, RemoveChildAction, RemoveItemAction, SetAction, SetPropertyAction, SetStyleAction, SoundEffect, TweenEffect, UnconstrainItemAction |
| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
In einer Anwendung erstellen Sie die Instanzen der Effect-Klasse nicht selbst. Stattdessen erstellen Sie eine Instanz einer Unterklasse wie Fade oder WipeLeft.
MXML-Syntax
MXML-Syntax anzeigen
MXML-Syntax ausblendenThe Effect class defines the following properties, which all of its subclasses inherit:
<mx:tagname
Properties
customFilter=""
duration="500"
filter=""
hideFocusRing="false"
perElementOffset="0"
repeatCount="1"
repeatDelay="0"
startDelay="0"
suspendBackgroundProcessing="false|true"
target="effect target"
targets="array of effect targets"
Events
effectEnd="No default"
efectStart="No default"
/>
Verwandte API-Elemente
| Eigenschaft | Definiert von | ||
|---|---|---|---|
| className : String [schreibgeschützt]
Name der Effektklasse wie „Fade“. | Effect | ||
 | constructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz. | Object | |
| customFilter : mx.effects:EffectTargetFilter
Gibt ein benutzerdefiniertes Filterobjekt des Typs EffectTargetFilter an, das zur Ermittlung der Ziele dient, bei denen der Effekt wiedergegeben wird. | Effect | ||
| duration : Number
Dauer des Effekts in Millisekunden. | Effect | ||
| effectTargetHost : mx.effects:IEffectTargetHost
Eine Eigenschaft, die Ihnen den Zugriff auf listenbasierte Zielsteuerelemente eines Dateneffekts ermöglicht. | Effect | ||
| filter : String
Gibt einen Algorithmus zum Filtern der Ziele für einen Effekt an. | Effect | ||
| hideFocusRing : Boolean
Bestimmt, ob der Effekt den Fokusring beim Start ausblenden soll. | Effect | ||
| instanceClass : Class
Ein Objekt der type-Klasse, das die Effektinstanzklasse für diese Effektklasse angibt. | Effect | ||
| isPlaying : Boolean [schreibgeschützt]
Ein Flag für den Schreibschutz, das auf „true“ gesetzt ist, wenn Instanzen des Effekts aktuell wiedergegeben werden, und andernfalls auf „false“. | Effect | ||
| perElementOffset : Number
Zusätzliche Verzögerung (in Millisekunden) für Effektziele nach dem ersten Ziel des Effekts. | Effect | ||
| playheadTime : Number
Aktuelle Zeitposition des Effekts. | Effect | ||
| relevantProperties : Array
Ein Array von Eigenschaftsnamen zur Verwendung beim Filtern. | Effect | ||
| relevantStyles : Array
Ein Array von Stilnamen zur Verwendung beim Filtern. | Effect | ||
| repeatCount : int = 1
Ein Wert, der angibt, wie oft der Effekt wiederholt werden soll. | Effect | ||
| repeatDelay : int = 0
Wartezeit in Millisekunden vor der Wiederholung des Effekts. | Effect | ||
| startDelay : int = 0
Wartezeit in Millisekunden vor dem Starten des Effekts. | Effect | ||
| suspendBackgroundProcessing : Boolean = false
Bei „true“ erfolgt keine Hintergrundverarbeitung, während der Effekt wiedergegeben wird. | Effect | ||
| target : Object
Das Objekt, auf das dieser Effekt angewendet wird. | Effect | ||
| targets : Array
Ein Array von Objekten, die als Ziele des Effekts verwendet werden können. | Effect | ||
| triggerEvent : Event
Der EffectManager übergibt diesem Effekt das Ereignisobjekt, wenn ein Effekt ausgelöst wird, oder null, wenn der Effekt nicht vom EffectManager wiedergegeben wird. | Effect | ||
| Eigenschaft | Definiert von | ||
|---|---|---|---|
| applyTransitionEndProperties : Boolean
Dieses Flag steuert, ob der Effekt, wenn er in einem Übergang ausgeführt wird, automatisch die Eigenschaftswerte des Endstatus anwendet, statt die durch den Effekt eingestellten Werte beizubehalten. | Effect | ||
| endValuesCaptured : Boolean = false
Wenn dieses Flag auf „true“ gesetzt ist, wurden die Werte eines Effekts bereits bestimmt. Bei „false“ werden die Werte beim Ausführen des Effekts aus den aktuellen Eigenschaften der Effektziele übernommen. | Effect | ||
| Methode | Definiert von | ||
|---|---|---|---|
Konstruktor. | Effect | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird. | EventDispatcher | |
Erfasst die aktuellen Werte der relevanten Eigenschaften der Ziele des Effekts und speichert sie als Endwerte. | Effect | ||
Erfasst die aktuellen Werte der relevanten Eigenschaften eines zusätzlichen Zielsatzes. Flex verwendet diese Funktion, wenn ein Datenänderungseffekt ausgeführt wird.
| Effect | ||
Erfasst die aktuellen Werte der relevanten Eigenschaften der Ziele des Effekts. | Effect | ||
Erstellt eine einzelne Effektinstanz und initialisiert sie. | Effect | ||
Verwendet ein Array von Zielobjekten und ruft die createInstance()-Methode auf jedem Ziel auf. | Effect | ||
Entfernt Ereignis-Listener von einer Instanz und entfernt sie aus der Liste der Instanzen. | Effect | ||
|
Sendet ein Ereignis in den Ereignisablauf. | EventDispatcher | |
Unterbricht einen aktuell wiedergegebenen Effekt und springt sofort zum Ende des Effekts. | Effect | ||
Gibt ein Array von Strings zurück, wobei jeder String dem Namen einer Eigenschaft entspricht, die von diesem Effekt geändert wird. | Effect | ||
|
Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat. | EventDispatcher | |
|
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde. | Object | |
|
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde. | Object | |
Hält den Effekt an, bis die resume()-Methode aufgerufen wird. | Effect | ||
Startet die Wiedergabe des Effekts. | Effect | ||
|
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann. | Object | |
|
Entfernt einen Listener aus dem EventDispatcher-Objekt. | EventDispatcher | |
Setzt den Effekt fort, nachdem er durch Aufrufen der pause()-Methode vorübergehend unterbrochen wurde. | Effect | ||
Gibt den aktuell wiedergegebenen Effekt rückwärts wieder und beginnt dabei an der aktuellen Position des Effekts. | Effect | ||
|
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest. | Object | |
Hält den Effekt an und behält den aktuellen Status der Effektziele bei. | Effect | ||
|
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas. | Object | |
|
Gibt das angegebene Objekt als String zurück. | Object | |
|
Gibt den Grundwert des angegebenen Objekts zurück. | Object | |
|
Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist. | EventDispatcher | |
| Methode | Definiert von | ||
|---|---|---|---|
Wird intern von der Effektinfrastruktur verwendet. | Effect | ||
Wird aufgerufen, wenn die Wiedergabe einer Effektinstanz abgeschlossen ist. | Effect | ||
Diese Methode wird aufgerufen, wenn die Wiedergabe der Effektinstanz beginnt. | Effect | ||
Wird aufgerufen, wenn eine Effektinstanz durch einen Aufruf der stop()-Methode angehalten wurde. | Effect | ||
Bestimmt die Logik zum Filtern einer Effektinstanz. | Effect | ||
Wird von der captureStartValues()-Methode aufgerufen, um den Wert einer Eigenschaft des Ziels abzurufen. | Effect | ||
Kopiert Eigenschaften des Effekts in die Effektinstanz. | Effect | ||
| Ereignis | Übersicht | Definiert von | ||
|---|---|---|---|---|
| [broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird. | EventDispatcher | ||
| [broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird. | EventDispatcher | ||
| Wird ausgelöst, wenn die Wiedergabe einer der Effektinstanzen beendet wurde, da die Instanz das Ende erreicht hatte oder da der Effekt durch den Aufruf der end()-Methode unterbrochen wurde. | Effect | |||
| Wird ausgelöst, wenn die Wiedergabe eines Effekts gestartet wird. | Effect | |||
| Wird ausgelöst, wenn der Effekt angehalten wurde. Dies geschieht nur, wenn der Effekt durch Aufrufen der stop()-Methode unterbrochen wird. | Effect | |||
applyTransitionEndProperties | Eigenschaft |
protected var applyTransitionEndProperties:Boolean| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Dieses Flag steuert, ob der Effekt, wenn er in einem Übergang ausgeführt wird, automatisch die Eigenschaftswerte des Endstatus anwendet, statt die durch den Effekt eingestellten Werte beizubehalten.
Der Standardwert ist true.
className | Eigenschaft |
className:String [schreibgeschützt] | Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Name der Effektklasse wie Fade.
Dies ist ein kurzer oder unqualifizierter Klassenname, der den Paketnamen nicht einschließt. Wenn Sie den qualifizierten Namen benötigen, verwenden Sie die getQualifiedClassName()-Methode im flash.utils-Paket.
Implementierung
public function get className():StringcustomFilter | Eigenschaft |
customFilter:mx.effects:EffectTargetFilter| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Gibt ein benutzerdefiniertes Filterobjekt des Typs EffectTargetFilter an, das zur Ermittlung der Ziele dient, bei denen der Effekt wiedergegeben wird.
Ziele werden nur gefiltert, wenn Sie die captureStartValues()-Methode aufrufen, bevor Sie den Effekt wiedergeben. Flex ruft die captureStartValues()-Methode automatisch auf, wenn der Effekt zu einem Übergang gehört.
Verwenden Sie die filter-Eigenschaft zum einfachen Filtern. Wenn die customFilter-Eigenschaft einen anderen Wert als null aufweist, wird die filter-Eigenschaft ignoriert.
Implementierung
public function get customFilter():mx.effects:EffectTargetFilter public function set customFilter(value:mx.effects:EffectTargetFilter):voidduration | Eigenschaft |
duration:Number| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Dauer des Effekts in Millisekunden.
Bei einem Parallel- oder Sequenzeffekt legt die duration-Eigenschaft die Dauer jedes Effekts fest. Wenn die duration-Eigenschaft eines Sequenzeffekts auf 3000 gesetzt wird, dauert die Wiedergabe jedes Effekts in der Sequenz 3000 Millisekunden.
Bei einem wiederholten Effekt gibt die duration-Eigenschaft die Dauer einer einzigen Instanz des Effekts an. Wenn die duration-Eigenschaft eines Effekts auf 2000 und die repeatCount-Eigenschaft auf 3 gesetzt ist, dauert die Wiedergabe des Effekts insgesamt 6000 Millisekunden (6 Sekunden).
Implementierung
public function get duration():Number public function set duration(value:Number):voideffectTargetHost | Eigenschaft |
effectTargetHost:mx.effects:IEffectTargetHost| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Eine Eigenschaft, die Ihnen den Zugriff auf listenbasierte Zielsteuerelemente eines Dateneffekts ermöglicht. Mit dieser Eigenschaft kann die Instanz einer Effektklasse mit dem listenbasierten Steuerelement kommunizieren, auf dem der Effekt wiedergegeben wird.
Implementierung
public function get effectTargetHost():mx.effects:IEffectTargetHost public function set effectTargetHost(value:mx.effects:IEffectTargetHost):voidendValuesCaptured | Eigenschaft |
protected var endValuesCaptured:Boolean = false| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Wenn dieses Flag auf true gesetzt ist, wurden die Werte eines Effekts bereits bestimmt. Bei false werden die Werte beim Ausführen des Effekts aus den aktuellen Eigenschaften der Effektziele übernommen. Diese Eigenschaft ist bei Dateneffekten erforderlich, da die Reihenfolge der Einrichtung für Dateneffekte wie DefaultListEffect und DefaultTileListEffect komplizierter als für normale Effekte ist.
Der Standardwert ist false.
filter | Eigenschaft |
filter:String| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Gibt einen Algorithmus zum Filtern der Ziele für einen Effekt an. Der Wert null gibt an, dass nicht gefiltert wird.
Ziele werden nur gefiltert, wenn Sie die captureStartValues()-Methode aufrufen, bevor Sie den Effekt wiedergeben. Flex ruft die captureStartValues()-Methode automatisch auf, wenn der Effekt zu einem Übergang oder einem Dateneffekt für ein listenbasiertes Steuerelement gehört.
Verwenden Sie diese Eigenschaft zum einfachen Filtern. Verwenden Sie die customFilter-Eigenschaft für anspruchsvollere Filtervorgänge. Wenn die customFilter-Eigenschaft einen anderen Wert als null aufweist, wird diese Eigenschaft ignoriert.
Sie können die folgenden Werte für die filter-Eigenschaft verwenden:
- Beim Wert
"add"wird der Effekt auf jedem Ziel wiedergegeben, das als untergeordnetes Element einem Container hinzugefügt wurde. - Beim Wert
"addItem"wird der Effekt auf dem Elementrenderer für jedes Listenelement wiedergegeben, das einem List- oder TileList-Steuerelement hinzugefügt wurde. - Beim Wert
"hide"wird der Effekt auf jedem Ziel wiedergegeben, dessen visible-Eigenschaft sich vontrueinfalsegeändert hat. - Beim Wert
"move"wird der Effekt auf jedem Ziel wiedergegeben, dessenx- odery-Eigenschaft geändert wurde. - Beim Wert
"remove"wird der Effekt auf jedem Ziel wiedergegeben, das als untergeordnetes Element eines Containers entfernt wurde. - Beim Wert
"removeItem"wird der Effekt auf dem Elementrenderer jedes Listenelements wiedergegeben, das aus einem List- oder TileList-Steuerelement entfernt wurde. - Beim Wert
"replacedItem"wird der Effekt auf dem Elementrenderer jedes Listenelements wiedergegeben, das in einem List- oder TileList-Steuerelement durch ein neues Element ersetzt wurde. - Beim Wert
"replacementItem"wird der Effekt auf dem Elementrenderer jedes Listenelements wiedergegeben, das ein vorhandenes Element in einem List- oder TileList-Steuerelement ersetzt. - Beim Wert
"resize"wird der Effekt auf jedem Ziel wiedergegeben, dessenwidth- oderheight-Eigenschaft geändert wurde. - Beim Wert
"show"wird der Effekt auf jedem Ziel wiedergegeben, dessen visible-Eigenschaft sich vonfalseintruegeändert hat. - Der Wert
""gibt an, dass nicht gefiltert wird.
Implementierung
public function get filter():String public function set filter(value:String):voidhideFocusRing | Eigenschaft |
hideFocusRing:Boolean| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Bestimmt, ob der Effekt den Fokusring beim Start ausblenden soll. Das Effektziel ist für das Ausblenden des Fokusrings zuständig. Unterklassen der UIComponent-Klasse blenden den Fokusring automatisch aus. Ist das Effektziel keine UIComponent-Klasse, fügen Sie Funktionen hinzu, um den Fokusring auszublenden.
Setzen Sie diese Eigenschaft auf true, um den Fokusring während des Effekts auszublenden.
Für Unterklassen der Effect-Klasse lautet der Standardwert false. Für Unterklassen der MaskEffect-Klasse lautet der Standardwert true.
Implementierung
public function get hideFocusRing():Boolean public function set hideFocusRing(value:Boolean):voidinstanceClass | Eigenschaft |
public var instanceClass:Class| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Ein Objekt der type-Klasse, das die Effektinstanzklasse für diese Effektklasse angibt.
Diese Eigenschaft muss im Konstruktor aller Unterklassen der Effect-Klasse eingestellt sein.
isPlaying | Eigenschaft |
isPlaying:Boolean [schreibgeschützt] | Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Ein Flag für den Schreibschutz, das auf „true“ gesetzt ist, wenn Instanzen des Effekts aktuell wiedergegeben werden, und andernfalls auf „false“.
Implementierung
public function get isPlaying():BooleanperElementOffset | Eigenschaft |
perElementOffset:Number| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Zusätzliche Verzögerung (in Millisekunden) für Effektziele nach dem ersten Ziel des Effekts. Dieser Wert wird zum Wert der startDelay-Eigenschaft addiert.
Implementierung
public function get perElementOffset():Number public function set perElementOffset(value:Number):voidplayheadTime | Eigenschaft |
playheadTime:Number| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Aktuelle Zeitposition des Effekts. Der Wert dieser Eigenschaft liegt zwischen 0 und der Gesamtdauer, die startDelay, repeatCount und repeatDelay einschließt.
Implementierung
public function get playheadTime():Number public function set playheadTime(value:Number):voidrelevantProperties | Eigenschaft |
relevantProperties:Array| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Ein Array von Eigenschaftsnamen zur Verwendung beim Filtern. Diese Eigenschaft wird intern verwendet und sollte nicht von Effektbenutzern eingestellt werden.
Der Standardwert entspricht dem Array, das von der getAffectedProperties()-Methode zurückgegeben wird.
Implementierung
public function get relevantProperties():Array public function set relevantProperties(value:Array):voidrelevantStyles | Eigenschaft |
relevantStyles:Array| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Ein Array von Stilnamen zur Verwendung beim Filtern. Diese Eigenschaft wird intern verwendet und sollte nicht von Effektbenutzern eingestellt werden.
Der Standardwert entspricht dem Array, das von der getAffectedProperties()-Methode zurückgegeben wird.
Implementierung
public function get relevantStyles():Array public function set relevantStyles(value:Array):voidrepeatCount | Eigenschaft |
public var repeatCount:int = 1| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Ein Wert, der angibt, wie oft der Effekt wiederholt werden soll. Mögliche Werte sind Ganzzahlen größer als oder gleich 0. Bei einem Wert von 1 wird der Effekt einmal wiederholt. Bei einem Wert von 0 wird der Effekt so lange wiederholt, bis er explizit angehalten wird (zum Beispiel durch einen Aufruf der end()-Methode).
Der Standardwert ist 1.
repeatDelay | Eigenschaft |
public var repeatDelay:int = 0| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Wartezeit in Millisekunden vor der Wiederholung des Effekts. Mögliche Werte sind Ganzzahlen größer als oder gleich 0.
Der Standardwert ist 0.
startDelay | Eigenschaft |
public var startDelay:int = 0| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Wartezeit in Millisekunden vor dem Starten des Effekts. Mögliche Werte sind Ganzzahlen größer als oder gleich 0. Wird die repeatCount-Eigenschaft zur Wiederholung des Effekts verwendet, wird startDelay nur bei der ersten Wiedergabe des Effekts angewendet.
Der Standardwert ist 0.
suspendBackgroundProcessing | Eigenschaft |
public var suspendBackgroundProcessing:Boolean = false| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Bei true erfolgt keine Hintergrundverarbeitung, während der Effekt wiedergegeben wird. Zu Hintergrundverarbeitungen zählen Messungen, Layout und Verarbeitung von Serverantworten. Der Standardwert ist false.
In den meisten Fällen sollten Sie diese Eigenschaft auf true setzen, um die Anwendungsleistung zu verbessern. In den folgenden beiden Fällen sollte die Eigenschaft jedoch auf false gesetzt werden:
- Während der Effektwiedergabe sind Benutzereingaben möglich und die Anwendung muss vor dem Ende der Effektwiedergabe darauf reagieren.
- Während der Effektwiedergabe sind Serverantworten möglich und die Anwendung muss während der Effektwiedergabe darauf reagieren.
Der Standardwert ist false.
target | Eigenschaft |
target:Object| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Das Objekt, auf das dieser Effekt angewendet wird. Wird ein Effekt durch einen Effekt-Auslöser ausgelöst, wird die target-Eigenschaft automatisch auf das Objekt gesetzt, das den Effekt auslöst.
Implementierung
public function get target():Object public function set target(value:Object):voidtargets | Eigenschaft |
targets:Array| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Ein Array von Objekten, die als Ziele des Effekts verwendet werden können. Bei der Wiedergabe wird der Effekt auf allen Zielen parallel ausgeführt. Durch Einstellen der target-Eigenschaft werden alle Objekte in diesem Array ersetzt. Wenn die targets-Eigenschaft eingestellt wird, gibt die target-Eigenschaft das erste Element in diesem Array zurück.
Implementierung
public function get targets():Array public function set targets(value:Array):voidtriggerEvent | Eigenschaft |
triggerEvent:Event| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Der EffectManager übergibt diesem Effekt das Ereignisobjekt, wenn ein Effekt ausgelöst wird, oder null, wenn der Effekt nicht vom EffectManager wiedergegeben wird.
Implementierung
public function get triggerEvent():Event public function set triggerEvent(value:Event):voidEffect | () | Konstruktor |
public function Effect(target:Object = null)| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Konstruktor.
Zum Starten eines Effekts sind normalerweise drei Schritte notwendig:
- Erstellen einer Instanz des Effektobjekts mit dem
new-Operator. - Einstellen der Eigenschaften des Effektobjekts, wie
duration. - Aufrufen der
play()-Methode oder Zuweisen des Effekts zu einem Auslöser.
target:Object (default = null) |
applyValueToTarget | () | Methode |
protected function applyValueToTarget(target:Object, property:String, value:*, props:Object):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Wird intern von der Effektinfrastruktur verwendet. Wenn captureStartValues() aufgerufen wurde und Flex die play()-Methode aufruft, verwendet das Programm diese Funktion zum Zurücksetzen der Ziele auf den Anfangsstatus. Das Standardverhalten besteht darin, den mit der getValueFromTarget()-Methode erfassten Wert zu verwenden und diesen direkt auf der Eigenschaft des Ziels einzustellen. Beispiel:
target[property] = value;
Überschreiben Sie diese Methode nur, wenn Sie die erfassten Werte auf andere Art anwenden müssen. Beachten Sie, dass Stileigenschaften eines Ziels durch einen anderen Mechanismus eingestellt werden. Mit der relevantStyles-Eigenschaft geben Sie die zu erfassenden und anzuwendenden Stileigenschaften an.
Parameter
target:Object — Das Effektziel.
| |
property:String — target-Eigenschaft.
| |
value:* — Der Wert der Eigenschaft.
| |
props:Object — Array von Objekten, wobei jedes Arrayelement ein start- und ein end-Objekt für die Eigenschaften enthält, die der Effekt überwacht.
|
captureEndValues | () | Methode |
public function captureEndValues():void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Erfasst die aktuellen Werte der relevanten Eigenschaften der Ziele des Effekts und speichert sie als Endwerte.
Flex ruft die captureEndValues()-Methode automatisch auf, wenn der Effekt zu einem Datenänderungseffekt gehört.
captureMoreStartValues | () | Methode |
public function captureMoreStartValues(targets:Array):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Erfasst die aktuellen Werte der relevanten Eigenschaften eines zusätzlichen Zielsatzes.
Flex verwendet diese Funktion, wenn ein Datenänderungseffekt ausgeführt wird.
Parameter
targets:Array — Array von Zielen, für die Werte erfasst werden.
|
captureStartValues | () | Methode |
public function captureStartValues():void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Erfasst die aktuellen Werte der relevanten Eigenschaften der Ziele des Effekts. Flex ruft die captureStartValues()-Methode automatisch auf, wenn der Effekt zu einem Übergang gehört.
Verwenden Sie diese Funktion, um die Anfangs- und Endwerte des Effekts durch den Effekt selbst ermitteln zu lassen. Die ordnungsgemäße Verwendung der Funktion erfolgt in diesen Schritten:
- Rufen Sie die
captureStartValues()-Methode auf. Der Effekt erfasst die Anfangs- und Endwerte. - Ändern Sie die Effektziele, beispielsweise durch Hinzufügen oder Entfernen untergeordneter Elemente, Ändern von Eigenschaften, der Position oder der Größe.
- Rufen Sie die
play()-Methode auf. Der Effekt erfasst die Endwerte. Diese Funktion füllt dieEffectInstance.propertyChanges-Eigenschaft für jede Effektinstanz aus, die von diesem Effekt erstellt wird. Effektentwickler können diesepropertyChanges-Eigenschaft verwenden, um die Start- und Endwerte für ihren Effekt abzurufen.
createInstance | () | Methode |
public function createInstance(target:Object = null):IEffectInstance| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Erstellt eine einzelne Effektinstanz und initialisiert sie. Verwenden Sie diese Methode statt der play()-Methode, um die Effektinstanzeigenschaften vor der Wiedergabe der Effektinstanz zu ändern.
Die Effektinstanz wird mit dem in der instanceClass-Eigenschaft angegebenen Typ erstellt. Dann wird sie mit der initInstance()-Methode initialisiert. Wurde die Instanz durch den EffectManager erstellt (wenn der Effekt durch einen Effekt-Auslöser ausgelöst wird), wird der Effekt außerdem durch einen Aufruf der EffectInstance.initEffect() initialisiert.
Durch Aufrufen der createInstance()-Methode wird der Effekt nicht wiedergegeben. Rufen Sie die startEffect()-Methode für die zurückgegebenen Effektinstanz auf.
Diese Funktion wird automatisch von der Effect.play()-Methode aufgerufen.
Parameter
target:Object (default = null) |
IEffectInstance — Das Effektinstanz-Objekt für den Effekt.
|
createInstances | () | Methode |
public function createInstances(targets:Array = null):Array| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Verwendet ein Array von Zielobjekten und ruft die createInstance()-Methode auf jedem Ziel auf.
Parameter
targets:Array (default = null) |
Array — Array von Effektinstanz-Objekten (ein Objekt pro Ziel) für den Effekt.
|
deleteInstance | () | Methode |
public function deleteInstance(instance:IEffectInstance):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Entfernt Ereignis-Listener von einer Instanz und entfernt sie aus der Liste der Instanzen.
Parameter
instance:IEffectInstance — Die Effektinstanz.
|
effectEndHandler | () | Methode |
protected function effectEndHandler(event:EffectEvent):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Wird aufgerufen, wenn die Wiedergabe einer Effektinstanz abgeschlossen ist. Wenn Sie diese Methode überschreiben, stellen Sie sicher, dass Sie die übergeordnete Methode aufrufen.
Parameter
event:EffectEvent — Ein Ereignisobjekt des Typs EffectEvent.
|
effectStartHandler | () | Methode |
protected function effectStartHandler(event:EffectEvent):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Diese Methode wird aufgerufen, wenn die Wiedergabe der Effektinstanz beginnt. Wenn Sie diese Methode überschreiben, stellen Sie sicher, dass Sie die übergeordnete Methode aufrufen.
Parameter
event:EffectEvent — Ein Ereignisobjekt des Typs EffectEvent.
|
effectStopHandler | () | Methode |
protected function effectStopHandler(event:EffectEvent):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Wird aufgerufen, wenn eine Effektinstanz durch einen Aufruf der stop()- Methode angehalten wurde. Wenn Sie diese Methode überschreiben, stellen Sie sicher, dass Sie die übergeordnete Methode aufrufen.
Parameter
event:EffectEvent — Ein Ereignisobjekt des Typs EffectEvent.
|
end | () | Methode |
public function end(effectInstance:IEffectInstance = null):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Unterbricht einen aktuell wiedergegebenen Effekt und springt sofort zum Ende des Effekts. Mit dieser Methode wird die EffectInstance.end()-Methode aufgerufen.
Die Effektinstanz löst ein effectEnd-Ereignis aus, wenn Sie diese Methode zum Beenden des Effekts aufrufen.
Wenn Sie eine Effektinstanz als Argument übergeben, wird nur diese Instanz unterbrochen. Wenn kein Argument übergeben wird, werden alle aktuellen Instanzen des Effekts unterbrochen.
Parameter
effectInstance:IEffectInstance (default = null) |
filterInstance | () | Methode |
protected function filterInstance(propChanges:Array, target:Object):Boolean| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Bestimmt die Logik zum Filtern einer Effektinstanz. Die CompositeEffect-Klasse überschreibt diese Methode.
Parameter
propChanges:Array — Die durch den Effekt geänderten Eigenschaften.
| |
target:Object — Das Effektziel.
|
Boolean — Gibt true zurück, wenn die Effektinstanz wiedergegeben werden soll.
|
getAffectedProperties | () | Methode |
public function getAffectedProperties():Array| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Gibt ein Array von Strings zurück, wobei jeder String dem Namen einer Eigenschaft entspricht, die von diesem Effekt geändert wird. Beispielsweise gibt der Verschieben-Effekt ein Array zurück, das "x" und "y" enthält.
Jede Unterklasse des Effekts muss diese Methode implementieren. Mit dieser Methode sorgt der EffectManager dafür, dass dieselbe Eigenschaft desselben Objekts nicht durch zwei verschiedene Effekte animiert wird.
RückgabewerteArray — Ein Array von Strings, das die Namen der von diesem Effekt geänderten Eigenschaften angibt.
|
getValueFromTarget | () | Methode |
protected function getValueFromTarget(target:Object, property:String):*| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Wird von der captureStartValues()-Methode aufgerufen, um den Wert einer Eigenschaft des Ziels abzurufen. Diese Funktion sollte nur intern vom Effekt-Framework aufgerufen werden. Das Standardverhalten besteht darin, einfach target[property] zurückzugeben. Effektentwickler können diese Funktion überschreiben, wenn ein anderes Verhalten benötigt wird.
Parameter
target:Object — Das Effektziel.
| |
property:String — target-Eigenschaft.
|
* — Der Wert der Zieleigenschaft.
|
initInstance | () | Methode |
protected function initInstance(instance:IEffectInstance):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Kopiert Eigenschaften des Effekts in die Effektinstanz.
Flex ruft diese Methode von der Methode Effect.createInstance() auf. Sie selbst rufen sie nicht auf.
Überschreiben Sie beim Erstellen eines benutzerdefinierten Effekts diese Methode, um Eigenschaften von der Effektklasse in die Effektinstanzklasse zu kopieren. Rufen Sie beim Überschreiben super.initInstance() auf.
Parameter
instance:IEffectInstance — Die zu initialisierende Effektinstanz.
|
pause | () | Methode |
public function pause():void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Hält den Effekt an, bis die resume()-Methode aufgerufen wird.
play | () | Methode |
public function play(targets:Array = null, playReversedFromEnd:Boolean = false):Array| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Startet die Wiedergabe des Effekts. Normalerweise rufen Sie die end()-Methode vor der play()-Methode auf, um sicherzustellen, dass vorherige Instanzen des Effekts beendet wurden, bevor eine neue gestartet wird.
Alle Unterklassen müssen diese Methode implementieren.
Parameter
targets:Array (default = null)targets-Eigenschaft des Effekts nicht verwendet.
| |
playReversedFromEnd:Boolean (default = false)true wird der Effekt rückwärts wiedergegeben.
|
Array — Array von Effektinstanz-Objekten (ein Objekt pro Ziel) für den Effekt.
|
resume | () | Methode |
public function resume():void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Setzt den Effekt fort, nachdem er durch Aufrufen der pause()-Methode vorübergehend unterbrochen wurde.
reverse | () | Methode |
public function reverse():void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Gibt den aktuell wiedergegebenen Effekt rückwärts wieder und beginnt dabei an der aktuellen Position des Effekts.
stop | () | Methode |
public function stop():void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Hält den Effekt an und behält den aktuellen Status der Effektziele bei. Anders als bei der pause()-Methode können Sie nach der stop()-Methode nicht die resume()-Methode aufrufen. Sie können jedoch den Effekt mit der play()-Methode neu starten.
Die Effektinstanz löst ein effectEnd-Ereignis aus, wenn Sie diese Methode zum Beenden des Effekts aufrufen.
Bei Maskierungseffekten wird die Maske beim Anhalten eines Effekts nicht automatisch entfernt. Wenn Sie weitere Maskierungseffekte auf dem gleichen Ziel ausführen, ohne die Maske zuvor zu entfernen, kann es zu unerwarteten Ergebnissen kommen.
effectEnd | Ereignis |
mx.events.EffectEventEigenschaft EffectEvent.type =
mx.events.EffectEvent.EFFECT_END| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Wird ausgelöst, wenn die Wiedergabe einer der Effektinstanzen beendet wurde, da die Instanz das Ende erreicht hatte oder da der Effekt durch einen Aufruf der end()-Methode unterbrochen wurde.
EffectEvent.EFFECT_END-Konstante definiert den Wert der type-Eigenschaft des Ereignisobjekts für ein effectEnd-Ereignis.
Die Eigenschaften des Ereignisobjekts haben die folgenden Werte:
| Eigenschaft | Wert |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | Das Objekt, das den Ereignis-Listener definiert, der das Ereignis übernimmt. Wenn Sie beispielsweise myButton.addEventListener() zur Registrierung eines Ereignis-Listeners verwenden, weist currentTarget den Wert „myButton“ auf. |
effectInstance | Das Effektinstanz-Objekt für das Ereignis. |
target | Das Objekt, von dem das Ereignis ausgelöst wurde. Dies ist nicht immer das Objekt, das auf das Ereignis wartet. Verwenden Sie die currentTarget-Eigenschaft, damit immer auf das Objekt, das auf das Ereignis wartet, zugegriffen wird. |
effectStart | Ereignis |
mx.events.EffectEventEigenschaft EffectEvent.type =
mx.events.EffectEvent.EFFECT_START| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Wird ausgelöst, wenn die Wiedergabe eines Effekts gestartet wird.
DieEffectEvent.EFFECT_START-Konstante definiert den Wert der type-Eigenschaft des Ereignisobjekts für ein effectStart-Ereignis.
Die Eigenschaften des Ereignisobjekts haben die folgenden Werte:
| Eigenschaft | Wert |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | Das Objekt, das den Ereignis-Listener definiert, der das Ereignis übernimmt. Wenn Sie beispielsweise myButton.addEventListener() zur Registrierung eines Ereignis-Listeners verwenden, weist currentTarget den Wert „myButton“ auf. |
effectInstance | Das Effektinstanz-Objekt für das Ereignis. |
target | Das Objekt, von dem das Ereignis ausgelöst wurde. Dies ist nicht immer das Objekt, das auf das Ereignis wartet. Verwenden Sie die currentTarget-Eigenschaft, damit immer auf das Objekt, das auf das Ereignis wartet, zugegriffen wird. |
effectStop | Ereignis |
mx.events.EffectEventEigenschaft EffectEvent.type =
mx.events.EffectEvent.EFFECT_STOP| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Wird ausgelöst, wenn der Effekt angehalten wurde. Dies geschieht nur, wenn der Effekt durch Aufrufen der stop()- Methode unterbrochen wird. Das EFFECT_END-Ereignis wird auch ausgelöst, um die Beendigung des Effekts anzugeben. Dieses zusätzliche Ereignis wird zuerst an Listener gesendet, um mitzuteilen, dass der Effekt nicht den Endstatus erreicht hat.
EffectEvent.EFFECT_STOP-Konstante definiert den Wert der type-Eigenschaft des Ereignisobjekts für ein effectStop-Ereignis.
Die Eigenschaften des Ereignisobjekts haben die folgenden Werte:
| Eigenschaft | Wert |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | Das Objekt, das den Ereignis-Listener definiert, der das Ereignis übernimmt. Wenn Sie beispielsweise myButton.addEventListener() zur Registrierung eines Ereignis-Listeners verwenden, weist currentTarget den Wert „myButton“ auf. |
effectInstance | Das Effektinstanz-Objekt für das Ereignis. |
target | Das Objekt, von dem das Ereignis ausgelöst wurde. Dies ist nicht immer das Objekt, das auf das Ereignis wartet. Verwenden Sie die currentTarget-Eigenschaft, damit immer auf das Objekt, das auf das Ereignis wartet, zugegriffen wird. |
<?xml version="1.0"?>
<!-- Simple example to demonstrate the Effect class. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx:Script>
<![CDATA[
import mx.controls.Alert;
// Event handler for the effectEnd event.
private function endEffectHandler():void {
Alert.show("Effect Ended!");
}
// Event handler for the reset button.
private function resetHandler():void {
expand.end();
img.width=30;
img.height=60;
button1.enabled=true;
}
]]>
</fx:Script>
<fx:Declarations>
<mx:Resize id="expand" target="{img}" widthTo="100" heightTo="200"
duration="10000" effectEnd="endEffectHandler();"/>
</fx:Declarations>
<s:Panel title="Resize Effect Example" width="100%" height="100%" >
<s:VGroup left="20" right="20" top="20" bottom="20">
<s:Label width="100%" color="blue"
text="Use the Button controls to control the Resize effect."/>
<mx:Image id="img" width="30" height="60"
source="@Embed(source='assets/Nokia_6630.png')"/>
<s:Button id="button1" label="Start" click="expand.play(); button1.enabled=false;"/>
<s:Button label="Pause" click="expand.pause();"/>
<s:Button label="Resume" click="expand.resume();"/>
<s:Button label="Reverse" click="expand.reverse();"/>
<s:Button label="End" click="expand.end();"/>
<s:Button label="Reset" click="resetHandler();"/>
</s:VGroup>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 10:04 AM Z