mx.effects.effectClasses.ResizeInstance (Flex™ 2 Language Reference)

Package	mx.effects.effectClasses
Class	public class ResizeInstance
Inheritance	ResizeInstance TweenEffectInstance EffectInstance EventDispatcher Object

The ResizeInstance class implements the instance class for the Resize effect. Flex creates an instance of this class when it plays a Resize 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 Resize effect, the TweenEvent.value property contains a 2-item Array, where:

value[0]:Number A value between the values of the Resize.widthFrom and Resize.widthTo property.
value[1]:Number A value between the values of the Resize.heightFrom and Resize.heightTo property.

See also

mx.effects.Resize
mx.events.TweenEvent

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		className : String The name of the effect class, such as `"FadeInstance"`.	EffectInstance
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		duration : Number Duration of the effect in milliseconds.	EffectInstance
		easingFunction : Function The easing function for the animation.	TweenEffectInstance
		effect : Effect The Effect object that created this EffectInstance object.	EffectInstance
		heightBy : Number Number of pixels by which to modify the height of the component.	ResizeInstance
		heightFrom : Number Initial height.	ResizeInstance
		heightTo : Number Final height, in pixels.	ResizeInstance
		hideChildrenTargets : Array An Array of Panels.	ResizeInstance
		playheadTime : Number The current position of the effect, in milliseconds.	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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		repeatCount : int = 1 Number of times to repeat the effect.	EffectInstance
		repeatDelay : int = 0 Amount of time, in milliseconds, to wait before repeating the effect.	EffectInstance
		startDelay : int = 0 Amount of time, in milliseconds, to wait before starting the effect.	EffectInstance
		suspendBackgroundProcessing : Boolean = false 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
		widthBy : Number Number of pixels by which to modify the width of the component.	ResizeInstance
		widthFrom : Number Initial width.	ResizeInstance
		widthTo : Number Final width, in pixels.	ResizeInstance

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		ResizeInstance(target:Object) Constructor.	ResizeInstance
		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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		end():void 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
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initEffect(event:Event):void This method is called if the effect was triggered by the EffectManager.	EffectInstance
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		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
		seek(playheadTime:Number):void Advances the effect to the specified position.	TweenEffectInstance
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		startEffect():void Plays the effect instance on the target after the `startDelay` period has elapsed.	EffectInstance
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

	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

heightBy

property

heightBy:Number [read-write]

Number of pixels by which to modify the height of the component. Values may be negative.

Implementation
public function get heightBy():Number
public function set heightBy(value:Number):void

heightFrom

property

public var heightFrom:Number

Initial height. If omitted, Flex uses the current size.

heightTo

property

heightTo:Number [read-write]

Final height, in pixels.

Implementation
public function get heightTo():Number
public function set heightTo(value:Number):void

hideChildrenTargets

property

public var hideChildrenTargets:Array

An Array of Panels. The children of these Panels are hidden while the Resize effect plays.

widthBy

property

widthBy:Number [read-write]

Number of pixels by which to modify the width of the component. Values may be negative.

Implementation
public function get widthBy():Number
public function set widthBy(value:Number):void

widthFrom

property

public var widthFrom:Number

Initial width. If omitted, Flex uses the current size.

widthTo

property

widthTo:Number [read-write]

Final width, in pixels.

Implementation
public function get widthTo():Number
public function set widthTo(value:Number):void

Constructor detail

ResizeInstance

()

constructor

public function ResizeInstance(target:Object)

Constructor.

Parameters

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

Current page: http://livedocs.adobe.com/flex/2/langref/mx/effects/effectClasses/ResizeInstance.html

Adobe^® Flex™ 2 Language Reference		All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
Class ResizeInstance	Properties \| Methods