Packagecom.samgoldmansoftware.components
Classpublic class CheckBoxGroup
InheritanceCheckBoxGroup Inheritance spark.components.DataGroup

Default MXML PropertydataProvider



Public Properties
 PropertyDefined 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
Public Methods
 MethodDefined 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
Property Detail
labelFieldproperty
labelField:String

The name of the field in the data provider items to display as the label. The labelFunction property overrides this property.


Implementation
    public function get labelField():String
    public function set labelField(value:String):void
labelFunctionproperty 
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


Implementation
    public function get labelFunction():Function
    public function set labelFunction(value:Function):void
selectedItemsproperty 
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.


Implementation
    public function get selectedItems():ArrayCollection
    public function set selectedItems(value:ArrayCollection):void
Constructor Detail
CheckBoxGroup()Constructor
public function CheckBoxGroup()

Constructor

Method Detail
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

Returns
String