Packagefl.controls
Classpublic class ColorPicker
InheritanceColorPicker Inheritance UIComponent Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IFocusManagerComponent

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

The ColorPicker component displays a list of one or more swatches from which the user can select a color.

By default, the component displays a single swatch of color on a square button. When the user clicks this button, a panel opens to display the complete list of swatches.

View the examples

See also

ColorPickerEvent


Public Properties
 PropertyDefined By
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the display object.
DisplayObject
  colors : Array
Gets or sets the array of custom colors that the ColorPicker component provides.
ColorPicker
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
 InheriteddoubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events.
InteractiveObject
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
  editable : Boolean
Gets or sets a Boolean value that indicates whether the internal text field of the ColorPicker component is editable.
ColorPicker
  enabled : Boolean
Gets or sets a value that indicates whether the component can accept user interaction.
ColorPicker
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedfocusEnabled : Boolean
Gets or sets a Boolean value that indicates whether the component can receive focus after the user clicks it.
UIComponent
 InheritedfocusManager : IFocusManager
Gets or sets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
 Inheritedheight : Number
Gets or sets the height of the component, in pixels.
UIComponent
  hexValue : String
[read-only] Gets the string value of the current color selection.
ColorPicker
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
  imeMode : String
Gets or sets the mode of the input method editor (IME).
ColorPicker
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
Gets or sets a value that indicates whether the component can receive focus after the user clicks it.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
DisplayObjectContainer
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedparent : DisplayObjectContainer
[read-only] Indicates the DisplayObjectContainer object that contains this display object.
DisplayObject
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedroot : DisplayObject
[read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.
DisplayObject
 Inheritedrotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
DisplayObject
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
Multiplies the current width of the component by a scale factor.
UIComponent
 InheritedscaleY : Number
Multiplies the current height of the component by a scale factor.
UIComponent
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
  selectedColor : uint
Gets or sets the swatch that is currently highlighted in the palette of the ColorPicker component.
ColorPicker
  showTextField : Boolean
Gets or sets a Boolean value that indicates whether the internal text field of the ColorPicker component is displayed.
ColorPicker
 InheritedsoundTransform : SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
  textField : TextField
A reference to the internal text field of the ColorPicker component.
ColorPicker
 InheritedtextSnapshot : TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
 Inheritedtransform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls over a sprite in which the buttonMode property is set to true.
Sprite
 Inheritedversion : String = "3.0.0.15"
The version number of the components.
UIComponent
 Inheritedvisible : Boolean
Gets or sets a value that indicates whether the current component instance is visible.
UIComponent
 Inheritedwidth : Number
Gets or sets the width of the component, in pixels.
UIComponent
 Inheritedx : Number
Gets or sets the x coordinate that represents the position of the component along the x axis within its parent container.
UIComponent
 Inheritedy : Number
Gets or sets the y coordinate that represents the position of the component along the y axis within its parent container.
UIComponent
Public Methods
 MethodDefined By
  
Creates an instance of the ColorPicker class.
ColorPicker
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.
DisplayObjectContainer
 Inherited
Deletes a style property from this component instance.
UIComponent
  
Hides the color palette.
ColorPicker
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Shows or hides the focus indicator on this component.
UIComponent
 Inherited
Initiates an immediate draw operation, without invalidating everything as invalidateNow does.
UIComponent
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
 Inherited
Returns the child display object instance that exists at the specified index.
DisplayObjectContainer
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Returns the index position of a child DisplayObject instance.
DisplayObjectContainer
 Inherited
Retrieves the object that currently has focus.
UIComponent
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.
DisplayObject
 Inherited
Retrieves a style property that is set in the style lookup chain of the component.
UIComponent
  
[static] Retrieves the default style map for the current component.
ColorPicker
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Evaluates the display object to see if it overlaps or intersects with the obj display object.
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.
DisplayObject
 Inherited
invalidate(property:String, callLater:Boolean = true):void
Marks a property as invalid and redraws the component on the next frame unless otherwise specified.
UIComponent
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
[static] Merges the styles from multiple classes into one object.
UIComponent
 Inherited
Moves the component to the specified position within its parent.
UIComponent
  
Shows the color palette.
ColorPicker
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Changes the position of an existing child in the display object container.
DisplayObjectContainer
 Inherited
Sets the focus to this component.
UIComponent
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setSize(width:Number, height:Number):void
Sets the component to the specified width and height.
UIComponent
 Inherited
setStyle(style:String, value:Object):void
Sets a style property on this component instance.
UIComponent
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
DisplayObjectContainer
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Validates and updates the properties and layout of this object, redrawing it if necessary.
UIComponent
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited Dispatched when Flash Player or an AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited Dispatched when a display object is added to the display list.DisplayObject
 Inherited Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
   Dispatched when the user clicks a color in the palette.ColorPicker
 Inherited Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
   Dispatched when the user closes the color palette.ColorPicker
 Inherited Dispatched when the user selects the context menu associated with this interactive object in an AIR application.InteractiveObject
 Inherited Dispatched when Flash Player or an AIR application loses operating system focus and is becoming inactive.EventDispatcher
 Inherited Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
   Dispatched when the user presses the Enter key after editing the internal text field of the ColorPicker component.ColorPicker
 Inherited Dispatched when the playhead is entering a new frame.DisplayObject
 Inherited Dispatched after a display object gains focus.InteractiveObject
 Inherited Dispatched after a display object loses focus.InteractiveObject
 Inherited Dispatched after the component visibility changes from visible to invisible.UIComponent
   Dispatched when the user rolls out of a swatch in the color palette.ColorPicker
   Dispatched when the user rolls over a swatch in the color palette.ColorPicker
 Inherited Dispatched when the user presses a key.InteractiveObject
 Inherited Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 Inherited Dispatched when the user releases a key.InteractiveObject
 Inherited Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 Inherited Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited Dispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 Inherited Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 Inherited Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 Inherited Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited Dispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited Dispatched after the component is moved.UIComponent
 Inherited Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 Inherited Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().InteractiveObject
 Inherited Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 Inherited Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 Inherited Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 Inherited Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
   Dispatched when the user opens the color palette.ColorPicker
 Inherited Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited Dispatched when the display list is about to be updated and rendered.DisplayObject
 Inherited Dispatched after the component is resized.UIComponent
 Inherited Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 Inherited Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited Dispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 Inherited Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited Dispatched after the component visibility changes from invisible to visible.UIComponent
 Inherited Dispatched when the value of the object's tabChildren flag changes.InteractiveObject
 Inherited Dispatched when the object's tabEnabled flag changes.InteractiveObject
 Inherited Dispatched when the value of the object's tabIndex property changes.InteractiveObject
Styles
 Style Description Defined By
  
background
Type: Class
The class that provides the background of the palette that appears in the ColorPicker component. The default value is ColorPicker_backgroundSkin.
ColorPicker
  
backgroundPadding
Type: Number Format: Length
The padding that appears around the group of color swatches, in pixels. The default value is 5.
ColorPicker
  
colorWell
Type: Class
The class that provides the skin for the color well when it is filled with a color. The default value is ColorPicker_colorWell.
ColorPicker
  
columnCount
Type: Number Format: Length
The number of columns to be drawn in the ColorPicker color palette. The default value is 18.
ColorPicker
  
disabledSkin
Type: Class
The class that provides the skin for a disabled button in the ColorPicker. The default value is ColorPicker_disabledSkin.
ColorPicker
 Inherited Type: flash.text.TextFormat
The TextFormat object to use to render the component label when the button is disabled.
UIComponent
  
downSkin
Type: Class
The class that provides the skin for the ColorPicker button when it is in the down position. The default value is ColorPicker_downSkin.
ColorPicker
  
embedFonts
Type: Boolean
Indicates whether embedded font outlines are used to render the text field. If this value is true, Flash Player renders the text field by using embedded font outlines. If this value is false, Flash Player renders the text field by using device fonts.

If you set the embedFonts property to true for a text field, you must specify a font for that text by using the font property of a TextFormat object that is applied to the text field. If the specified font is not embedded in the SWF file, the text is not displayed.

The default value is false.
ColorPicker
 Inherited Type: Number Format: Length
The padding that separates the outside boundaries of the component from the outside edges of the focus indicator, in pixels.
UIComponent
 Inherited Type: Class
The skin to be used to display focus indicators.
UIComponent
  
overSkin
Type: Class
The class that provides the skin for the color well when the pointing device rolls over it. The default value is ColorPicker_overSkin.
ColorPicker
  
swatchHeight
Type: Number Format: Length
The height of each swatch, in pixels. The default value is 10.
ColorPicker
  
swatchPadding
Type: Number Format: Length
Defines the padding that appears around each swatch in the color palette, in pixels. The default value is 1.
ColorPicker
  
swatchSelectedSkin
Type: Class
The class that provides the skin which is used to highlight the currently selected color. The default value is ColorPicker_swatchSelectedSkin.
ColorPicker
  
swatchSkin
Type: Class
The class that provides the skin which is used to draw the swatches contained in the ColorPicker component. The default value is ColorPicker_swatchSkin.
ColorPicker
  
swatchWidth
Type: Number Format: Length
The width of each swatch, in pixels. The default value is 10.
ColorPicker
  
textFieldSkin
Type: Class
The class that provides the background for the text field of the ColorPicker component. The default value is ColorPicker_textFieldSkin.
ColorPicker
 Inherited Type: flash.text.TextFormat
The TextFormat object to use to render the component label.
UIComponent
  
textPadding
Type: Number Format: Length
The padding that appears around the color TextField, in pixels. The default value is 3.
ColorPicker
  
upSkin
Type: Class
The class that provides the skin for the ColorPicker button when it is in the up position. The default value is ColorPicker_upSkin.
ColorPicker
Property Detail
colorsproperty
colors:Array  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Gets or sets the array of custom colors that the ColorPicker component provides. The ColorPicker component draws and displays the colors that are described in this array.

Note: The maximum number of colors that the ColorPicker component can display is 1024.

By default, this array contains 216 autogenerated colors.


Implementation
    public function get colors():Array
    public function set colors(value:Array):void

Example

The following example creates a color picker that is restricted to shades of green:
import fl.controls.ColorPicker;

var cp:ColorPicker = new ColorPicker();
cp.colors = [ 0x001100, 
              0x003300, 
              0x005500, 
              0x007700, 
              0x009900, 
              0x00BB00, 
              0x00DD00, 
              0x00FF00 ];
addChild(cp);
editableproperty 
editable:Boolean  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Gets or sets a Boolean value that indicates whether the internal text field of the ColorPicker component is editable. A value of true indicates that the internal text field is editable; a value of false indicates that it is not.

The default value is true.


Implementation
    public function get editable():Boolean
    public function set editable(value:Boolean):void
enabledproperty 
enabled:Boolean  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Gets or sets a value that indicates whether the component can accept user interaction. A value of true indicates that the component can accept user interaction; a value of false indicates that it cannot.

If you set the enabled property to false, the color of the container is dimmed and user input is blocked (with the exception of the Label and ProgressBar components).

The default value is true.


Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
hexValueproperty 
hexValue:String  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Gets the string value of the current color selection.


Implementation
    public function get hexValue():String

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 + ")");
}
imeModeproperty 
imeMode:String  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Gets or sets the mode of the input method editor (IME). The IME makes it possible for users to use a QWERTY keyboard to enter characters from the Chinese, Japanese, and Korean character sets.

Flash sets the IME to the specified mode when the component gets focus, and restores it to the original value after the component loses focus.

The flash.system.IMEConversionMode class defines constants for the valid values for this property. Set this property to null to prevent the use of the IME with the component.


Implementation
    public function get imeMode():String
    public function set imeMode(value:String):void

See also

selectedColorproperty 
selectedColor:uint  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Gets or sets the swatch that is currently highlighted in the palette of the ColorPicker component.

The default value is 0x000000.


Implementation
    public function get selectedColor():uint
    public function set selectedColor(value:uint):void

Example

The following example creates a ColorPicker component instance that displays its selectedColor and hexValue properties when changed:

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

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

function changeHandler(event:ColorPickerEvent):void {
    var myCP:ColorPicker = event.currentTarget as ColorPicker;
    trace("{ColorPickerEvent}.color:", event.color);
    trace("{ColorPicker}.selectedColor:", myCP.selectedColor);
    trace("{ColorPicker}.hexValue:", myCP.hexValue);
}
showTextFieldproperty 
showTextField:Boolean  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Gets or sets a Boolean value that indicates whether the internal text field of the ColorPicker component is displayed. A value of true indicates that the internal text field is displayed; a value of false indicates that it is not.

The default value is true.


Implementation
    public function get showTextField():Boolean
    public function set showTextField(value:Boolean):void

See also


Example

The following example uses a CheckBox component to toggle the value of a ColorPicker component's showTextField property:

import fl.controls.CheckBox;
import fl.controls.ColorPicker;

var myCheckBox:CheckBox = new CheckBox();
myCheckBox.textField.autoSize = TextFieldAutoSize.LEFT;
myCheckBox.label = "showTextField:";
myCheckBox.move(10, 10);
myCheckBox.selected = true;
myCheckBox.addEventListener(Event.CHANGE, changeHandler);
addChild(myCheckBox);

var myColorPicker:ColorPicker = new ColorPicker();
myColorPicker.showTextField = myCheckBox.selected;
myColorPicker.move(myCheckBox.x, myCheckBox.y + myCheckBox.height);
myColorPicker.open();
addChild(myColorPicker);

function changeHandler(event:Event):void {
    myColorPicker.showTextField = myCheckBox.selected;
    try {
    myColorPicker.open();
    } catch (error:*) {
        trace("Caught");
    }
}
textFieldproperty 
public var textField:TextField

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

A reference to the internal text field of the ColorPicker component.

See also

Constructor Detail
ColorPicker()Constructor
public function ColorPicker()

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Creates an instance of the ColorPicker class.

Method Detail
close()method
public function close():void

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Hides the color palette. Calling this method causes the close event to be dispatched. If the color palette is already closed or disabled, this method has no effect.

See also

getStyleDefinition()method 
public static function getStyleDefinition():Object

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Retrieves the default style map for the current component. The style map contains the type that is appropriate for the component, depending on the style that the component uses. For example, the disabledTextFormat style contains a value of null or a TextFormat object. You can use these styles and call setStyle() on the current component. The following code overrides the default disabledTextFormat style on the specified component:

componentInstance.setStyle("disabledTextFormat", new TextFormat());

Returns
Object — Default styles object.

See also


Example

The following example creates a style browser for several component classes:
import fl.controls.*;
import fl.containers.*;
import fl.controls.listClasses.*;
import fl.controls.dataGridClasses.*;
import fl.controls.progressBarClasses.*;
import fl.core.UIComponent;
import fl.data.DataProvider;

var dp:DataProvider = new DataProvider();
dp.addItem( { label: "BaseScrollPane",    data:BaseScrollPane } );
dp.addItem( { label: "Button",             data:Button } );
dp.addItem( { label: "CellRenderer",    data:CellRenderer } );
dp.addItem( { label: "CheckBox",         data:CheckBox } );
dp.addItem( { label: "ColorPicker",     data:ColorPicker } );
dp.addItem( { label: "ComboBox",         data:ComboBox } );
dp.addItem( { label: "DataGrid",         data:DataGrid } );
dp.addItem( { label: "HeaderRenderer",    data:HeaderRenderer } );
dp.addItem( { label: "ImageCell",        data:ImageCell } );
dp.addItem( { label: "IndeterminateBar",data:IndeterminateBar } );
dp.addItem( { label: "Label",             data:Label } );
dp.addItem( { label: "List",             data:List } );
dp.addItem( { label: "NumericStepper",     data:NumericStepper } );
dp.addItem( { label: "ProgressBar",     data:ProgressBar } );
dp.addItem( { label: "RadioButton",     data:RadioButton } );
dp.addItem( { label: "ScrollPane",         data:ScrollPane } );
dp.addItem( { label: "Slider",             data:Slider } );
dp.addItem( { label: "TextArea",         data:TextArea } );
dp.addItem( { label: "TextInput",         data:TextInput } );
dp.addItem( { label: "TileList",         data:TileList } );
dp.addItem( { label: "UILoader",         data:UILoader } );
dp.addItem( { label: "UIComponent",     data:UIComponent } );

var cb:ComboBox = new ComboBox();
cb.move(10,10);
cb.setSize(300,25);
cb.prompt = "Select a component to view its styles";
cb.rowCount = 12;
cb.dataProvider = dp;
cb.addEventListener(Event.CHANGE, showStyleDefinition);
addChild(cb);

var dg:DataGrid = new DataGrid();
dg.setSize(425,300);
dg.move(10,50);
dg.columns = [ new DataGridColumn("StyleName"), new DataGridColumn("DefaultValue") ];
addChild(dg);

function showStyleDefinition(e:Event):void {
    var componentClass:Class = e.target.selectedItem.data as Class;
    var styles:Object = componentClass["getStyleDefinition"].call(this);
    trace(styles.toString());
    var styleData:DataProvider = new DataProvider();
    for(var i:* in styles) {
        trace(i + " : " + styles[i]);
        styleData.addItem( { StyleName:i, DefaultValue:styles[i] } );
    }
    styleData.sortOn("StyleName");
    dg.dataProvider = styleData;
}
open()method 
public function open():void

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Shows the color palette. Calling this method causes the open event to be dispatched. If the color palette is already open or disabled, this method has no effect.

See also


Example

The following example creates a ColorPicker component instance and calls the open() method when the user rolls the mouse over the instance:

import fl.controls.ColorPicker;

var myColorPicker:ColorPicker = new ColorPicker();
myColorPicker.editable = false;
myColorPicker.addEventListener(MouseEvent.ROLL_OVER, rollOverHandler);
myColorPicker.move(10, 10);
addChild(myColorPicker);

function rollOverHandler(event:MouseEvent):void {
    event.currentTarget.open();
}
Event Detail
change Event
Event Object Type: fl.events.ColorPickerEvent
ColorPickerEvent.type property = fl.events.ColorPickerEvent.CHANGE

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Dispatched when the user clicks a color in the palette.

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

This event has the following properties:

PropertyValue
bubblestrue
cancelabletrue
colorThe current color value of the ColorPicker component.
currentTargetThe object that is actively processing the event object with an event listener.
targetThe 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

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 + ")");
}
close Event  
Event Object Type: flash.events.Event
Event.type property = flash.events.Event.CLOSE

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Dispatched when the user closes the color palette.

The Event.CLOSE constant defines the value of the type property of a close event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object whose connection has been closed.

See also

enter Event  
Event Object Type: fl.events.ColorPickerEvent
ColorPickerEvent.type property = fl.events.ColorPickerEvent.ENTER

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Dispatched when the user presses the Enter key after editing the internal text field of the ColorPicker component.

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

This event has the following properties:

PropertyValue
bubblestrue
cancelabletrue
colorThe current color value of the ColorPicker component.
currentTargetThe object that is actively processing the event object with an event listener.
targetThe 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

The following example creates an editable ComboBox component instance that traces the selectedColor and hexValue properties when the user presses the Enter key in the internal text field:

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

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

function enterHandler(event:ColorPickerEvent):void {
    trace("color: " + event.color);
    trace("selectedColor: " + myColorPicker.selectedColor);
    trace("hexValue: " + myColorPicker.hexValue);
    trace("");
}

See also

itemRollOut Event  
Event Object Type: fl.events.ColorPickerEvent
ColorPickerEvent.type property = fl.events.ColorPickerEvent.ITEM_ROLL_OUT

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Dispatched when the user rolls out of a swatch in the color palette.

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

This event has the following properties:

PropertyValue
bubblestrue
cancelabletrue
colorThe current color value of the ColorPicker component.
currentTargetThe object that is actively processing the event object with an event listener.
targetThe 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.

See also

itemRollOver Event  
Event Object Type: fl.events.ColorPickerEvent
ColorPickerEvent.type property = fl.events.ColorPickerEvent.ITEM_ROLL_OVER

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Dispatched when the user rolls over a swatch in the color palette.

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

This event has the following properties:

PropertyValue
bubblestrue
cancelabletrue
colorThe current color value of the ColorPicker component.
currentTargetThe object that is actively processing the event object with an event listener.
targetThe 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.

See also

open Event  
Event Object Type: flash.events.Event
Event.type property = flash.events.Event.OPEN

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Dispatched when the user opens the color palette.

The Event.OPEN constant defines the value of the type property of an open event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe network object that has opened a connection.

Example

The following example creates a ColorPicker component instance and calls the open() method when the user rolls the mouse over the instance:

import fl.controls.ColorPicker;

var myColorPicker:ColorPicker = new ColorPicker();
myColorPicker.editable = false;
myColorPicker.addEventListener(MouseEvent.ROLL_OVER, rollOverHandler);
myColorPicker.move(10, 10);
addChild(myColorPicker);

function rollOverHandler(event:MouseEvent):void {
    event.currentTarget.open();
}

See also

Examples How to use examples
ColorPickerExample.as

This example demonstrates how to change the color of a Shape instance by listening to events from a ColorPicker instance.

To run the example, follow these steps:

  1. Drag three ColorPicker instances and one ComboBox instance to the Stage.
  2. Name the ColorPicker instances cp1, cp2, and cp3.
  3. Name the ComboBox cb.
  4. Save this code as ColorPickerExample.as in the same directory as your FLA file.
  5. Set the Document class in the FLA file to ColorPickerExample.
package 
{
    import fl.controls.ColorPicker;
    import fl.controls.ComboBox;
    import flash.display.BlendMode;
    import flash.display.Shape;
    import flash.display.Sprite;
    import flash.events.*;
    
    public class ColorPickerExample extends Sprite
    {
        var circle1:Shape;
        var circle2:Shape;
        var circle3:Shape;
        
        public function ColorPickerExample():void {
            setupCircles();
            setupComboBox();
            
            cp1.addEventListener(Event.RENDER, colorChange);
            cp2.addEventListener(Event.RENDER, colorChange);
            cp3.addEventListener(Event.RENDER, colorChange);
        }
        private function colorChange(e:Event):void {
            var cp:ColorPicker = e.target as ColorPicker
            switch (cp) {
                case cp1:
                    colorCircle(circle1, cp.selectedColor);
                    break;
                case cp2:
                    colorCircle(circle2, cp.selectedColor);
                    break;
                case cp3:
                    colorCircle(circle3, cp.selectedColor);
                    break;
                default:
                    break;
            }
        }
        private function setupComboBox():void {
            cb.setSize(150,24);
            cb.addItem( { label: "Select BlendMode:",     data:BlendMode.NORMAL } );
            cb.addItem( { label: "DARKEN",                 data:BlendMode.DARKEN } );
            cb.addItem( { label: "DIFFERENCE",             data:BlendMode.DIFFERENCE } );
            cb.addItem( { label: "HARDLIGHT",             data:BlendMode.HARDLIGHT } );
            cb.addItem( { label: "INVERT",                 data:BlendMode.INVERT } );
            cb.addItem( { label: "LAYER",                 data:BlendMode.LAYER } );
            cb.addItem( { label: "MULTIPLY",             data:BlendMode.MULTIPLY } );
            cb.addItem( { label: "SUBTRACT",             data:BlendMode.SUBTRACT } );
            cb.addEventListener(Event.CHANGE,blendChange);
        }
        private function blendChange(e:Event):void {
            var newBlend:String = cb.selectedItem.data;
            if (newBlend) {
                circle1.blendMode = newBlend;
                circle2.blendMode = newBlend;
                circle3.blendMode = newBlend;
            }
        }
        private function setupCircles():void {
            circle1 = new Shape();
            circle2 = new Shape();
            circle3 = new Shape();
            
            circle1.x = 127;
            circle1.y = 64;
            circle2.x = 87;
            circle2.y = 130;
            circle3.x = 164;
            circle3.y = 130;
            
            colorCircle(circle1, 0xFF0000);
            colorCircle(circle2, 0xFF0000);
            colorCircle(circle3, 0xFF0000);
            
            addChild(circle1);
            addChild(circle2);
            addChild(circle3);
        }
        private function colorCircle(circle:Shape, newColor:uint):void {
            circle.graphics.clear();
            circle.graphics.beginFill(newColor, 1);
            circle.graphics.drawCircle(0, 0, 50);
            circle.graphics.endFill();    
        }
    }
}