KoolMoves AS3 API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class ComboBox

Package | km.components
Class | public class ComboBox
Inheritance | ComboBox UIComponent flash.display.Sprite

The ComboBox component class.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | background : Image [read-only] >> Reference to the background image. | ComboBox
|  | duotone : Array The duotone property can be used to convert the colors of the component into duotone. | UIComponent
|  | editable : Boolean | ComboBox
|  | enabled : Boolean Specifies if the component is enabled. If a component is disabled, it will be turned into grayscale and become partly transparent. | UIComponent
|  | expand : BaseButton [read-only] >> Reference to the expand button. | ComboBox
|  | height : Number | UIComponent
|  | iconField : String Gets or sets the name of the field that contains the combo label icon. | ComboBox
|  | label : Label [read-only] >> Reference to the label. | ComboBox
|  | labelField : String Gets or sets the name of the field that contains the combo label text. | ComboBox
|  | list : List [read-only] >> Reference to the list. | ComboBox
|  | margin : int The margin between the bounding box of the background and the sub components inside. | ComboBox
|  | onChange : Function onChange handler. | ComboBox
|  | prompt : String | ComboBox
|  | toolTip : String Text to use as toolTip when ToolTip is enabled. | UIComponent
|  | value : String [read-only] | ComboBox
|  | width : Number | UIComponent
|  | x : Number | UIComponent
|  | y : Number | UIComponent

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined by
--- | --- | ---
|  | ComboBox() | ComboBox
|  | clone():* Returns a clone of the component. The skin of the component is cloned but other things like the text of a label or the items of a list aren't. | UIComponent
|  | move(x:int, y:int, animationMode:int = 0, animationFrames:int = 12, easeInOut:Boolean = false):void Moves the component to the specified coordinates. | UIComponent
|  | setProperties(o:Object):void Sets a number of properties at once. | UIComponent
|  | setSize(w:int, h:int):void Sets the size width and height. | UIComponent

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined by
--- | --- | --- | ---
|  | animationComplete | The animationComplete event is broadcasted when an animated move is completed. | UIComponent
|  | change | The change event is broadcasted when a different item is selected. When the selection is changed by scripting, the event is not broadcasted. It's also possible to use the onChange handler. | ComboBox

Property detail

background | property

`background:Image` [read-only]

>> Reference to the background image.

Implementation
`public function get background():Image`

editable | property |

`editable:Boolean` [read-write]

Implementation
`public function get editable():Boolean`
`public function set editable(value:Boolean):void`

expand | property |

`expand:BaseButton` [read-only]

>> Reference to the expand button.

Implementation
`public function get expand():BaseButton`

iconField | property |

`iconField:String` [read-write]

Gets or sets the name of the field that contains the combo label icon.

Implementation
`public function get iconField():String`
`public function set iconField(value:String):void`

label | property |

`label:Label` [read-only]

>> Reference to the label.

Implementation
`public function get label():Label`

labelField | property |

`labelField:String` [read-write]

Gets or sets the name of the field that contains the combo label text.

Implementation
`public function get labelField():String`
`public function set labelField(value:String):void`

list | property |

`list:List` [read-only]

>> Reference to the list.

Implementation
`public function get list():List`

margin | property |

`public var margin:int`

The margin between the bounding box of the background and the sub components inside.

onChange | property |

`public var onChange:Function`

onChange handler.

prompt | property |

`prompt:String` [read-write]

Implementation
`public function get prompt():String`
`public function set prompt(value:String):void`

value | property |

`value:String` [read-only]

Implementation
`public function get value():String`
Constructor detail

ComboBox | () | constructor

`public function ComboBox()`
Event detail

change | event

Event object type: `flash.events.Event`

The change event is broadcasted when a different item is selected.
When the selection is changed by scripting, the event is not broadcasted.
It's also possible to use the onChange handler.

Last update : 04/05/2008