| Package | spark.filters |
| Class | public class GradientFilter |
| Inheritance | GradientFilter  BaseDimensionFilter BaseFilter EventDispatcher Object |
| Subclasses | GradientBevelFilter, GradientGlowFilter |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Show MXML Syntax
Hide MXML SyntaxThe <s:GradientFilter> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<s:GradientFilter
Properties
angle="45"
distance="4.0"
entries="[]"
type="inner"
/>
Default MXML Propertyentries
Related API Elements
Public Properties
| Property | Defined By | ||
|---|---|---|---|
| angle : Number
The angle, in degrees. | GradientFilter | ||
 | blurX : Number
The amount of horizontal blur. | BaseDimensionFilter | |
| blurY : Number
The amount of vertical blur. | BaseDimensionFilter | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| distance : Number
The offset distance of the glow. | GradientFilter | ||
| entries : Array
An Array of GradientEntry objects
defining the fill patterns for the gradient fill. | GradientFilter | ||
| knockout : Boolean
Specifies whether the object has a knockout effect. | BaseDimensionFilter | |
| quality : int
The number of times to apply the filter. | BaseDimensionFilter | |
| strength : Number
The strength of the imprint or spread. | BaseDimensionFilter | |
| type : String
The placement of the filter effect. | GradientFilter | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | GradientFilter | ||
| 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 | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Propagates a change event when the filter has changed. | BaseFilter | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Public Constants
Property Detail
angle | property |
angle:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The angle, in degrees. Valid values are 0 to 360. The angle value represents the angle of the theoretical light source falling on the object and determines the placement of the effect relative to the object. If distance is set to 0, the effect is not offset from the object, and therefore the angle property has no effect.
The default value is 45.
Implementation
public function get angle():Number public function set angle(value:Number):voiddistance | property |
entries | property |
entries:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
An Array of GradientEntry objects defining the fill patterns for the gradient fill.
The default value is [].
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get entries():Array public function set entries(value:Array):voidtype | property |
type:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The placement of the filter effect. Possible values are flash.filters.BitmapFilterType constants:
BitmapFilterType.OUTER- Glow on the outer edge of the object.BitmapFilterType.INNER- Glow on the inner edge of the object.BitmapFilterType.FULL- Glow on top of the object.
The default value is BitmapFilterType.INNER.
Implementation
public function get type():String public function set type(value:String):voidRelated API Elements
Constructor Detail
GradientFilter | () | Constructor |
public function GradientFilter(colors:Array = null, alphas:Array = null, ratios:Array = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
Parameterscolors:Array (default = null) | |
alphas:Array (default = null)colors array. Valid values for each element in the array are 0 to 1.
For example, .25 sets a transparency value of 25%.
| |
ratios:Array (default = null) |
Mon Apr 10 2017, 12:28 PM -07:00