Packagemx.events
Classpublic class ColorPickerEvent
InheritanceColorPickerEvent Inheritance flash.events.Event

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.



Public Properties
 PropertyDefined by
  color : uint
The RGB color that was rolled over, rolled out of, selected, or entered.
ColorPickerEvent
  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
Public Methods
 MethodDefined by
  
ColorPickerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, index:int = -1, color:uint = 0xFFFFFFFF)
Constructor.
ColorPickerEvent
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
colorproperty
public var color:uint

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

indexproperty 
public var 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. 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)

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
CHANGEconstant
public static const CHANGE:String = "change"

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.
index The 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.
ENTERconstant 
public static const ENTER:String = "enter"

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.
index Always -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_OUTconstant 
public static const ITEM_ROLL_OUT:String = "itemRollOut"

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.
index The 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_OVERconstant 
public static const ITEM_ROLL_OVER:String = "itemRollOver"

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