Packagecom.ghostwire.ui.controls
Classpublic class uiCheckListBox
InheritanceuiCheckListBox Inheritance uiListBox Inheritance uiScrollable Inheritance uiComponent Inheritance flash.display.Sprite

The uiCheckListBox displays a list of checkbox items within a scrollable area.

Note: unlike the uiListBox, drag-scrolling and drag-selection is not supported (ie end-users cannot mouse down and drag to scroll the list or drag to select multiple items). This is not a bug but intended behavior. Selection of items is intended to be on a toggle-basis.

Note: unlike the uiCheckBox, toggling selection of an item in the uiCheckBoxList is done when the mouse is pressed down on the item (not upon mouse released over the item).

"multipleSelect" Property
The value is always true.

"skin" Property
The default value is "CheckListBox" and the asset(s) used are:

 CheckListBox.png
 CheckListBoxItem.png
 

~ This class is available in Aspire UI Components Standard Edition ~



Public Properties
 PropertyDefined by
 InheritedalignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
uiComponent
 InheritedalignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
uiComponent
 Inheritedbackground : Object
Indicates the style of the background for this component.
uiComponent
 Inheritedcontainer : uiComponent
Indicates the uiComponent instance that contains this instance.
uiComponent
 InheriteddataMap : Object
Indicates an object used to map properties in the renderers to properties in the data objects (items).
uiListBox
 Inheriteddepth : int
Indicates how deep the component is in the containment hierarchy.
uiComponent
 InheriteddesiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
uiComponent
 InheriteddesiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
uiComponent
 Inheritedenabled : Boolean
Indicates whether the component is enabled for user interaction.
uiComponent
 InheritedfillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated horizontal space.
uiComponent
 InheritedfillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated vertical space.
uiComponent
 InheritedfocusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus rectangle.
uiComponent
 InheritedfocusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it is in focus.
uiComponent
 Inheritedheight : Number
Indicates the current height of the component.
uiComponent
 InheritedhScrollPolicy : String
A String value indicating if the horizontal scroll bar should be shown.
uiScrollable
 InheriteditemRenderer : Class
Indicates the class to use to paint the "face" of the item.
uiListBox
 Inheritedmargin : Object
Indicates the thickness of the space surrounding the component.
uiComponent
 InheritedmaxHeight : int
Indicates the upper limit for height.
uiComponent
 InheritedmaxWidth : int
Indicates the upper limit for width.
uiComponent
 InheritedminHeight : int
Indicates the lower limit for height.
uiComponent
 InheritedminWidth : int
Indicates the lower limit for width.
uiComponent
 Inheritedmodel : uiModel
Indicates the uiModel that holds the items of this uiListBox.
uiListBox
 InheritedmultipleSelect : Boolean
Indicates whether multiple items can be selected.
uiListBox
 Inheritedpadding : Object
Indicates the thickness of the interior space from the edge of the component to the content area, which is where child components, if any, are contained.
uiComponent
 InheritedrangeH : uiRange
Returns the uiRange object used to represent the horizontal scroll range.
uiScrollable
 InheritedrangeV : uiRange
Returns the uiRange object used to represent the vertical scroll range.
uiScrollable
 InheritedrowCount : int
Indicates the preferred number of rows to display.
uiListBox
 InheritedrowHeight : int
Indicates the fixed value to be used for the height of every row in the list.
uiListBox
 InheritedrowWidth : int
Indicates the fixed value to be used for the width of every item in the list.
uiListBox
 InheritedscrollX : Number
Indicates the horizontal scroll position.
uiScrollable
 InheritedscrollY : Number
Indicates the vertical scroll position.
uiScrollable
 Inheritedselectable : Boolean
Indicates whether items in this list are selectable.
uiListBox
 InheritedselectedIndex : int
Indicates the index position of the last selected item.
uiListBox
 InheritedselectedIndices : Array
Returns an array of index positions of the selected items.
uiListBox
 InheritedselectedItem : Object
Indicates the last selected item.
uiListBox
 InheritedselectedItems : Array
Gets or sets an array containing the selected items.
uiListBox
 InheritedselectedValue : Object
Indicates the value associated with the last selected item.
uiListBox
 Inheritedskin : String
Indicates the name of the skin to use for this component instance.
uiComponent
 Inheritedstretch : Boolean
Indicates whether surplus space available in the parent container should be allocated to this component.
uiComponent
 InheritedtextStyle : String
Indicates the style to use for uiText instances contained in this component.
uiComponent
 InheritedtoolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers over this control.
uiComponent
 Inheriteduihscrollbar : uiScrollBar
Returns the uiScrollBar instance used in this component.
uiScrollable
 Inheriteduiskin : uiBitmapImage
Returns the uiBitmapImage rendered as the skin - for advanced users only.
uiComponent
 Inheriteduivscrollbar : uiVScrollBar
Returns the uiVScrollBar instance used in this component.
uiScrollable
 Inheritedvisible : Boolean
Indicates whether or not the component is visible within its container.
uiComponent
 InheritedvScrollPolicy : String
A String value indicating if the vertical scroll bar should be shown.
uiScrollable
 Inheritedwidth : Number
Indicates the current width of the component.
uiComponent
Public Methods
 MethodDefined by
  
uiCheckListBox(items:Object = null)
Constructor - creates a new uiCheckListBox instance.
uiCheckListBox
 Inherited
getLabel(item:Object):String
Returns the text displayed by an item.
uiListBox
 Inherited
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
uiComponent
 Inherited
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
uiComponent
 Inherited
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
uiComponent
 Inherited
scrollToItem(item:Object):void
Scrolls to the indicated item in the list.
uiListBox
 Inherited
selectAll():void
Selects all items in this list.
uiListBox
 Inherited
setFocus(flag:Boolean = true):void
Gives this component instance the focus; the component must be on the display list and has its tabEnabled property set to true, otherwise this method will fail silently.
uiComponent
 Inherited
setScrollPosition(x:int, y:int, noEvent:Boolean = false):void
Sets the scrollX and scrollY positions, dispatching a "scroll" event.
uiScrollable
 Inherited
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified width and height.
uiComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
uiComponent
 Inherited
validateNow():void
Validates and render the component instance, and any component instances with depth higher than itself in the validation queue, immediately.
uiComponent
Events
 EventSummaryDefined by
 Inherited Dispatched when the selection in the list has changed.uiListBox
 Inherited Dispatched when the component's visible property is changed from true to false via calling the setVisible() method.uiComponent
 Inherited Dispatched whenever the user interacts with any item in the list.uiListBox
 Inherited Dispatched when the component's position within its parent container has changed via calling the move() method.uiComponent
 Inherited Dispatched when the component's size has changed via calling the setSize() method.uiComponent
 Inherited Dispatched when the scroll position of a scrollable component has changed.uiScrollable
 Inherited Dispatched when the component's visible property is changed from false to true via calling the setVisible() method.uiComponent
Constructor detail
uiCheckListBox()constructor
public function uiCheckListBox(items:Object = null)

Constructor - creates a new uiCheckListBox instance.

Parameters
items:Object (default = null) — The list of item(s) to populate the model. You can specify an array of data objects (duplicates will be ignored), an array of strings, or an XML object.