Packagemx.effects.effectClasses
Classpublic class GlowInstance
InheritanceGlowInstance 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 GlowInstance class implements the instance class for the Glow effect. Flex creates an instance of this class when it plays a Glow 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 Glow effect, the TweenEvent.value property contains a 4-item Array, where:

See also

mx.effects.Glow
mx.events.TweenEvent


Public Properties
 PropertyDefined By
  alphaFrom : Number
Starting transparency level.
GlowInstance
  alphaTo : Number
Ending transparency level.
GlowInstance
  blurXFrom : Number
The starting amount of horizontal blur.
GlowInstance
  blurXTo : Number
The ending amount of horizontal blur.
GlowInstance
  blurYFrom : Number
The starting amount of vertical blur.
GlowInstance
  blurYTo : Number
The ending amount of vertical blur.
GlowInstance
 InheritedclassName : String
[read-only] The name of the effect class, such as "FadeInstance".
EffectInstance
  color : uint = 0xFFFFFFFF
The color of the glow.
GlowInstance
 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
  inner : Boolean
The inner flag of the glow.
GlowInstance
  knockout : Boolean
The knockout flag of the glow.
GlowInstance
 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
  strength : Number
The strength of the glow.
GlowInstance
 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
Protected Properties
 PropertyDefined By
 InheritedplayCount : int = 0
Number of times that the instance has been played.
EffectInstance
Public Methods
 MethodDefined By
  
GlowInstance(target:Object)
Constructor.
GlowInstance
 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
alphaFromproperty
public var alphaFrom:Number

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

Starting transparency level.

alphaToproperty 
public var alphaTo:Number

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

Ending transparency level.

blurXFromproperty 
public var blurXFrom:Number

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

The starting amount of horizontal blur.

blurXToproperty 
public var blurXTo:Number

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

The ending amount of horizontal blur.

blurYFromproperty 
public var blurYFrom:Number

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

The starting amount of vertical blur.

blurYToproperty 
public var blurYTo:Number

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

The ending amount of vertical blur.

colorproperty 
public var color:uint = 0xFFFFFFFF

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

The color of the glow.

innerproperty 
public var inner:Boolean

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

The inner flag of the glow.

knockoutproperty 
public var knockout:Boolean

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

The knockout flag of the glow.

strengthproperty 
public var strength:Number

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

The strength of the glow.

Constructor Detail
GlowInstance()Constructor
public function GlowInstance(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.