Package | mx.effects |
Class | public class SetStyleAction |
Inheritance | SetStyleAction ![]() ![]() |
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
SetStyle
property occurs during the transition.
MXML SyntaxThe <mx:SetStyleAction>
tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:SetStyleAction Properties id="ID" style="" value="" />
See also
Property | Defined By | ||
---|---|---|---|
![]() | className : String [read-only]
The name of the effect class, such as "Fade". | Effect | |
![]() | 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 | |
![]() | 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 | |
name : String
The name of the style property being changed. | SetStyleAction | ||
![]() | 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 [override]
Contains the style properties modified by this effect. | SetStyleAction | ||
![]() | 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 style property. | SetStyleAction |
Method | Defined By | ||
---|---|---|---|
SetStyleAction(target:Object = null)
Constructor. | SetStyleAction | ||
![]() | 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 |
name | property |
public var name:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The name of the style property being changed.
By default, Flex determines this value from the SetStyle
property definition in the view state definition.
relevantStyles | property |
relevantStyles:Array
[override] Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Contains the style properties modified by this effect. This getter method overrides the superclass method.
If you create a subclass of this class to create a custom effect, you must override this method and return an Array that contains a list of the style properties modified by your subclass.
public function get relevantStyles():Array
public function set relevantStyles(value:Array):void
See also
value | property |
public var value:*
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The new value for the style property.
By default, Flex determines this value from the SetStyle
property definition in the view state definition.
SetStyleAction | () | Constructor |
public function SetStyleAction(target:Object = null)
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
Parameterstarget:Object (default = null ) — The Object to animate with this effect.
|