Package | mx.effects |
Class | public class Rotate |
Inheritance | Rotate TweenEffect Effect flash.events.EventDispatcher |
Note: To use the Rotate effect with text, you must use an embedded font, not a device font.
MXML Syntax Hide MXML SyntaxThe <mx:Rotate>
tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:Rotate id="ID" angleFrom="0" angleTo="360" originX="0" originY="0" />
See also
Property | Defined by | ||
---|---|---|---|
angleFrom : Number = 0
The starting angle of rotation of the target object,
expressed in degrees.
| Rotate | ||
angleTo : Number = 360
The ending angle of rotation of the target object,
expressed in degrees.
| Rotate | ||
className : String
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 | ||
duration : Number
Duration of the effect in milliseconds.
| Effect | ||
easingFunction : Function = null
The easing function for the animation.
| TweenEffect | ||
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 | Rotate | ||
instanceClass : Class
An object of type Class that specifies the effect
instance class class for this effect class.
| Effect | ||
isPlaying : Boolean
A read-only flag which is true if any instances of the effect
are currently playing, and false if none are.
| Effect | ||
originX : Number
The x-position of the center point of rotation.
| Rotate | ||
originY : Number
The y-position of the center point of rotation.
| Rotate | ||
perElementOffset : Number
Additional delay, in milliseconds, for effect targets
after the first target 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 UIComponent object to which this effect is applied.
| Effect | ||
targets : Array
An Array of UIComponent 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 |
Method | Defined by | ||
---|---|---|---|
Rotate(target:Object = null)
Constructor.
| Rotate | ||
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
This function is used by Flex 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 that is 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 |
angleFrom | property |
public var angleFrom:Number = 0
The starting angle of rotation of the target object, expressed in degrees. Valid values range from 0 to 360.
The default value is 0
.
angleTo | property |
public var angleTo:Number = 360
The ending angle of rotation of the target object, expressed in degrees. Values can be either positive or negative.
If the value of angleTo
is less
than the value of angleFrom
,
the target rotates in a counterclockwise direction.
Otherwise, it rotates in clockwise direction.
If you want the target to rotate multiple times,
set this value to a large positive or small negative number.
The default value is 360
.
hideFocusRing | property |
hideFocusRing:Boolean
[read-write]Implementation
public function get hideFocusRing():Boolean
public function set hideFocusRing(value:Boolean):void
originX | property |
public var originX:Number
The x-position of the center point of rotation. The target rotates around this point. The valid values are between 0 and the width of the target.
The default value is 0
.
originY | property |
public var originY:Number
The y-position of the center point of rotation. The target rotates around this point. The valid values are between 0 and the height of the target.
The default value is 0
.
Rotate | () | constructor |
public function Rotate(target:Object = null)
Constructor.
Parameterstarget:Object (default = null ) — The Object to animate with this effect.
|