Packagemx.effects
Classpublic class Glow
InheritanceGlow Inheritance TweenEffect Inheritance Effect Inheritance 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.AnimateFilter class as an alternative to this class.

In Flex 4, use an AnimateFilter effect with a Glow bitmap filter.


The Glow effect lets you apply a visual glow effect to a component.

The Glow effect uses the Flash GlowFilter class as part of its implementation. For more information, see the flash.filters.GlowFilter class. If you apply a Glow effect to a component, you cannot apply a GlowFilter or a second Glow effect to the component.

MXML SyntaxexpandedHide MXML Syntax

The <mx:Glow> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:Glow
    id="ID"
    alphaFrom="val"
    alphaTo="val"
    blurXFrom="val"
    blurXTo="val"
    blurYFrom="val"
    blurYTo="val"
    color="themeColor of the application"
    inner="false|true"
    knockout="false|true"
    strength="2"
  />
  

View the examples

See also

flash.filters.GlowFilter
mx.effects.effectClasses.GlowInstance


Public Properties
 PropertyDefined By
  alphaFrom : Number = 1
Starting transparency level between 0.0 and 1.0, where 0.0 means transparent and 1.0 means fully opaque.
Glow
  alphaTo : Number = 0
Ending transparency level between 0.0 and 1.0, where 0.0 means transparent and 1.0 means fully opaque.
Glow
  blurXFrom : Number = 5
The starting amount of horizontal blur.
Glow
  blurXTo : Number = 0
The ending amount of horizontal blur.
Glow
  blurYFrom : Number = 5
The starting amount of vertical blur.
Glow
  blurYTo : Number = 0
The ending amount of vertical blur.
Glow
 InheritedclassName : String
[read-only] The name of the effect class, such as "Fade".
Effect
  color : uint = 0xFFFFFFFF
The color of the glow.
Glow
 InheritedcustomFilter : EffectTargetFilter
Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect.
Effect
 Inheritedduration : Number
Duration of the effect in milliseconds.
Effect
 InheritedeasingFunction : Function = null
The easing function for the animation.
TweenEffect
 InheritedeffectTargetHost : IEffectTargetHost
A property that lets you access the target list-based control of a data effect.
Effect
 Inheritedfilter : String
Specifies an algorithm for filtering targets for an effect.
Effect
 InheritedhideFocusRing : Boolean
Determines whether the effect should hide the focus ring when starting the effect.
Effect
  inner : Boolean
Specifies whether the glow is an inner glow.
Glow
 InheritedinstanceClass : Class
An object of type Class that specifies the effect instance class class for this effect class.
Effect
 InheritedisPlaying : 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
  knockout : Boolean
Specifies whether the object has a knockout effect.
Glow
 InheritedperElementOffset : Number
Additional delay, in milliseconds, for effect targets after the first target of the effect.
Effect
 InheritedplayheadTime : Number
Current time position of the effect.
Effect
 InheritedrelevantProperties : Array
An Array of property names to use when performing filtering.
Effect
 InheritedrelevantStyles : Array
An Array of style names to use when performing filtering.
Effect
 InheritedrepeatCount : int = 1
Number of times to repeat the effect.
Effect
 InheritedrepeatDelay : int = 0
Amount of time, in milliseconds, to wait before repeating the effect.
Effect
 InheritedstartDelay : int = 0
Amount of time, in milliseconds, to wait before starting the effect.
Effect
  strength : Number = 2
The strength of the imprint or spread.
Glow
 InheritedsuspendBackgroundProcessing : Boolean = false
If true, blocks all background processing while the effect is playing.
Effect
 Inheritedtarget : Object
The object to which this effect is applied.
Effect
 Inheritedtargets : Array
An Array of objects that are targets for the effect.
Effect
 InheritedtriggerEvent : 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
Protected Properties
 PropertyDefined By
 InheritedapplyTransitionEndProperties : Boolean
This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself.
Effect
 InheritedendValuesCaptured : Boolean = false
A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs.
Effect
Public Methods
 MethodDefined By
  
Glow(target:Object = null)
Constructor.
Glow
 Inherited
Captures the current values of the relevant properties on the effect's targets and saves them as end values.
Effect
 Inherited
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
 Inherited
Captures the current values of the relevant properties on the effect's targets.
Effect
 Inherited
createInstance(target:Object = null):IEffectInstance
Creates a single effect instance and initializes it.
Effect
 Inherited
createInstances(targets:Array = null):Array
Takes an Array of target objects and invokes the createInstance() method on each target.
Effect
 Inherited
Removes event listeners from an instance and removes it from the list of instances.
Effect
 Inherited
end(effectInstance:IEffectInstance = null):void
Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.
Effect
 Inherited
Returns an Array of Strings, where each String is the name of a property changed by this effect.
Effect
 Inherited
pause():void
Pauses the effect until you call the resume() method.
Effect
 Inherited
play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
Begins playing the effect.
Effect
 Inherited
resume():void
Resumes the effect after it has been paused by a call to the pause() method.
Effect
 Inherited
reverse():void
Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.
Effect
 Inherited
stop():void
Stops the effect, leaving the effect targets in their current state.
Effect
Protected Methods
 MethodDefined By
 Inherited
applyValueToTarget(target:Object, property:String, value:*, props:Object):void
Used internally by the Effect infrastructure.
Effect
 Inherited
Called when an effect instance has finished playing.
Effect
 Inherited
This method is called when the effect instance starts playing.
Effect
 Inherited
Called when an effect instance has stopped by a call to the stop() method.
Effect
 Inherited
filterInstance(propChanges:Array, target:Object):Boolean
Determines the logic for filtering out an effect instance.
Effect
 Inherited
getValueFromTarget(target:Object, property:String):*
Called by the captureStartValues() method to get the value of a property from the target.
Effect
 Inherited
Copies properties of the effect to the effect instance.
Effect
 Inherited
Called when the TweenEffect dispatches a TweenEvent.
TweenEffect
Events
 Event Summary Defined By
 InheritedDispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method.Effect
 InheritedDispatched when the effect starts playing.Effect
 InheritedDispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.Effect
 InheritedDispatched when the tween effect ends.TweenEffect
 InheritedDispatched when the tween effect starts, which corresponds to the first call to the onTweenUpdate() method.TweenEffect
 InheritedDispatched every time the tween effect updates the target.TweenEffect
Property Detail
alphaFromproperty
public var alphaFrom:Number = 1

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

Starting transparency level between 0.0 and 1.0, where 0.0 means transparent and 1.0 means fully opaque.

The default value is 1.

alphaToproperty 
public var alphaTo:Number = 0

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

Ending transparency level between 0.0 and 1.0, where 0.0 means transparent and 1.0 means fully opaque.

The default value is 0.

blurXFromproperty 
public var blurXFrom:Number = 5

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

The starting amount of horizontal blur. Valid values are from 0.0 to 255.0.

The default value is 5.

blurXToproperty 
public var blurXTo:Number = 0

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

The ending amount of horizontal blur. Valid values are from 0.0 to 255.0.

The default value is 0.

blurYFromproperty 
public var blurYFrom:Number = 5

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

The starting amount of vertical blur. Valid values are from 0.0 to 255.0.

The default value is 5.

blurYToproperty 
public var blurYTo:Number = 0

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

The ending amount of vertical blur. Valid values are from 0.0 to 255.0.

The default value is 0.

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. The default value is the value of the themeColor style property of the application. The default value of this property is StyleManager.NOT_A_COLOR. When play() is called on the effect, if the color property is set to that default value, the color value in the effect instance will be set to the value of the current themeColor style for the application.

The default value is StyleManager.NOT_A_COLOR.

innerproperty 
public var inner:Boolean

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

Specifies whether the glow is an inner glow. A value of true indicates an inner glow within the outer edges of the object. The default value is false, to specify an outer glow around the outer edges of the object.

The default value is false.

knockoutproperty 
public var knockout:Boolean

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

Specifies whether the object has a knockout effect. A value of true makes the object's fill color transparent to reveal the background color of the underlying object. The default value is false to specify no knockout effect.

The default value is false.

strengthproperty 
public var strength:Number = 2

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

The strength of the imprint or spread. The higher the value, the more color is imprinted and the stronger the contrast between the glow and the background. Valid values are from 0 to 255.

The default value is 2.

Constructor Detail
Glow()Constructor
public function Glow(target:Object = null)

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

Constructor.

Parameters
target:Object (default = null) — The Object to animate with this effect.
Examples
GlowEffectExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!--

  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 Halo Glow 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:Glow id="glowImage" duration="1000"
            alphaFrom="1.0" alphaTo="0.3"
            blurXFrom="0.0" blurXTo="50.0"
            blurYFrom="0.0" blurYTo="50.0"
            color="0x00FF00"/>
        <mx:Glow id="unglowImage" duration="1000"
            alphaFrom="0.3" alphaTo="1.0"
            blurXFrom="50.0" blurXTo="0.0"
            blurYFrom="50.0" blurYTo="0.0"
            color="0x0000FF"/>
    </fx:Declarations>

    <s:Panel title="Halo Glow Effect Example" width="75%" height="75%" >
        <s:VGroup left="20" right="20" top="20" bottom="20">

            <s:Label width="100%" color="blue"
                text="Click and hold the mouse on the image to see glowImage effect. Release the mouse to see unglowImage effect."/>

            <mx:Image source="@Embed(source='assets/Product1.png')"
                mouseDownEffect="{glowImage}"
                mouseUpEffect="{unglowImage}"/>
        </s:VGroup>
    </s:Panel>
</s:Application>