Packagemx.effects.effectClasses
Classpublic class ZoomInstance
InheritanceZoomInstance Inheritance TweenEffectInstance Inheritance EffectInstance Inheritance flash.events.EventDispatcher

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

The ZoomInstance class implements the instance class for the Zoom effect. Flex creates an instance of this class when it plays a Zoom effect; you do not create one yourself.

Every effect class that is a subclass of the TweenEffect class supports the following events:

The event object passed to the event listener for these events is of type TweenEvent. The TweenEvent class defines the property value, which contains the tween value calculated by the effect. For the Zoom effect, the TweenEvent.value property contains a 2-item Array, where:

See also

mx.effects.Zoom
mx.events.TweenEvent


Public Properties
 PropertyDefined By
  captureRollEvents : Boolean
Prevents the rollOut and rollOver events from being dispatched if the mouse has not moved.
ZoomInstance
 InheritedclassName : String
[read-only] The name of the effect class, such as "FadeInstance".
EffectInstance
 Inheritedduration : Number
The duration of the effect, in milliseconds.
EffectInstance
 InheritedeasingFunction : Function
The easing function for the animation.
TweenEffectInstance
 Inheritedeffect : IEffect
The IEffect object that created this IEffectInstance object.
EffectInstance
 InheritedeffectTargetHost : IEffectTargetHost
A property that lets you access the target list-based control of a data effect.
EffectInstance
 InheritedhideFocusRing : Boolean
Determines whether the effect should hide the focus ring when starting the effect.
EffectInstance
  originX : Number
Number that represents the x-position of the zoom origin, or registration point.
ZoomInstance
  originY : Number
Number that represents the y-position of the zoom origin, or registration point.
ZoomInstance
 InheritedplayheadTime : Number
[override] Current time position of the effect.
TweenEffectInstance
 InheritedpropertyChanges : PropertyChanges
Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets.
EffectInstance
 InheritedrepeatCount : int
Number of times to repeat the effect.
EffectInstance
 InheritedrepeatDelay : int
Amount of time, in milliseconds, to wait before repeating the effect.
EffectInstance
 InheritedstartDelay : int
Amount of time, in milliseconds, to wait before starting the effect.
EffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
If true, blocks all background processing while the effect is playing.
EffectInstance
 Inheritedtarget : Object
The UIComponent object to which this effect is applied.
EffectInstance
 InheritedtriggerEvent : Event
The event, if any, which triggered the playing of the effect.
EffectInstance
 Inheritedtween : Tween
The Tween object, which determines the animation.
TweenEffectInstance
  zoomHeightFrom : Number
Number that represents the scale at which to start the height zoom, as a percent between 0.01 and 1.0.
ZoomInstance
  zoomHeightTo : Number
Number that represents the scale at which to complete the height zoom, as a percent between 0.01 and 1.0.
ZoomInstance
  zoomWidthFrom : Number
Number that represents the scale at which to start the width zoom, as a percent between 0.01 and 1.0.
ZoomInstance
  zoomWidthTo : Number
Number that represents the scale at which to complete the width zoom, as a percent between 0.01 and 1.0.
ZoomInstance
Protected Properties
 PropertyDefined By
 InheritedplayCount : int = 0
Number of times that the instance has been played.
EffectInstance
Public Methods
 MethodDefined By
  
ZoomInstance(target:Object)
Constructor.
ZoomInstance
 Inherited
end():void
[override] Interrupts an effect that is currently playing, and immediately jumps to the end of the effect.
TweenEffectInstance
 Inherited
Called by the end() method when the effect finishes playing.
EffectInstance
 Inherited
Called after each iteration of a repeated effect finishes playing.
EffectInstance
 Inherited
initEffect(event:Event):void
This method is called if the effect was triggered by the EffectManager.
EffectInstance
 Inherited
onTweenEnd(value:Object):void
Callback method that is called when the target should be updated by the effect for the last time.
TweenEffectInstance
 Inherited
onTweenUpdate(value:Object):void
Callback method that is called when the target should be updated by the effect.
TweenEffectInstance
 Inherited
pause():void
Pauses the effect until you call the resume() method.
EffectInstance
 Inherited
play():void
Plays the effect instance on the target.
EffectInstance
 Inherited
resume():void
Resumes the effect after it has been paused by a call to the pause() method.
EffectInstance
 Inherited
reverse():void
Plays the effect in reverse, starting from the current position of the effect.
EffectInstance
 Inherited
Plays the effect instance on the target after the startDelay period has elapsed.
EffectInstance
 Inherited
stop():void
Stops the effect, leaving the target in its current state.
EffectInstance
Protected Methods
 MethodDefined By
 Inherited
createTween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1):Tween
Creates a Tween instance, assigns it the start, end, and duration values.
TweenEffectInstance
Property Detail
captureRollEventsproperty
public var captureRollEvents:Boolean

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

Prevents the rollOut and rollOver events from being dispatched if the mouse has not moved. Set this value to true in situations where the target toggles between a big and small state without moving the mouse.

The default value is false.

originXproperty 
public var originX:Number

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

Number that represents the x-position of the zoom origin, or registration point. The default value is target.width / 2, which is the center of the target.

originYproperty 
public var originY:Number

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

Number that represents the y-position of the zoom origin, or registration point. The default value is target.height / 2, which is the center of the target.

zoomHeightFromproperty 
public var zoomHeightFrom:Number

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

Number that represents the scale at which to start the height zoom, as a percent between 0.01 and 1.0. The default value is 0.01, which is very small.

zoomHeightToproperty 
public var zoomHeightTo:Number

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

Number that represents the scale at which to complete the height zoom, as a percent between 0.01 and 1.0. The default value is 1.0, which is the object's normal size.

zoomWidthFromproperty 
public var zoomWidthFrom:Number

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

Number that represents the scale at which to start the width zoom, as a percent between 0.01 and 1.0. The default value is 0.01, which is very small.

zoomWidthToproperty 
public var zoomWidthTo:Number

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

Number that represents the scale at which to complete the width zoom, as a percent between 0.01 and 1.0. The default value is 1.0, which is the object's normal size.

Constructor Detail
ZoomInstance()Constructor
public function ZoomInstance(target:Object)

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

Constructor.

Parameters
target:Object — The Object to animate with this effect.