Packagemx.effects
Classpublic class Pause
InheritancePause Inheritance TweenEffect Inheritance Effect Inheritance flash.events.EventDispatcher

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The Pause effect is useful when sequencing effects. It does nothing for a specified period of time or until a specified event is dispatched by the target. If you add a Pause effect as a child of a Sequence effect, you can create a pause between the two other effects.

MXML SyntaxexpandedHide MXML Syntax

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

  <mx:Pause 
    id="ID" 
    eventName="null"
  />
  

View the examples

See also

mx.effects.effectClasses.PauseInstance


Public Properties
 PropertyDefined By
 InheritedclassName : String
[read-only] The name of the effect class, such as "Fade".
Effect
 InheritedcustomFilter : 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
[override] The duration property controls the amount of time that this effect will pause.
Pause
 InheritedeasingFunction : Function = null
The easing function for the animation.
TweenEffect
 InheritedeffectTargetHost : IEffectTargetHost
A property that lets you access the target list-based control of a data effect.
Effect
  eventName : String
Name of event that Pause is waiting on before ending.
Pause
 Inheritedfilter : String
Specifies an algorithm for filtering targets for an effect.
Effect
 InheritedhideFocusRing : Boolean
Determines whether the effect should hide the focus ring when starting the effect.
Effect
 InheritedinstanceClass : Class
An object of type Class that specifies the effect instance class class for this effect class.
Effect
 InheritedisPlaying : 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
 InheritedperElementOffset : Number
Additional delay, in milliseconds, for effect targets after the first target of the effect.
Effect
 InheritedplayheadTime : Number
Current time position of the effect.
Effect
 InheritedrelevantProperties : Array
An Array of property names to use when performing filtering.
Effect
 InheritedrelevantStyles : Array
An Array of style names to use when performing filtering.
Effect
 InheritedrepeatCount : int = 1
Number of times to repeat the effect.
Effect
 InheritedrepeatDelay : int = 0
Amount of time, in milliseconds, to wait before repeating the effect.
Effect
 InheritedstartDelay : int = 0
Amount of time, in milliseconds, to wait before starting the effect.
Effect
 InheritedsuspendBackgroundProcessing : Boolean = false
If true, blocks all background processing while the effect is playing.
Effect
 Inheritedtarget : Object
The object to which this effect is applied.
Effect
 Inheritedtargets : Array
An Array of objects that are targets for the effect.
Effect
 InheritedtriggerEvent : 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
Protected Properties
 PropertyDefined By
 InheritedapplyTransitionEndProperties : 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
 InheritedendValuesCaptured : 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
 MethodDefined By
  
Pause(target:Object = null)
Constructor.
Pause
 Inherited
Captures the current values of the relevant properties on the effect's targets and saves them as end values.
Effect
 Inherited
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
 Inherited
Captures the current values of the relevant properties on the effect's targets.
Effect
 Inherited
createInstance(target:Object = null):IEffectInstance
Creates a single effect instance and initializes it.
Effect
 Inherited
createInstances(targets:Array = null):Array
Takes an Array of target objects and invokes the createInstance() method on each target.
Effect
 Inherited
Removes event listeners from an instance and removes it from the list of instances.
Effect
 Inherited
end(effectInstance:IEffectInstance = null):void
Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.
Effect
 Inherited
Returns an Array of Strings, where each String is the name of a property changed by this effect.
Effect
 Inherited
pause():void
Pauses the effect until you call the resume() method.
Effect
 Inherited
play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
Begins playing the effect.
Effect
 Inherited
resume():void
Resumes the effect after it has been paused by a call to the pause() method.
Effect
 Inherited
reverse():void
Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.
Effect
 Inherited
stop():void
Stops the effect, leaving the effect targets in their current state.
Effect
Protected Methods
 MethodDefined By
 Inherited
applyValueToTarget(target:Object, property:String, value:*, props:Object):void
Used internally by the Effect infrastructure.
Effect
 Inherited
Called when an effect instance has finished playing.
Effect
 Inherited
This method is called when the effect instance starts playing.
Effect
 Inherited
Called when an effect instance has stopped by a call to the stop() method.
Effect
 Inherited
filterInstance(propChanges:Array, target:Object):Boolean
Determines the logic for filtering out an effect instance.
Effect
 Inherited
getValueFromTarget(target:Object, property:String):*
Called by the captureStartValues() method to get the value of a property from the target.
Effect
 Inherited
Copies properties of the effect to the effect instance.
Effect
 Inherited
Called when the TweenEffect dispatches a TweenEvent.
TweenEffect
Events
 Event Summary Defined By
 InheritedDispatched 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
 InheritedDispatched when the effect starts playing.Effect
 InheritedDispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.Effect
 InheritedDispatched when the tween effect ends.TweenEffect
 InheritedDispatched when the tween effect starts, which corresponds to the first call to the onTweenUpdate() method.TweenEffect
 InheritedDispatched every time the tween effect updates the target.TweenEffect
Property Detail
durationproperty
duration:Number[override]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The duration property controls the amount of time that this effect will pause. The duration also serves as a timeout on waiting for the event to be fired, if eventName was set on this effect. If duration is less than 0, the effect will wait indefinitely for the event to fire. If it is set to any other time, including 0, the effect will end either when that duration has elapsed or when the named event fires, whichever comes first.

The default value is 500.


Implementation
    public function get duration():Number
    public function set duration(value:Number):void

See also

eventNameproperty 
public var eventName:String

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Name of event that Pause is waiting on before ending. This parameter must be used in conjunction with the target property, which must be of type IEventDispatcher; all events must originate from some dispatcher.

Listening for eventName is also related to the duration property, which acts as a timeout for the event. If the event is not received in the time period specified by duration, the effect will end, regardless.

This property is optional; the default action is to play without waiting for any event.

Constructor Detail
Pause()Constructor
public function Pause(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 by the Pause effect if there is no eventName attribute assigned. If there is an eventName, then the target must be an object of type IEventDispatcher, because it is expected to dispatch that named event. A null target is allowed for this effect since a Pause effect with simply a duration property is not acting on any specific target and therefore does not need one.
Examples
PauseEffectExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!--

  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 Pause 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:Script>
        <![CDATA[
            import mx.effects.easing.*;
        ]]>
    </fx:Script>
    <fx:Declarations>
        <mx:Sequence id="movePauseMove">
            <mx:Move xBy="150" duration="2000" easingFunction="Bounce.easeOut"/>
            <mx:Pause duration="2000"/>
            <mx:Move xBy="-150" duration="2000" easingFunction="Bounce.easeIn"/>
        </mx:Sequence>
    </fx:Declarations>
    <s:Panel title="Pause Effect Example" width="75%" height="75%" >
        <s:VGroup left="20" right="20" top="20" bottom="20">

            <s:Label width="100%" color="blue"
                text="Click the phone image to start the Sequence effect. The effect pauses for 2 seconds between moves."/>

           <mx:Image
                source="@Embed(source='assets/Product1.png')"
                mouseDownEffect="{movePauseMove}"/>
        </s:VGroup>
    </s:Panel>
</s:Application>