Package | com.samgoldmansoftware.components |
Class | public class CheckBoxGroup |
Inheritance | CheckBoxGroup ![]() |
Default MXML PropertydataProvider
Property | Defined By | ||
---|---|---|---|
labelField : String
The name of the field in the data provider items to display
as the label. | CheckBoxGroup | ||
labelFunction : Function
A user-supplied function to run on each item to determine its label. | CheckBoxGroup | ||
selectedItems : ArrayCollection
Specifies the objects from the dataProvider which are selected. | CheckBoxGroup |
Method | Defined By | ||
---|---|---|---|
Constructor
| CheckBoxGroup | ||
itemToLabel(item:Object):String [override]
Given a data item, return the correct text a renderer
should display while taking the labelField
and labelFunction properties into account. | CheckBoxGroup |
labelField | property |
labelField:String
The name of the field in the data provider items to display
as the label.
The labelFunction
property overrides this property.
public function get labelField():String
public function set labelField(value:String):void
labelFunction | property |
labelFunction:Function
A user-supplied function to run on each item to determine its label.
The labelFunction
property overrides
the labelField
property.
You can supply a labelFunction
that finds the
appropriate fields and returns a displayable string. The
labelFunction
is also good for handling formatting and
localization.
The label function takes a single argument which is the item in the data provider and returns a String.
myLabelFunction(item:Object):String
public function get labelFunction():Function
public function set labelFunction(value:Function):void
selectedItems | property |
selectedItems:ArrayCollection
Specifies the objects from the dataProvider which are selected. Those items which are selected will appear as checked.
This property can be used as the source for data binding.
public function get selectedItems():ArrayCollection
public function set selectedItems(value:ArrayCollection):void
CheckBoxGroup | () | Constructor |
public function CheckBoxGroup()
Constructor
itemToLabel | () | method |
override public function itemToLabel(item:Object):String
Given a data item, return the correct text a renderer
should display while taking the labelField
and labelFunction
properties into account.
Parameters
item:Object |
String |