Adobe Flex 2 Language Reference - collected by Jimbob | Back to MY RESOURCES


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

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
The name of the effect class, such as "FadeInstance".
EffectInstance
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedduration : Number
Duration of the effect in milliseconds.
EffectInstance
 InheritedeasingFunction : Function
The easing function for the animation.
TweenEffectInstance
 Inheritedeffect : 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
The current position of the effect, in milliseconds.
TweenEffectInstance
 InheritedpropertyChanges : PropertyChanges
EffectInstance
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrepeatCount : int
EffectInstance
 InheritedrepeatDelay : int
EffectInstance
 InheritedstartDelay : int
EffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
EffectInstance
 Inheritedtarget : Object
EffectInstance
 InheritedtriggerEvent : Event
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
Public Methods
 MethodDefined by
  
Constructor.
ZoomInstance
 Inherited
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
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
end():void
Interrupts an effect that is currently playing, and immediately jumps to the end of the effect.
TweenEffectInstance
 Inherited
finishEffect():void
Called by the end() method when the effect finishes playing.
EffectInstance
 Inherited
finishRepeat():void
Called after each iteration of a repeated effect finishes playing.
EffectInstance
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 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
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 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
seek(playheadTime:Number):void
Advances the effect to the specified position.
TweenEffectInstance
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
startEffect():void
Plays the effect instance on the target after the startDelay period has elapsed.
EffectInstance
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
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
Events
 EventSummaryDefined by
 Inherited Dispatched when Flash Player gains operating system focus and becomes active.EventDispatcher
 Inherited Dispatched when Flash Player loses operating system focus and is becoming inactive.EventDispatcher
Property detail
captureRollEventsproperty
public var captureRollEvents:Boolean

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

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

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

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

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

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

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)

Constructor.

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





collected by Jimbob 2007.05