mx.effects.Parallel

Package	mx.effects
Class	public class Parallel
Inheritance	Parallel CompositeEffect Effect flash.events.EventDispatcher
Subclasses	DefaultListEffect, DefaultTileListEffect

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

The Parallel effect plays multiple child effects at the same time.

You can create a Paralell 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>

Notice that the <mx:children> tag is optional.

Starting a Parallel 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 effect object; for example:
```
myParallelEffect = new mx.effects.Parallel();
```
Call the addChild() method for each of the effect objects; for example:
```
myParallelEffect.addChild(myFadeEffect);
```
Invoke the Parallel effect's play() method; for example:
```
myParallelEffect.play();
```

MXML Syntax expanded

Hide MXML Syntax

The <mx:Parallel> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:Parallel id="identifier">
    <mx:children>
      <!-- Specify child effect tags --> 
    </mx:children>
  </mx:Parallel>

Default MXML Propertychildren

View the examples

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		children : Array An Array containing the child effects of this CompositeEffect.	CompositeEffect
		className : String [read-only] The name of the effect class, such as "Fade".	Effect
		compositeDuration : Number [override] [read-only] Returns the duration of this effect as defined by the duration of all child effects.	Parallel
		customFilter : 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 : 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 [read-only] 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

	Property	Defined By
		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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		Parallel(target:Object = null) Constructor.	Parallel
		addChild(childEffect:IEffect):void Adds a new child effect to this composite effect.	CompositeEffect
		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
		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
		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
		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
		stop():void Stops the effect, leaving the effect targets in their current state.	Effect

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		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

Summary	Defined By
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

Property Detail

compositeDuration

property

compositeDuration:Number [read-only] [override]

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

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.

Implementation
public function get compositeDuration():Number

Constructor Detail

Parallel

()

Constructor

public function Parallel(target:Object = null)

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

Constructor.

Parameters

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

Examples

ParallelEffectExample.mxml

<?xml version="1.0"?>
<!--

  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

-->
<!-- Simple example to demonstrate the Halo Parallel effect. -->
<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:Declarations>
       <mx:Parallel id="expand" target="{img}">
            <mx:Move xTo="{canvas.width/2 - 50}" yTo="{canvas.height/2 - 100}"/>
            <mx:Resize widthTo="100" heightTo="200"/>
        </mx:Parallel>

        <mx:Parallel id="contract" target="{img}">
            <mx:Move xTo="20" yTo="20"/>
            <mx:Resize widthTo="30" heightTo="60"/>
        </mx:Parallel>
    </fx:Declarations>

    <s:Panel title="Halo Parallel Effect Example" width="100%" height="100%">
        <s:VGroup bottom="10" right="10" top="10" left="10">
            <s:Label width="100%" color="blue"
                text="Use the Button controls to move and resize the phone image in parallel."/>

            <mx:Canvas id="canvas" width="100%" height="100%">
                <mx:Image id="img" x="20" y="20" width="30" height="60"
                    source="@Embed(source='assets/Product1.png')"/>
            </mx:Canvas>


            <s:Button label="Expand" click="expand.end(); expand.play();" />
            <s:Button label="Contract" click="contract.end(); contract.play();" />
        </s:VGroup>

    </s:Panel>
</s:Application>

Wed Nov 15 2017, 09:50 AM +01:00

Apache Flex 4.16.1 API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Parallel	Properties \| Methods \| Events \| Examples