Package | spark.effects |
Class | public class SetAction |
Inheritance | SetAction Effect EventDispatcher Object |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The <s:SetAction>
tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<s:SetAction Properties id="ID" property="" value="" />
See also
Public Properties
Property | Defined By | ||
---|---|---|---|
className : String [read-only]
The name of the effect class, such as "Fade". | Effect | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | 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 | ||
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 [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 | ||
property : String
The name of the property being changed. | SetAction | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
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 | ||
value : *
The new value for the property. | SetAction |
Protected Properties
Public Methods
Method | Defined By | ||
---|---|---|---|
Constructor. | SetAction | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | ||
Captures the current values of the relevant properties
on the effect's targets and saves them as end values. | Effect | ||
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 | ||
Captures the current values of the relevant properties
on the effect's targets. | Effect | ||
Creates a single effect instance and initializes it. | Effect | ||
Takes an Array of target objects and invokes the
createInstance() method on each target. | Effect | ||
Removes event listeners from an instance
and removes it from the list of instances. | Effect | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Interrupts an effect that is currently playing,
and jumps immediately to the end of the effect. | Effect | ||
Returns an Array of Strings, where each String is the name
of a property changed by this effect. | Effect | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Pauses the effect until you call the resume() method. | Effect | ||
Begins playing the effect. | Effect | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Resumes the effect after it has been paused
by a call to the pause() method. | Effect | ||
Plays the effect in reverse, if the effect is currently playing,
starting from the current position of the effect. | Effect | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Stops the effect, leaving the effect targets in their current state. | Effect | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
Protected Methods
Property Detail
property | property |
public var property:String
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The name of the property being changed.
value | property |
public var value:*
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The new value for the property. When run within a transition and value is not specified, Flex determines the value based on that set by the new view state.
Constructor Detail
SetAction | () | Constructor |
public function SetAction(target:Object = null)
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
Parameterstarget:Object (default = null ) — The Object to animate with this effect.
|
Examples ( How to use this example )
SetActionEffectExample.mxml
<?xml version="1.0"?> <!-- Simple example to demonstrate the s:SetAction class. --> <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:mx="library://ns.adobe.com/flex/mx" xmlns:s="library://ns.adobe.com/flex/spark"> <!-- Define one view state, in addition to the base state.--> <s:states> <s:State name="default"/> <s:State name="OneOnly"/> </s:states> <!-- Define Transition array with one Transition object.--> <s:transitions> <s:Transition id="toOneOnly" fromState="*" toState="OneOnly"> <s:Sequence id="t1" targets="{[p2]}"> <s:Wipe direction="left" duration="350"/> <s:SetAction property="visible"/> <s:SetAction property="includeInLayout"/> </s:Sequence> </s:Transition> <s:Transition id="toAnyFromAny" fromState="*" toState="*"> <s:Sequence id="t2" targets="{[p2]}"> <s:SetAction property="includeInLayout"/> <s:SetAction property="visible"/> <s:Wipe direction="right" duration="350"/> </s:Sequence> </s:Transition> </s:transitions> <s:Panel title="SetAction Effect Example" width="75%" height="75%"> <s:layout> <s:VerticalLayout paddingTop="10" paddingLeft="10"/> </s:layout> <s:Panel id="p1" title="One" width="100" height="100"> <s:Label fontSize="24" text="One"/> </s:Panel> <s:Panel id="p2" title="Two" width="100" height="100" visible="true" visible.OneOnly="false" includeInLayout="true" includeInLayout.OneOnly="false"> <s:Label fontSize="24" text="Two"/> </s:Panel> <s:Button id="b1" label="Change state" click="currentState = currentState == 'OneOnly' ? '' : 'OneOnly';"/> </s:Panel> </s:Application>
Fri Mar 19 2010, 02:45 AM -07:00