| Package | mx.events |
| Class | public class ColorPickerEvent |
| Inheritance | ColorPickerEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
More examples
Learn more
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : 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 | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : 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 | ||
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
ColorPickerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, index:int = -1, color:uint = 0xFFFFFFFF)
Constructor. | ColorPickerEvent | ||
|
Duplicates an instance of an Event subclass. | Event | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined 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.
Parameterstype:String — The event type; indicates the action that caused the event.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
index:int (default = -1) | |
color:uint (default = 0xFFFFFFFF) |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
color | The RGB color that was selected. |
currentTarget | The 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. |
target | The 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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
color | The RGB color that was entered. |
currentTarget | The 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. |
target | The 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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
color | The RGB color of the color that was rolled over. |
currentTarget | The 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. |
target | The 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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
color | The RGB color of the color that the user rolled out of. |
currentTarget | The 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. |
target | The 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. |
Thu Dec 4 2014, 05:50 PM -08:00