ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.events 

ColorPickerEvent  - AS3 Flex

Packagemx.events
Classpublic class ColorPickerEvent
InheritanceColorPickerEvent Inheritance Event Inheritance Object

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

Represents events that are specific to the ColorPicker control, such as when the user rolls the mouse over or out of a swatch in the swatch panel.

More examples

Learn more



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
  color : uint
The RGB color that was rolled over, rolled out of, selected, or entered.
ColorPickerEvent
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  index : int
The zero-based index in the Color's data provider that corresponds to the color that was rolled over, rolled out of, or selected.
ColorPickerEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
ColorPickerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, index:int = -1, color:uint = 0xFFFFFFFF)
Constructor.
ColorPickerEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  CHANGE : String = "change"
[static] The ColorPickerEvent.CHANGE constant defines the value of the type property of the event that is dispatched when the user selects a color from the ColorPicker control.
ColorPickerEvent
  ENTER : String = "enter"
[static] The ColorPickerEvent.ENTER constant defines the value of the type property of the event that is dispatched when the user presses the Enter key after typing in the color selector box.
ColorPickerEvent
  ITEM_ROLL_OUT : String = "itemRollOut"
[static] The ColorPickerEvent.ITEM_ROLL_OUT constant defines the value of the type property of the event that is dispatched when the user rolls the mouse out of a swatch in the swatch panel.
ColorPickerEvent
  ITEM_ROLL_OVER : String = "itemRollOver"
[static] The ColorPickerEvent.ITEM_ROLL_OVER constant defines the value of the type property of the event that is dispatched when the user rolls the mouse over of a swatch in the swatch panel.
ColorPickerEvent
Property Detail

color

property
public var color:uint

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

The RGB color that was rolled over, rolled out of, selected, or entered.

index

property 
public var index:int

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

The zero-based index in the Color's data provider that corresponds to the color that was rolled over, rolled out of, or selected. If the event type is ColorPickerEvent.ENTER, will have default value -1; it is not set in this case because the user can enter an RGB string that doesn't match any color in the data provider.

Constructor Detail

ColorPickerEvent

()Constructor
public function ColorPickerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, index:int = -1, color:uint = 0xFFFFFFFF)

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

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
index:int (default = -1) — The zero-based index in the Color's data provider that corresponds to the color that was rolled over, rolled out of, or selected.
 
color:uint (default = 0xFFFFFFFF) — The RGB color that was rolled over, rolled out of, selected, or entered.
Constant Detail

CHANGE

Constant
public static const CHANGE:String = "change"

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

The ColorPickerEvent.CHANGE constant defines the value of the type property of the event that is dispatched when the user selects a color from the ColorPicker control.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
colorThe RGB color that was selected.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
indexThe zero-based index in the Color's data provider that corresponds to the color that was selected.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

ENTER

Constant 
public static const ENTER:String = "enter"

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

The ColorPickerEvent.ENTER constant defines the value of the type property of the event that is dispatched when the user presses the Enter key after typing in the color selector box.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
colorThe RGB color that was entered.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
indexAlways -1.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

ITEM_ROLL_OUT

Constant 
public static const ITEM_ROLL_OUT:String = "itemRollOut"

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

The ColorPickerEvent.ITEM_ROLL_OUT constant defines the value of the type property of the event that is dispatched when the user rolls the mouse out of a swatch in the swatch panel.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
colorThe RGB color of the color that was rolled over.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
indexThe zero-based index in the Color's data provider that corresponds to the color that was rolled over.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

ITEM_ROLL_OVER

Constant 
public static const ITEM_ROLL_OVER:String = "itemRollOver"

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

The ColorPickerEvent.ITEM_ROLL_OVER constant defines the value of the type property of the event that is dispatched when the user rolls the mouse over of a swatch in the swatch panel.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
colorThe RGB color of the color that the user rolled out of.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
indexThe zero-based index in the Color's data provider that corresponds to the color that the user rolled out of.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.