Package | com.ghostwire.ui.controls |
Class | public class uiCheckListBox |
Inheritance | uiCheckListBox ![]() ![]() ![]() ![]() |
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 ~
Method | Defined by | ||
---|---|---|---|
uiCheckListBox(items:Object = null)
Constructor - creates a new
uiCheckListBox instance. | uiCheckListBox | ||
![]() |
getLabel(item:Object):String
Returns the text displayed by an item.
| uiListBox | |
![]() |
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
| uiComponent | |
![]() |
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
| uiComponent | |
![]() |
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
| uiComponent | |
![]() |
scrollToItem(item:Object):void
Scrolls to the indicated item in the list.
| uiListBox | |
![]() |
selectAll():void
Selects all items in this list.
| uiListBox | |
![]() |
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 | |
![]() |
setScrollPosition(x:int, y:int, noEvent:Boolean = false):void
Sets the
scrollX and scrollY positions, dispatching a "scroll" event. | uiScrollable | |
![]() |
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified
width and height . | uiComponent | |
![]() |
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
| uiComponent | |
![]() |
validateNow():void
Validates and render the component instance, and any component instances with
depth higher than itself in the validation queue, immediately. | uiComponent |
uiCheckListBox | () | constructor |
public function uiCheckListBox(items:Object = null)
Constructor - creates a new uiCheckListBox
instance.
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.
|