| Package | com.flexicious.controls |
| Class | public class CheckBox |
| Inheritance | CheckBox  mx.controls.CheckBox |
| Implements | ISelectedBitFilterControl, ISelectedBitDataBoundControl |
| Subclasses | TriStateCheckBox |
See also
| Property | Defined By | ||
|---|---|---|---|
| autoRegister : Boolean
Register with the container on creation complete
| CheckBox | ||
| bindingTriggerEvent : String
The event to trigger the binding on. | CheckBox | ||
| filterComparisionType : String
This is usually automatically set, you don't have to manually set it,
unless you're sending strings as Date objects. | CheckBox | ||
| filterOperation : String
The filter operation to apply to the comparison
See the FilterExpression class for a list. | CheckBox | ||
| filterTriggerEvent : String
The event that the filter triggers on. | CheckBox | ||
| grid : IExtendedDataGrid
The grid that the filter belongs to - can be null
if filter is used outside the grid
| CheckBox | ||
| gridColumn : IDataGridFilterColumn
The grid column that the filter belongs to - can be null
if filter is used outside the grid
| CheckBox | ||
| rendererStyleName : String | CheckBox | ||
| searchField : String
The field to search on, usually same as the data field. | CheckBox | ||
| Property | Defined By | ||
|---|---|---|---|
| _filterControlInterface : FilterControlImpl | CheckBox | ||
| Method | Defined By | ||
|---|---|---|---|
clear():void
lears the state of the checkbox
| CheckBox | ||
getValue():Object
Generic function that returns the value of a IFilterControl
Returns this.selected for the CheckBox
| CheckBox | ||
setSourceFromControl():void | CheckBox | ||
setValue(val:Object):void
Generic function that sets the value of a IFilterControl
| CheckBox | ||
| Method | Defined By | ||
|---|---|---|---|
commitProperties():void [override] | CheckBox | ||
| Style | Description | Defined By | ||
|---|---|---|---|---|
iconTop | Type: int Where to place the icon | CheckBox | ||
labelTop | Type: int Where to place the label | CheckBox | ||
| _filterControlInterface | property |
protected var _filterControlInterface:FilterControlImpl| autoRegister | property |
autoRegister:BooleanRegister with the container on creation complete
public function get autoRegister():Boolean public function set autoRegister(value:Boolean):void| bindingTriggerEvent | property |
bindingTriggerEvent:StringThe event to trigger the binding on. Defaults to none, so you must call applyChanges on the container to update the souce object.
public function get bindingTriggerEvent():String public function set bindingTriggerEvent(value:String):void| filterComparisionType | property |
filterComparisionType:StringThis is usually automatically set, you don't have to manually set it, unless you're sending strings as Date objects. When set, will attempt to first convert the current value to the type you specified and then do the conversion. Values : auto,string,number,boolean,date
The default value is auto.
public function get filterComparisionType():String public function set filterComparisionType(value:String):void| filterOperation | property |
filterOperation:StringThe filter operation to apply to the comparison See the FilterExpression class for a list. Please note, for CheckBoxList and MultiSelectComboBox, this field defaults to "InList" and is ignored when set. see
public function get filterOperation():String public function set filterOperation(value:String):void| filterTriggerEvent | property |
filterTriggerEvent:StringThe event that the filter triggers on. Defaults to "change", or if the filterRenderer supports com.flexicious.controls.interfaces.IDelayedChange, then the delayedChange event.
public function get filterTriggerEvent():String public function set filterTriggerEvent(value:String):voidSee also
| grid | property |
grid:IExtendedDataGridThe grid that the filter belongs to - can be null if filter is used outside the grid
public function get grid():IExtendedDataGrid public function set grid(value:IExtendedDataGrid):void| gridColumn | property |
gridColumn:IDataGridFilterColumnThe grid column that the filter belongs to - can be null if filter is used outside the grid
public function get gridColumn():IDataGridFilterColumn public function set gridColumn(value:IDataGridFilterColumn):void| rendererStyleName | property |
public var rendererStyleName:String| searchField | property |
searchField:StringThe field to search on, usually same as the data field.
public function get searchField():String public function set searchField(value:String):void| clear | () | method |
public function clear():voidlears the state of the checkbox
| commitProperties | () | method |
override protected function commitProperties():void| getValue | () | method |
public function getValue():ObjectGeneric function that returns the value of a IFilterControl Returns this.selected for the CheckBox
ReturnsObject |
| setSourceFromControl | () | method |
public function setSourceFromControl():void| setValue | () | method |
public function setValue(val:Object):voidGeneric function that sets the value of a IFilterControl
Parameters
val:Object |