Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
ColorPickerEvent

Package | mx.events
Class | public class ColorPickerEvent
Inheritance | ColorPickerEvent flash.events.Event

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.

Public Properties

| Property | Defined 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

| Method | Defined By
--- | --- | ---
|  | ColorPickerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, index:int = -1, color:uint = 0xFFFFFFFF) Constructor. | ColorPickerEvent

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.

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:

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.

Sun Mar 5 2017, 03:42 PM +11:00