mx.graphics.GradientEntry - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.graphics
Class	public class GradientEntry
Inheritance	GradientEntry EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The GradientEntry class defines the objects that control a transition as part of a gradient fill. You use this class with the LinearGradient and RadialGradient classes to define a gradient fill.

MXML Syntax expanded

Hide MXML Syntax

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

  <mx:GradientEntry
    Properties
    alpha="1.0"
    color="0x000000"
    ratio="-1"
  />

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		alpha : Number The transparency of a gradient fill.	GradientEntry
		color : uint The color value for a gradient fill.	GradientEntry
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		ratio : Number Where in the graphical element, as a percentage from 0.0 to 1.0, Flex samples the associated color at 100%.	GradientEntry

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		GradientEntry(color:uint = 0x000000, ratio:Number = NaN, alpha:Number = 1.0) Constructor.	GradientEntry
		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
		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

Property Detail

alpha

property

alpha:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The transparency of a gradient fill. Possible values are 0.0 (invisible) through 1.0 (opaque).

The default value is 1.0.

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 alpha():Number
public function set alpha(value:Number):void

color

property

color:uint

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The color value for a gradient fill.

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 color():uint
public function set color(value:uint):void

ratio

property

ratio:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Where in the graphical element, as a percentage from 0.0 to 1.0, Flex samples the associated color at 100%. For example, a ratio of 0.33 means Flex begins the transition to that color 33% of the way through the graphical element.

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 ratio():Number
public function set ratio(value:Number):void

Constructor Detail

GradientEntry

()

Constructor

public function GradientEntry(color:uint = 0x000000, ratio:Number = NaN, alpha:Number = 1.0)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Parameters

	`color:uint` (default = `0x000000`) — The color for this gradient entry. The default value is 0x000000 (black).

	`ratio:Number` (default = `NaN`) — Where in the graphical element the associated color is sampled at 100%. Flex uniformly spaces any GradientEntries with missing ratio values. The default value is NaN.

	`alpha:Number` (default = `1.0`) — The alpha value for this entry in the gradient. This parameter is optional. The default value is 1.0.