Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.graphics 
GradientEntry 
Packagemx.graphics
Classpublic class GradientEntry
InheritanceGradientEntry Inheritance EventDispatcher Inheritance 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 SyntaxexpandedHide 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"
  />
  

See also



Public Properties
 PropertyDefined By
  alpha : Number
The transparency of a gradient fill.
GradientEntry
  color : uint
The color value for a gradient fill.
GradientEntry
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedprototype : 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
 MethodDefined By
  
GradientEntry(color:uint = 0x000000, ratio:Number = NaN, alpha:Number = 1.0)
Constructor.
GradientEntry
 Inherited
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
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[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.