| Package | mx.effects.effectClasses |
| Class | public class GlowInstance |
| Inheritance | GlowInstance  TweenEffectInstance EffectInstance flash.events.EventDispatcher |
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 Glow effect,
the TweenEvent.value property contains a 4-item Array, where:
GlowFilter.color property.Glow.alphaFrom
and Glow.alphaTo property.Glow.blurXFrom
and Glow.blurXTo property.Glow.blurYFrom
and Glow.blurYTo property.See also
| Property | Defined 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 | ||
 | className : String
The name of the effect class, such as
"FadeInstance". | EffectInstance | |
| color : uint = 0xFFFFFFFF
The color of the glow.
| GlowInstance | ||
| 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 | |
| inner : Boolean
The inner flag of the glow.
| GlowInstance | ||
| knockout : Boolean
The knockout flag of the glow.
| GlowInstance | ||
| 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 | |
| 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 | |
| strength : Number
The strength of the glow.
| GlowInstance | ||
| 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 | |
| Method | Defined by | ||
|---|---|---|---|
|
GlowInstance(target:Object)
Constructor.
| GlowInstance | ||
|
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 | |
|
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 | |
|
seek(playheadTime:Number):void
Advances the effect to the specified position.
| TweenEffectInstance | |
|
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 | |
| alphaFrom | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var alphaFrom:NumberStarting transparency level.
| alphaTo | property |
public var alphaTo:NumberEnding transparency level.
| blurXFrom | property |
public var blurXFrom:NumberThe starting amount of horizontal blur.
| blurXTo | property |
public var blurXTo:NumberThe ending amount of horizontal blur.
| blurYFrom | property |
public var blurYFrom:NumberThe starting amount of vertical blur.
| blurYTo | property |
public var blurYTo:NumberThe ending amount of vertical blur.
| color | property |
public var color:uint = 0xFFFFFFFFThe color of the glow.
| inner | property |
public var inner:BooleanThe inner flag of the glow.
| knockout | property |
public var knockout:BooleanThe knockout flag of the glow.
| strength | property |
public var strength:NumberThe strength of the glow.
| GlowInstance | () | constructor |
public function GlowInstance(target:Object)Constructor.
Parameterstarget:Object — The Object to animate with this effect.
|