spark.filters.GradientFilter - Adobe® Flex® 4 Language Reference (Flex 4)

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

The base class for filters that provide gradient visual effects.

MXML Syntax expanded

Hide MXML Syntax

The <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

Public Properties

Hide Inherited Public Properties

Show Inherited 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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		GradientFilter(colors:Array = null, alphas:Array = null, ratios:Array = null) 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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		notifyFilterChanged():void	BaseFilter
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		CHANGE : String = "change" [static]	BaseFilter

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):void

distance

property

distance:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The offset distance of the glow.

The default value is 4.0.

Implementation
public function get distance():Number
public function set distance(value:Number):void

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):void

type

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):void

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.

Parameters

	`colors:Array` (default = `null`) — An array of RGB hexadecimal color values to use in the gradient. For example, red is 0xFF0000, blue is 0x0000FF, and so on.

	`alphas:Array` (default = `null`) — An array of alpha transparency values for the corresponding colors in the `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`) — An array of color distribution ratios; valid values are 0 to 255.