CompositeEffect

Pacote	mx.effects
Classe	public class CompositeEffect
Herança	CompositeEffect Effect EventDispatcher Object
Subclasses	Parallel, Sequence

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

The CompositeEffect class is the parent class for the Parallel and Sequence classes, which define the <mx:Parallel> and <mx:Sequence> MXML tags. Flex supports two methods to combine, or composite, effects: parallel and sequence. When you combine multiple effects in parallel, the effects play at the same time. When you combine multiple effects in sequence, one effect must complete before the next effect starts.

You can create a composite effect in MXML, as the following example shows:

  <mx:Parallel id="WipeRightUp">
    <mx:children>
      <mx:WipeRight duration="1000"/>
      <mx:WipeUp duration="1000"/>
    </mx:children>
  </mx:Parallel>
   
  <mx:VBox id="myBox" hideEffect="WipeRightUp">
    <mx:TextArea id="aTextArea" text="hello"/>
  </mx:VBox>

The <mx:children> tag is optional.

Starting a composite effect in ActionScript is usually a five-step process:

Create instances of the effect objects to be composited together; for example:
```
myFadeEffect = new mx.effects.Fade(target);
```
Set properties, such as duration, on the individual effect objects.
Create an instance of the Parallel or Sequence effect object; for example:
```
mySequenceEffect = new mx.effects.Sequence();
```
Call the addChild() method for each of the effect objects; for example:
```
mySequenceEffect.addChild(myFadeEffect);
```
Invoke the composite effect's play() method; for example:
```
mySequenceEffect.play();
```

Sintaxe MXML expanded

Ocultar sintaxe MXML

The CompositeEffect class adds the following tag attributes, and all the subclasses of the CompositeEffect class inherit these tag attributes:

  <mx:tagname>
    <mx:children>
      <!-- Specify child effect tags --> 
    </mx:children>
  </mx:tagname>

Propriedade MXML padrãochildren

Propriedades públicas

Ocultar propriedades públicas herdadas

Mostrar propriedades públicas herdadas

	Propriedade		Definido por
		children : Array An Array containing the child effects of this CompositeEffect.	CompositeEffect
		className : String [somente leitura] The name of the effect class, such as "Fade".	Effect
		compositeDuration : Number [somente leitura] Returns the duration of this effect as defined by the duration of all child effects.	CompositeEffect
		constructor : Object Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.	Object
		customFilter : mx.effects:EffectTargetFilter Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect.	Effect
		duration : Number Duration of the effect in milliseconds.	Effect
		effectTargetHost : mx.effects:IEffectTargetHost A property that lets you access the target list-based control of a data effect.	Effect
		filter : String Specifies an algorithm for filtering targets for an effect.	Effect
		hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect.	Effect
		instanceClass : Class An object of type Class that specifies the effect instance class class for this effect class.	Effect
		isPlaying : Boolean [somente leitura] A read-only flag which is true if any instances of the effect are currently playing, and false if none are.	Effect
		perElementOffset : Number Additional delay, in milliseconds, for effect targets after the first target of the effect.	Effect
		playheadTime : Number Current time position of the effect.	Effect
		relevantProperties : Array An Array of property names to use when performing filtering.	Effect
		relevantStyles : Array An Array of style names to use when performing filtering.	Effect
		repeatCount : int = 1 Number of times to repeat the effect.	Effect
		repeatDelay : int = 0 Amount of time, in milliseconds, to wait before repeating the effect.	Effect
		startDelay : int = 0 Amount of time, in milliseconds, to wait before starting the effect.	Effect
		suspendBackgroundProcessing : Boolean = false If true, blocks all background processing while the effect is playing.	Effect
		target : Object The object to which this effect is applied.	Effect
		targets : Array An Array of objects that are targets for the effect.	Effect
		triggerEvent : Event The Event object passed to this Effect by the EffectManager when an effect is triggered, or null if the effect is not being played by the EffectManager.	Effect

Propriedades protegidas

Ocultar propriedades protegidas herdadas

Mostrar propriedades protegidas herdadas

	Propriedade		Definido por
		applyTransitionEndProperties : Boolean This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself.	Effect
		endValuesCaptured : Boolean = false A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs.	Effect

Métodos públicos

Ocultar métodos públicos herdados

Mostrar métodos públicos herdados

	Método		Definido por
		CompositeEffect(target:Object = null) Constructor.	CompositeEffect
		addChild(childEffect:IEffect):void Adds a new child effect to this composite effect.	CompositeEffect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento.	EventDispatcher
		captureEndValues():void Captures the current values of the relevant properties on the effect's targets and saves them as end values.	Effect
		captureMoreStartValues(targets:Array):void Captures the current values of the relevant properties of an additional set of targets Flex uses this function when a data change effect is run.	Effect
		captureStartValues():void Captures the current values of the relevant properties on the effect's targets.	Effect
		createInstance(target:Object = null):IEffectInstance Creates a single effect instance and initializes it.	Effect
		createInstances(targets:Array = null):Array Takes an Array of target objects and invokes the createInstance() method on each target.	Effect
		deleteInstance(instance:IEffectInstance):void Removes event listeners from an instance and removes it from the list of instances.	Effect
		dispatchEvent(event:Event):Boolean Envia um evento para o fluxo de eventos.	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.	Effect
		getAffectedProperties():Array Returns an Array of Strings, where each String is the name of a property changed by this effect.	Effect
		hasEventListener(type:String):Boolean Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica se um objeto tem uma propriedade especificada definida.	Object
		isPrototypeOf(theClass:Object):Boolean Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.	Object
		pause():void Pauses the effect until you call the resume() method.	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Begins playing the effect.	Effect
		propertyIsEnumerable(name:String):Boolean Indica se a propriedade especificada existe e é enumerável.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Remove um ouvinte do objeto EventDispatcher.	EventDispatcher
		resume():void Resumes the effect after it has been paused by a call to the pause() method.	Effect
		reverse():void Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Define a disponibilidade de uma propriedade dinâmica para operações de repetição.	Object
		stop():void Stops the effect, leaving the effect targets in their current state.	Effect
		toLocaleString():String Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.	Object
		toString():String Retorna a representação de string do objeto especificado.	Object
		valueOf():Object Retorna o valor primitivo do objeto especificado.	Object
		willTrigger(type:String):Boolean Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado.	EventDispatcher

Métodos protegidos

Ocultar métodos protegidos herdados

Mostrar métodos protegidos herdados

	Método		Definido por
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Used internally by the Effect infrastructure.	Effect
		effectEndHandler(event:EffectEvent):void Called when an effect instance has finished playing.	Effect
		effectStartHandler(event:EffectEvent):void This method is called when the effect instance starts playing.	Effect
		effectStopHandler(event:EffectEvent):void Called when an effect instance has stopped by a call to the stop() method.	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Determines the logic for filtering out an effect instance.	Effect
		getValueFromTarget(target:Object, property:String):* Called by the captureStartValues() method to get the value of a property from the target.	Effect
		initInstance(instance:IEffectInstance):void Copies properties of the effect to the effect instance.	Effect

Eventos

Clique para obter mais informações sobre eventos

Ocultar eventos herdados

Mostrar eventos herdados

	Resumo	Definido por
activate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo.	EventDispatcher
deactivate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo.	EventDispatcher
effectEnd	Dispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method.	Effect
effectStart	Dispatched when the effect starts playing.	Effect
effectStop	Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.	Effect

Detalhes da propriedade

children

propriedade

children:Array

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

An Array containing the child effects of this CompositeEffect.

Implementação
public function get children():Array
public function set children(value:Array):void

compositeDuration

propriedade

compositeDuration:Number [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Returns the duration of this effect as defined by the duration of all child effects. This takes into account the startDelay and repetition info for all child effects, along with their durations, and returns the appropriate result.

Implementação
public function get compositeDuration():Number

Detalhes do construtor

()

Construtor

public function CompositeEffect(target:Object = null)

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Constructor.

Parâmetros

target:Object (default = null) — This argument is ignored for composite effects. It is included only for consistency with other types of effects.

Detalhes do método

addChild

()

método

public function addChild(childEffect:IEffect):void

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Adds a new child effect to this composite effect. A Sequence effect plays each child effect one at a time, in the order that they were added. A Parallel effect plays all child effects simultaneously; the order in which they are added does not matter.

Parâmetros

childEffect:IEffect — Child effect to be added to the composite effect.

Aspectos jurídicos | Política de privacidade on-line

CompositeEffect - AS3 Flex

Classes x

children

compositeDuration

CompositeEffect

addChild