| Package | com.flexicious.controls |
| Class | public class TriStateCheckBox |
| Inheritance | TriStateCheckBox  CheckBox mx.controls.CheckBox |
| Implements | ITriStateCheckBoxFilterControl, IDelayedChange |
| Subclasses | CheckBoxRenderer |
See also
| Property | Defined By | ||
|---|---|---|---|
| allowUserToSelectMiddle : Boolean | TriStateCheckBox | ||
 | autoRegister : Boolean
Register with the container on creation complete
| CheckBox | |
| bindingTriggerEvent : String
The event to trigger the binding on. | CheckBox | |
| delayDuration : uint = 500
The amount of time (in milliseconds) to wait before dispatching the DELAY_CHANGE event. | TriStateCheckBox | ||
| enableDelayChange : Boolean = true | TriStateCheckBox | ||
| 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 | |
| middle : Boolean | TriStateCheckBox | ||
| radioButtonMode : Boolean
In single select datagrids, set this to true for the icon to
appear as if it is a radio button
| TriStateCheckBox | ||
| rendererStyleName : String | CheckBox | |
| searchField : String
The field to search on, usually same as the data field. | CheckBox | |
| selected : Boolean [override] | TriStateCheckBox | ||
| selectedState : String | TriStateCheckBox | ||
| Method | Defined By | ||
|---|---|---|---|
TriStateCheckBox(middle:Boolean = false)
Constructor
| TriStateCheckBox | ||
clear():void [override] | TriStateCheckBox | ||
dispatchEvent(event:Event):Boolean [override] | TriStateCheckBox | ||
getStyle(prop:String):* [override]
Support for radioButtonMode
| TriStateCheckBox | ||
getValue():Object [override]
Generic function that returns the value of a IFilterControl
| TriStateCheckBox | ||
| setSourceFromControl():void | CheckBox | |
setValue(val:Object):void [override]
Generic function that sets the value of a IFilterControl
| TriStateCheckBox | ||
| Method | Defined By | ||
|---|---|---|---|
clickHandler(event:MouseEvent):void [override]
Default click handler
| TriStateCheckBox | ||
| commitProperties():void [override] | CheckBox | |
keyUpHandler(event:KeyboardEvent):void [override] | TriStateCheckBox | ||
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override] | TriStateCheckBox | ||
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: int Where to place the icon. | CheckBox | ||
| Type: int Where to place the label. | CheckBox | ||
middleIcon | Type: Class CSS Inheritance: no Name of the class to use as the icon when a toggle button is not selected and the mouse is not over the button. The default value is null. | TriStateCheckBox | ||
| Constant | Defined By | ||
|---|---|---|---|
| STATE_CHECKED : String = checked [static] | TriStateCheckBox | ||
| STATE_MIDDLE : String = middle [static] | TriStateCheckBox | ||
| STATE_UNCHECKED : String = unchecked [static] | TriStateCheckBox | ||
| allowUserToSelectMiddle | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesallowUserToSelectMiddle:Boolean public function get allowUserToSelectMiddle():Boolean public function set allowUserToSelectMiddle(value:Boolean):void| delayDuration | property |
public var delayDuration:uint = 500The amount of time (in milliseconds) to wait before dispatching the DELAY_CHANGE event.
The default value is 500.
| enableDelayChange | property |
public var enableDelayChange:Boolean = true| middle | property |
middle:Boolean public function get middle():Boolean public function set middle(value:Boolean):void| radioButtonMode | property |
radioButtonMode:BooleanIn single select datagrids, set this to true for the icon to appear as if it is a radio button
public function get radioButtonMode():Boolean public function set radioButtonMode(value:Boolean):void| selected | property |
selected:Boolean[override] public function get selected():Boolean public function set selected(value:Boolean):void| selectedState | property |
selectedState:String public function get selectedState():String public function set selectedState(value:String):void| TriStateCheckBox | () | Constructor |
public function TriStateCheckBox(middle:Boolean = false)Constructor
Parametersmiddle:Boolean (default = false) |
| clear | () | method |
override public function clear():void| clickHandler | () | method |
override protected function clickHandler(event:MouseEvent):voidDefault click handler
Parameters
event:MouseEvent |
| dispatchEvent | () | method |
override public function dispatchEvent(event:Event):BooleanParameters
event:Event |
Boolean |
| getStyle | () | method |
override public function getStyle(prop:String):*Support for radioButtonMode
Parameters
prop:String |
* |
| getValue | () | method |
override public function getValue():ObjectGeneric function that returns the value of a IFilterControl
ReturnsObject |
| keyUpHandler | () | method |
override protected function keyUpHandler(event:KeyboardEvent):voidParameters
event:KeyboardEvent |
| setValue | () | method |
override public function setValue(val:Object):voidGeneric function that sets the value of a IFilterControl
Parameters
val:Object |
| updateDisplayList | () | method |
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):voidParameters
unscaledWidth:Number | |
unscaledHeight:Number |
| STATE_CHECKED | Constant |
public static const STATE_CHECKED:String = checked| STATE_MIDDLE | Constant |
public static const STATE_MIDDLE:String = middle| STATE_UNCHECKED | Constant |
public static const STATE_UNCHECKED:String = unchecked