Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
ZoomInstance

Package | mx.effects.effectClasses
Class | public class ZoomInstance
Inheritance | ZoomInstance TweenEffectInstance EffectInstance 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:

- `tweenEnd`: Dispatched when the tween effect ends.
- `tweenUpdate`: Dispatched every time a TweenEffect class calculates a new value.

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:

- value[0]:Number A value between the values of the `Zoom.zoomWidthFrom` and `Zoom.zoomWidthTo` property.
- value[1]:Number A value between the values of the `Zoom.zoomHeightFrom` and `Zoom.zoomHeightTo` property.

See also

mx.effects.Zoom
mx.events.TweenEvent

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | captureRollEvents : Boolean Prevents the rollOut and rollOver events from being dispatched if the mouse has not moved. | ZoomInstance
|  | className : String [read-only] The name of the effect class, such as "FadeInstance". | EffectInstance
|  | duration : Number The duration of the effect, in milliseconds. | EffectInstance
|  | easingFunction : Function The easing function for the animation. | TweenEffectInstance
|  | effect : IEffect The IEffect object that created this IEffectInstance object. | EffectInstance
|  | effectTargetHost : IEffectTargetHost A property that lets you access the target list-based control of a data effect. | EffectInstance
|  | hideFocusRing : 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
|  | playheadTime : Number [override] Current time position of the effect. | TweenEffectInstance
|  | propertyChanges : PropertyChanges Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets. | EffectInstance
|  | repeatCount : int Number of times to repeat the effect. | EffectInstance
|  | repeatDelay : int Amount of time, in milliseconds, to wait before repeating the effect. | EffectInstance
|  | startDelay : int Amount of time, in milliseconds, to wait before starting the effect. | EffectInstance
|  | suspendBackgroundProcessing : Boolean If true, blocks all background processing while the effect is playing. | EffectInstance
|  | target : Object The UIComponent object to which this effect is applied. | EffectInstance
|  | triggerEvent : Event The event, if any, which triggered the playing of the effect. | EffectInstance
|  | tween : 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
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | playCount : int = 0 Number of times that the instance has been played. | EffectInstance

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ZoomInstance(target:Object) Constructor. | ZoomInstance
|  | end():void [override] Interrupts an effect that is currently playing, and immediately jumps to the end of the effect. | TweenEffectInstance
|  | finishEffect():void Called by the end() method when the effect finishes playing. | EffectInstance
|  | finishRepeat():void Called after each iteration of a repeated effect finishes playing. | EffectInstance
|  | initEffect(event:Event):void This method is called if the effect was triggered by the EffectManager. | EffectInstance
|  | onTweenEnd(value:Object):void Callback method that is called when the target should be updated by the effect for the last time. | TweenEffectInstance
|  | onTweenUpdate(value:Object):void Callback method that is called when the target should be updated by the effect. | TweenEffectInstance
|  | pause():void Pauses the effect until you call the resume() method. | EffectInstance
|  | play():void Plays the effect instance on the target. | EffectInstance
|  | resume():void Resumes the effect after it has been paused by a call to the pause() method. | EffectInstance
|  | reverse():void Plays the effect in reverse, starting from the current position of the effect. | EffectInstance
|  | startEffect():void Plays the effect instance on the target after the startDelay period has elapsed. | EffectInstance
|  | stop():void Stops the effect, leaving the target in its current state. | EffectInstance

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | 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

captureRollEvents | property

`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`.

originX | property |

`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.

originY | property |

`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.

zoomHeightFrom | property |

`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.

zoomHeightTo | property |

`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.

zoomWidthFrom | property |

`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.

zoomWidthTo | property |

`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.

Sun Mar 5 2017, 03:42 PM +11:00