com.flexicious.controls.CheckBoxList

	Property	Defined By
		addAllItem : Boolean Flag, when set will cause the associated control to have an Filter.ALL_ITEM Item value, which can then be used by the filtering infrastructure to ignore the column in the search	CheckBoxList
		addAllItemText : String Text of the "All" item.	CheckBoxList
		autoRegister : Boolean Register with the container on creation complete	CheckBoxList
		bindingTriggerEvent : String The event to trigger the binding on.	CheckBoxList
		borderAdjust : Boolean = false Flag to ensure that the right border shows.	CheckBoxList
		dataField : String For Selected Value Support	CheckBoxList
		dropdownWidth : Number Width of the dropdown	CheckBoxList
		filterComparisionType : String This is usually automatically set, you don't have to manually set it, unless you're sending strings as Date objects.	CheckBoxList
		filterOperation : String The filter operation to apply to the comparison See the FilterExpression class for a list.	CheckBoxList
		filterTriggerEvent : String The event that the filter triggers on.	CheckBoxList
		grid : IExtendedDataGrid The grid that the filter belongs to - can be null if filter is used outside the grid	CheckBoxList
		gridColumn : IDataGridFilterColumn The grid column that the filter belongs to - can be null if filter is used outside the grid	CheckBoxList
		hasSearch : Boolean	CheckBoxList
		isAllSelected : Boolean [read-only] Returns true if the all item is selected false otherwise	CheckBoxList
		rendererStyleName : String	CheckBoxList
		searchField : String The field to search on, usually same as the data field.	CheckBoxList
		selectedValues : ArrayCollection Gets the selected values on our list control.	CheckBoxList
		toolTipFunction : Function ooltip to show on each of the checkboxes.	CheckBoxList
		useTriState : Boolean Flag that indicates that checking any of the boxes in the list is going to cause the first "All" box to turn into middle state Checking the first box will cause everything to be selected, unchecking the first box is going to cause everything to be not selected.	CheckBoxList

	Property	Defined By
		_filterControlInterface : FilterControlImpl	CheckBoxList

	Method	Defined By
		clear():void lears the selected indexes and items	CheckBoxList
		commitPropertiesSelectedValues():void	CheckBoxList
		convertToArray(items:Object):Array	CheckBoxList
		getItemIndex(item:Object):int Gets the position at which specified item exists in the dataprovider.	CheckBoxList
		getTooltip(obj:Object):String If tooltip function is specified, returns the result of that function.	CheckBoxList
		getValue():Object Generic function that returns the value of a IFilterControl See the docs for the selectedValues property	CheckBoxList
		setSourceFromControl():void	CheckBoxList
		setValue(val:Object):void Generic function that sets the value of a IFilterControl.	CheckBoxList

	Method	Defined By
		drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void [override]	CheckBoxList
		drawRowBackground(s:Sprite, rowIndex:int, y:Number, height:Number, color:uint, dataIndex:int):void [override]	CheckBoxList
		drawRowBackgrounds():void [override]	CheckBoxList
		drawSelectionIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void [override]	CheckBoxList
		keyDownHandler(event:KeyboardEvent):void [override]	CheckBoxList
		layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void [override]	CheckBoxList
		onItemClick(event:ListEvent):void	CheckBoxList
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override]	CheckBoxList

Property Detail

_filterControlInterface

property

protected var _filterControlInterface:FilterControlImpl

addAllItem

property

addAllItem:Boolean

Flag, when set will cause the associated control to have an Filter.ALL_ITEM Item value, which can then be used by the filtering infrastructure to ignore the column in the search

Implementation
public function get addAllItem():Boolean
public function set addAllItem(value:Boolean):void

addAllItemText

property

addAllItemText:String

Text of the "All" item. Defaults to "All"

Implementation
public function get addAllItemText():String
public function set addAllItemText(value:String):void

autoRegister

property

autoRegister:Boolean

Implementation
public function get autoRegister():Boolean
public function set autoRegister(value:Boolean):void

bindingTriggerEvent

property

bindingTriggerEvent:String

The event to trigger the binding on. Defaults to none, so you must call applyChanges on the container to update the souce object.

Implementation
public function get bindingTriggerEvent():String
public function set bindingTriggerEvent(value:String):void

borderAdjust

property

public var borderAdjust:Boolean = false

Flag to ensure that the right border shows.

dataField

property

dataField:String

For Selected Value Support

Implementation
public function get dataField():String
public function set dataField(value:String):void

dropdownWidth

property

dropdownWidth:Number

Width of the dropdown

Implementation
public function get dropdownWidth():Number
public function set dropdownWidth(value:Number):void

filterComparisionType

property

filterComparisionType:String

This 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.

Implementation
public function get filterComparisionType():String
public function set filterComparisionType(value:String):void

filterOperation

property

filterOperation:String

The 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

Implementation
public function get filterOperation():String
public function set filterOperation(value:String):void

filterTriggerEvent

property

filterTriggerEvent:String

The event that the filter triggers on. Defaults to "change", or if the filterRenderer supports com.flexicious.controls.interfaces.IDelayedChange, then the delayedChange event.

Implementation
public function get filterTriggerEvent():String
public function set filterTriggerEvent(value:String):void

grid

property

grid:IExtendedDataGrid

The grid that the filter belongs to - can be null if filter is used outside the grid

Implementation
public function get grid():IExtendedDataGrid
public function set grid(value:IExtendedDataGrid):void

gridColumn

property

gridColumn:IDataGridFilterColumn

The grid column that the filter belongs to - can be null if filter is used outside the grid

Implementation
public function get gridColumn():IDataGridFilterColumn
public function set gridColumn(value:IDataGridFilterColumn):void

hasSearch

property

hasSearch:Boolean

Implementation
public function get hasSearch():Boolean
public function set hasSearch(value:Boolean):void

isAllSelected

property

isAllSelected:Boolean [read-only]

Returns true if the all item is selected false otherwise

Implementation
public function get isAllSelected():Boolean

rendererStyleName

property

public var rendererStyleName:String

searchField

property

searchField:String

The field to search on, usually same as the data field.

Implementation
public function get searchField():String
public function set searchField(value:String):void

selectedValues

property

selectedValues:ArrayCollection

Gets the selected values on our list control. This returns a ArrayCollection. Basically goes through all the selected items, gets a list of all selected items, gets the "dataField" property on the selectedItems, and returns a list. Needs the datafield property to be set.

Implementation
public function get selectedValues():ArrayCollection
public function set selectedValues(value:ArrayCollection):void

toolTipFunction

property

public var toolTipFunction:Function

ooltip to show on each of the checkboxes.

useTriState

property

useTriState:Boolean

Flag that indicates that checking any of the boxes in the list is going to cause the first "All" box to turn into middle state Checking the first box will cause everything to be selected, unchecking the first box is going to cause everything to be not selected. Please note, unless you set addAllItem to true, this flag will be meaningless and false.

Implementation
public function get useTriState():Boolean
public function set useTriState(value:Boolean):void

Method Detail

clear

()

method

public function clear():void

lears the selected indexes and items

commitPropertiesSelectedValues

()

method

public function commitPropertiesSelectedValues():void

convertToArray

()

method

public function convertToArray(items:Object):Array

Parameters

items:Object

Returns

Array

drawItem

()

method

override protected function drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void

Parameters

	`item:IListItemRenderer`

	`selected:Boolean` (default = `false`)

	`highlighted:Boolean` (default = `false`)

	`caret:Boolean` (default = `false`)

	`transition:Boolean` (default = `false`)

drawRowBackground

()

method

override protected function drawRowBackground(s:Sprite, rowIndex:int, y:Number, height:Number, color:uint, dataIndex:int):void

Parameters

	`s:Sprite`

	`rowIndex:int`

	`y:Number`

	`height:Number`

	`color:uint`

	`dataIndex:int`

drawRowBackgrounds

()

method

override protected function drawRowBackgrounds():void

drawSelectionIndicator

()

method

override protected function drawSelectionIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void

Parameters

	`indicator:Sprite`

	`x:Number`

	`y:Number`

	`width:Number`

	`height:Number`

	`color:uint`

	`itemRenderer:IListItemRenderer`

getItemIndex

()

method

public function getItemIndex(item:Object):int

Gets the position at which specified item exists in the dataprovider.

Parameters

item:Object

Returns

int —

getTooltip

()

method

public function getTooltip(obj:Object):String

If tooltip function is specified, returns the result of that function.

Parameters

obj:Object

Returns

String

getValue

()

method

public function getValue():Object

Generic function that returns the value of a IFilterControl See the docs for the selectedValues property

Returns

Object

keyDownHandler

()

method

override protected function keyDownHandler(event:KeyboardEvent):void

Parameters

event:KeyboardEvent

layoutChrome

()

method

override protected function layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void

Parameters

	`unscaledWidth:Number`

	`unscaledHeight:Number`

onItemClick

()

method

protected function onItemClick(event:ListEvent):void

Parameters

event:ListEvent

setSourceFromControl

()

method

public function setSourceFromControl():void

setValue

()

method

public function setValue(val:Object):void

Generic function that sets the value of a IFilterControl.

Parameters

val:Object

updateDisplayList

()

method

override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Parameters

	`unscaledWidth:Number`

	`unscaledHeight:Number`

Mon Jun 24 2013, 11:00 PM -04:00

Flexicious Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
CheckBoxList	Properties \| Methods

Package	com.flexicious.controls
Class	public class CheckBoxList
Inheritance	CheckBoxList mx.controls.List
Implements	IMultiSelectFilterControl, IMultiSelectDataBoundControl, ICheckBoxList