| Paket | mx.effects |
| Schnittstelle | public interface IEffectInstance |
| Umsetzer | EffectInstance |
| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Effektentwickler müssen eine Instanzklasse für ihre benutzerdefinierten Effekte erstellen.
Verwandte API-Elemente
| Eigenschaft | Definiert von | ||
|---|---|---|---|
| className : String [schreibgeschützt]
Name der Effektklasse wie „FadeInstance“. | IEffectInstance | ||
| duration : Number
Die Dauer des Effekts in Millisekunden. | IEffectInstance | ||
| effect : IEffect
Das IEffect-Objekt, das dieses IEffectInstance-Objekt erstellt hat. | IEffectInstance | ||
| effectTargetHost : mx.effects:IEffectTargetHost
Eine Eigenschaft, die Ihnen den Zugriff auf listenbasierte Zielsteuerelemente eines Dateneffekts ermöglicht. | IEffectInstance | ||
| hideFocusRing : Boolean
Bestimmt, ob der Effekt den Fokusring beim Start ausblenden soll. | IEffectInstance | ||
| playheadTime : Number
Aktuelle Zeitposition des Effekts. | IEffectInstance | ||
| propertyChanges : PropertyChanges
Gibt das PropertyChanges-Objekt an, das die Anfangs- und Endwerte für den Satz Eigenschaften enthält, die für die Ziele des Effekts relevant sind. | IEffectInstance | ||
| repeatCount : int
Ein Wert, der angibt, wie oft der Effekt wiederholt werden soll. | IEffectInstance | ||
| repeatDelay : int
Wartezeit in Millisekunden vor der Wiederholung des Effekts. | IEffectInstance | ||
| startDelay : int
Wartezeit in Millisekunden vor dem Starten des Effekts. | IEffectInstance | ||
| suspendBackgroundProcessing : Boolean
Bei „true“ erfolgt keine Hintergrundverarbeitung, während der Effekt wiedergegeben wird. | IEffectInstance | ||
| target : Object
Das UIComponent-Objekt, auf das dieser Effekt angewendet wird. | IEffectInstance | ||
| triggerEvent : Event
Das Ereignis, falls zutreffend, das die Wiedergabe dieses Effekts ausgelöst hat. | IEffectInstance | ||
| Methode | Definiert von | ||
|---|---|---|---|
Unterbricht eine aktuell wiedergegebene Effektinstanz und springt sofort zum Ende des Effekts. | IEffectInstance | ||
Wird von der end()-Methode am Ende der Wiedergabe des Effekts aufgerufen. | IEffectInstance | ||
Wird nach jeder Iteration eines wiederholten Effekts aufgerufen. | IEffectInstance | ||
Sie wird aufgerufen, wenn der Effekt durch den EffectManager ausgelöst wurde. | IEffectInstance | ||
Hält den Effekt an, bis die resume()-Methode aufgerufen wird. | IEffectInstance | ||
Gibt die Effektinstanz auf dem Ziel wieder. | IEffectInstance | ||
Setzt den Effekt fort, nachdem er durch Aufrufen der pause()-Methode vorübergehend unterbrochen wurde. | IEffectInstance | ||
Gibt den Effekt rückwärts wieder und beginnt dabei an der aktuellen Position des Effekts. | IEffectInstance | ||
Gibt die Effektinstanz nach dem startDelay-Zeitraum auf dem Ziel wieder. | IEffectInstance | ||
Hält den Effekt an und behält den aktuellen Status des Ziels bei. | IEffectInstance | ||
className | Eigenschaft |
className:String [schreibgeschützt] | Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Name der Effektklasse wie FadeInstance.
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():Stringduration | Eigenschaft |
effect | Eigenschaft |
effectTargetHost | 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):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, müssen Sie Funktionen hinzufügen, 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):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):voidpropertyChanges | Eigenschaft |
propertyChanges:PropertyChanges| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Gibt das PropertyChanges-Objekt an, das die Anfangs- und Endwerte für den Satz Eigenschaften enthält, die für die Ziele des Effekts relevant sind. Diese Eigenschaft wird nur eingestellt, wenn die captureStartValues()-Methode des Effekts aufgerufen wurde, der diese Effektinstanz erstellt hat.
Sie verwenden eine propertyChanges-Eigenschaft häufig zum Erstellen eines Effekts, der zu einem Übergang gehört. Flex ruft die captureStartValues()-Methode automatisch auf, wenn der Übergang gestartet wird. In Ihrer Überschreibung der Effectinstance.play()-Methode können Sie diese Informationen in der propertyChanges()-Methode überprüfen, um die Anfangs- und Endwerte des Effekts zu initialisieren.
Implementierung
public function get propertyChanges():PropertyChanges public function set propertyChanges(value:PropertyChanges):voidVerwandte API-Elemente
repeatCount | Eigenschaft |
repeatCount:int| 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.
Der Standardwert ist 1.
Implementierung
public function get repeatCount():int public function set repeatCount(value:int):voidVerwandte API-Elemente
repeatDelay | Eigenschaft |
repeatDelay:int| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Wartezeit in Millisekunden vor der Wiederholung des Effekts.
Der Standardwert ist 0.
Implementierung
public function get repeatDelay():int public function set repeatDelay(value:int):voidVerwandte API-Elemente
startDelay | Eigenschaft |
startDelay:int| 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 die startDelay-Eigenschaft nur bei der ersten Wiedergabe des Effekts angewendet.
Der Standardwert ist 0.
Implementierung
public function get startDelay():int public function set startDelay(value:int):voidsuspendBackgroundProcessing | Eigenschaft |
suspendBackgroundProcessing:Boolean| 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.
Implementierung
public function get suspendBackgroundProcessing():Boolean public function set suspendBackgroundProcessing(value:Boolean):voidVerwandte API-Elemente
target | Eigenschaft |
triggerEvent | Eigenschaft |
triggerEvent:Event| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Das Ereignis, falls zutreffend, das die Wiedergabe dieses Effekts ausgelöst hat. Diese Eigenschaft ist nützlich, wenn der Effekt mehreren Auslöser-Ereignissen zugewiesen ist.
Wenn der Effekt programmgesteuert durch einen Aufruf der play()-Methode und nicht durch ein Ereignis ausgelöst wird, ist diese Eigenschaft null.
Implementierung
public function get triggerEvent():Event public function set triggerEvent(value:Event):voidend | () | Methode |
public function end():void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Unterbricht eine aktuell wiedergegebene Effektinstanz und springt sofort zum Ende des Effekts. Diese Methode wird durch die Effect.end()-Methode aufgerufen. Bei ihrer Implementierung ruft sie die finishEffect()-Methode auf.
Die Effektinstanz löst ein effectEnd-Ereignis aus, wenn Sie diese Methode zum Beenden des Effekts aufrufen.
In einer EffectInstance-Unterklasse können Sie diese Methode optional überschreiben. Dabei sollten Sie die super.end()-Methode am Ende der Überschreibung nach der Logik aufrufen.
Verwandte API-Elemente
finishEffect | () | Methode |
public function finishEffect():void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Wird von der end()-Methode am Ende der Wiedergabe des Effekts aufgerufen. Diese Funktion sendet ein endEffect-Ereignis für das Effektziel.
Sie müssen diese Methode in einer Unterklasse nicht überschreiben. Bei der Verwendung von Effekten brauchen Sie diese Methode nicht aufzurufen. Dagegen kann der Aufruf beim Erstellen einer Effekt-Unterklasse notwendig sein.
Verwandte API-Elemente
finishRepeat | () | Methode |
public function finishRepeat():void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Wird nach jeder Iteration eines wiederholten Effekts aufgerufen.
Sie müssen diese Methode in einer Unterklasse nicht überschreiben. Sie müssen diese Methode bei der Verwendung von Effekten nicht aufrufen.
initEffect | () | Methode |
public function initEffect(event:Event):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Sie wird aufgerufen, wenn der Effekt durch den EffectManager ausgelöst wurde. Diese Basisklassenversion speichert das Ereignis, durch das der Effekt ausgelöst wurde, in der triggerEvent-Eigenschaft. Jede Unterklasse sollte diese Methode überschreiben.
Parameter
event:Event — Das zum Auslösen des Effekts gesendete Ereignisobjekt. Wenn der Auslöser ein mouseDownEffect war, ist das Ereignis ein MouseEvent vom Typ MouseEvent.MOUSEDOWN.
|
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():void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Gibt die Effektinstanz auf dem Ziel wieder. Rufen Sie stattdessen die startEffect()-Methode auf, um einen Effekt auf einer EffectInstance zu starten.
In einer EffectInstance-Unterklasse müssen Sie diese Methode überschreiben. Die Überschreibung muss die super.play()-Methode aufrufen, damit ein effectStart-Ereignis am Ziel ausgelöst wird.
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 Effekt rückwärts wieder und beginnt dabei an der aktuellen Position des Effekts.
startEffect | () | Methode |
public function startEffect():void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 3 |
| Laufzeitversionen: | Flash Player 9, AIR 1.1 |
Gibt die Effektinstanz nach dem startDelay-Zeitraum auf dem Ziel wieder. Wird von der Effect-Klasse aufgerufen. Verwenden Sie diese Funktion statt der play()-Methode zum Starten einer Effektinstanz.
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 des Ziels bei. Diese Methode wird durch die Effect.stop()-Methode aufgerufen. Bei ihrer Implementierung ruft sie die finishEffect()-Methode auf.
Die Effektinstanz löst ein effectEnd-Ereignis aus, wenn Sie diese Methode zum Beenden des Effekts aufrufen.
Tue Jun 12 2018, 10:04 AM Z