| Package | mx.effects |
| Class | public class Resize |
| Inheritance | Resize  TweenEffect Effect flash.events.EventDispatcher |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
 | Starting with Flex 4.0, Apache recommends that you use the spark.effects.Resize class as an alternative to this class. |
If you specify only two of the three values of the
widthFrom, widthTo, and
widthBy properties, Flex calculates the third.
If you specify all three, Flex ignores the widthBy value.
If you specify only the widthBy or the
widthTo value, the widthFrom property
is set to be the object's current width.
The same is true for heightFrom, heightTo,
and heightBy property values.
If you specify a Resize effect for a resize trigger, and if you do not set the six From, To, and By properties, Flex sets them to create a smooth transition between the object's old size and its new size.
MXML Syntax
Hide MXML SyntaxThe <mx:Resize> tag
inherits all of the tag attributes of its superclass,
and adds the following tab attributes:
Show MXML Syntax
<mx:Resize
id="ID"
widthFrom="val"
heightFrom="val"
widthTo="val"
heightTo="val"
widthBy="val"
heightBy="val"
hideChildrenTargets=""
/>
See also
| Property | Defined By | ||
|---|---|---|---|
 | className : String [read-only]
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 | |
| heightBy : Number
Number of pixels by which to modify the height of the component. | Resize | ||
| heightFrom : Number
Initial height, in pixels. | Resize | ||
| heightTo : Number
Final height, in pixels. | Resize | ||
| hideChildrenTargets : Array
An Array of Panel containers. | Resize | ||
| hideFocusRing : Boolean
Determines whether the effect should hide the focus ring
when starting the effect. | Effect | |
| instanceClass : Class
An object of type Class that specifies the effect
instance class class for this effect class. | Effect | |
| isPlaying : Boolean [read-only]
A read-only flag which is true if any instances of the effect
are currently playing, and false if none are. | Effect | |
| perElementOffset : Number
Additional delay, in milliseconds, for effect targets
after the first target of the effect. | Effect | |
| playheadTime : Number
Current time position 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 object to which this effect is applied. | Effect | |
| targets : Array
An Array of 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 | |
| widthBy : Number
Number of pixels by which to modify the width of the component. | Resize | ||
| widthFrom : Number
Initial width, in pixels. | Resize | ||
| widthTo : Number
Final width, in pixels. | Resize | ||
| Method | Defined By | ||
|---|---|---|---|
Resize(target:Object = null)
Constructor. | Resize | ||
| 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
Flex uses this function 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 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 | |
| heightBy | property |
public var heightBy:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Number of pixels by which to modify the height of the component. Values may be negative.
| heightFrom | property |
public var heightFrom:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Initial height, in pixels. If omitted, Flex uses the current height.
| heightTo | property |
public var heightTo:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Final height, in pixels.
| hideChildrenTargets | property |
public var hideChildrenTargets:Array| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
An Array of Panel containers. The children of these Panel containers are hidden while the Resize effect plays.
You use data binding syntax to set this property in MXML, as the following example shows, where panelOne and panelTwo are the names of two Panel containers in your application:
<mx:Resize id="e" heightFrom="100" heightTo="400"
hideChildrenTargets="{[panelOne, panelTwo]}" />
| widthBy | property |
public var widthBy:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Number of pixels by which to modify the width of the component. Values may be negative.
| widthFrom | property |
public var widthFrom:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Initial width, in pixels. If omitted, Flex uses the current width.
| widthTo | property |
public var widthTo:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Final width, in pixels.
| Resize | () | Constructor |
public function Resize(target:Object = null)| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
Parameterstarget:Object (default = null) |
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- Simple example to demonstrate the Resize effect. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx:Declarations>
<mx:Resize id="expand" target="{img}" widthTo="100" heightTo="200"/>
<mx:Resize id="contract" target="{img}" widthTo="30" heightTo="60"/>
</fx:Declarations>
<s:Panel title="Resize Effect Example" width="100%" height="100%" >
<s:VGroup left="20" right="20" top="20" bottom="20">
<s:Label width="100%" color="blue"
text="Use the Button controls to resize the image."/>
<mx:Image id="img" width="30" height="60"
source="@Embed(source='assets/Product1.png')"/>
<mx:Button label="Expand" click="expand.end(); expand.play();"/>
<mx:Button label="Contract" click="contract.end(); contract.play();"/>
</s:VGroup>
</s:Panel>
</s:Application>