ColorPickerEvent

Package	fl.events
Class	public class ColorPickerEvent
Inheritance	ColorPickerEvent Event Object

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

The ColorPickerEvent class defines events that are associated with the ColorPicker component. These include the following events:

ColorPickerEvent.CHANGE: dispatched when a user clicks a different color in the ColorPicker component.
ColorPickerEvent.ENTER: dispatched when a user presses the Enter key after entering a value in the text field of the ColorPicker component.
ColorPickerEvent.ITEM_ROLL_OUT: dispatched when the device pointer moves out of a color cell in the ColorPicker component.
ColorPickerEvent.ITEM_ROLL_OVER: dispatched when the device pointer moves over a color cell in the ColorPicker component.

Related API Elements

ColorPicker

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 [read-only] Gets the color value that is associated with the event.	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
		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, color:uint) Creates a new ColorPickerEvent object.	ColorPickerEvent
		clone():Event [override] Creates a copy of the ColorPickerEvent object and sets the value of each parameter to match the original.	ColorPickerEvent
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string that contains all the properties of the ColorPickerEvent object.	ColorPickerEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		CHANGE : String = "change" [static] Defines the value of the type property of the change event object.	ColorPickerEvent
		ENTER : String = "enter" [static] Defines the value of the type property of an enter event object.	ColorPickerEvent
		ITEM_ROLL_OUT : String = "itemRollOut" [static] Defines the value of the type property for an itemRollOut event object.	ColorPickerEvent
		ITEM_ROLL_OVER : String = "itemRollOver" [static] Defines the value of the type property for an itemRollOver event object.	ColorPickerEvent

Property Detail

color

property

color:uint [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets the color value that is associated with the event.

Implementation
public function get color():uint

Constructor Detail

ColorPickerEvent

()

Constructor

public function ColorPickerEvent(type:String, color:uint)

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Creates a new ColorPickerEvent object.

Parameters

	`type:String` — Indicates the current event type.

	`color:uint` — Indicates the color that is associated with the current event.

Method Detail

clone

()

method

override public function clone():Event

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Creates a copy of the ColorPickerEvent object and sets the value of each parameter to match the original.

Returns

Event — A copy of the ColorPickerEvent instance.

toString

()

method

override public function toString():String

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Returns a string that contains all the properties of the ColorPickerEvent object.

Returns

String — A string representation of the ColorPickerEvent object.

Constant Detail

CHANGE

Constant

public static const CHANGE:String = "change"

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Defines the value of the type property of the change event object.

This event has the following properties:

Property	Value
`bubbles`	`true`
`cancelable`	`true`
`color`	The current color value of the ColorPicker component.
`currentTarget`	The object that is actively processing the event object with an event listener.
`target`	The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.

Example ( How to use this example )

The following example displays the selected color's hexadecimal value when the color is changed:


import fl.controls.ColorPicker;
import fl.events.ColorPickerEvent;

var myColorPicker:ColorPicker = new ColorPicker();
myColorPicker.addEventListener(ColorPickerEvent.CHANGE, changeHandler);
myColorPicker.move(10, 10);
addChild(myColorPicker);

function changeHandler(event:ColorPickerEvent):void {
    trace("color changed:", event.color, "(#" + event.target.hexValue + ")");
}

ENTER

Constant

public static const ENTER:String = "enter"

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Defines the value of the type property of an enter event object.

This event has the following properties:

Property	Value
`bubbles`	`true`
`cancelable`	`true`
`color`	The current color value of the ColorPicker component.
`currentTarget`	The object that is actively processing the event object with an event listener.
`target`	The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.

ITEM_ROLL_OUT

Constant

public static const ITEM_ROLL_OUT:String = "itemRollOut"

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Defines the value of the type property for an itemRollOut event object.

This event has the following properties:

Property	Value
`bubbles`	`true`
`cancelable`	`true`
`color`	The current color value of the ColorPicker component.
`currentTarget`	The object that is actively processing the event object with an event listener.
`target`	The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.

Related API Elements

ITEM_ROLL_OVER

Constant

public static const ITEM_ROLL_OVER:String = "itemRollOver"

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Defines the value of the type property for an itemRollOver event object.

This event has the following properties:

Property	Value
`bubbles`	`true`
`cancelable`	`true`
`color`	The current color value of the ColorPicker component.
`currentTarget`	The object that is actively processing the event object with an event listener.
`target`	The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.

Related API Elements

ITEM_ROLL_OUT

Legal Notices | Online Privacy Policy

ColorPickerEvent - AS3 Flash

Classes x

color

ColorPickerEvent

clone

toString

CHANGE

ENTER

ITEM_ROLL_OUT

ITEM_ROLL_OVER