Packagecom.flexicious.controls
Classpublic class CheckBoxTileList
InheritanceCheckBoxTileList Inheritance mx.controls.TileList
Implements IMultiSelectFilterControl, IMultiSelectDataBoundControl, ICheckBoxList

A checkbox list that implements IMultiSelectFilterControl (IFilterControl) and IMultiSelectDataBoundControl (IDataBoundControl) which enables it to be used within the filtering/binding infrasturcture.

Default MXML PropertydataProvider

See also

com.flexicious.controls.interfaces.filters.IFilterControl
com.flexicious.controls.interfaces.databindings.IDataBoundControl

Public Properties
 PropertyDefined 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
CheckBoxTileList
  addAllItemText : String
Text of the "All" item.
CheckBoxTileList
  autoRegister : Boolean
Register with the container on creation complete
CheckBoxTileList
  bindingTriggerEvent : String
The event to trigger the binding on.
CheckBoxTileList
  dataField : String
For Selected Value Support
CheckBoxTileList
  dropdownWidth : Number
Width of the dropdown
CheckBoxTileList
  filterComparisionType : String
This is usually automatically set, you don't have to manually set it, unless you're sending strings as Date objects.
CheckBoxTileList
  filterOperation : String
The filter operation to apply to the comparison See the FilterExpression class for a list.
CheckBoxTileList
  filterTriggerEvent : String
The event that the filter triggers on.
CheckBoxTileList
  grid : IExtendedDataGrid
The grid that the filter belongs to - can be null if filter is used outside the grid
CheckBoxTileList
  gridColumn : IDataGridFilterColumn
The grid column that the filter belongs to - can be null if filter is used outside the grid
CheckBoxTileList
  hasSearch : Boolean
CheckBoxTileList
  isAllSelected : Boolean
[read-only] Returns true if the all item is selected false otherwise
CheckBoxTileList
  rendererStyleName : String
CheckBoxTileList
  searchField : String
The field to search on, usually same as the data field.
CheckBoxTileList
  selectedValues : ArrayCollection
Gets the selected values on our list control.
CheckBoxTileList
  toolTipFunction : Function
ooltip to show on each of the checkboxes.
CheckBoxTileList
  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.
CheckBoxTileList
Protected Properties
 PropertyDefined By
  _filterControlInterface : FilterControlImpl
CheckBoxTileList
Public Methods
 MethodDefined By
  
clear():void
lears the selected indexes and items
CheckBoxTileList
  
commitPropertiesSelectedValues():void
CheckBoxTileList
  
convertToArray(items:Object):Array
CheckBoxTileList
  
getItemIndex(item:Object):int
Gets the position at which specified item exists in the dataprovider.
CheckBoxTileList
  
getTooltip(obj:Object):String
If tooltip function is specified, returns the result of that function.
CheckBoxTileList
  
getValue():Object
Generic function that returns the value of a IFilterControl See the docs for the selectedValues property
CheckBoxTileList
  
setSourceFromControl():void
CheckBoxTileList
  
setValue(val:Object):void
Generic function that sets the value of a IFilterControl.
CheckBoxTileList
Protected Methods
 MethodDefined By
  
drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void
[override]
CheckBoxTileList
  
drawSelectionIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
[override]
CheckBoxTileList
  
keyDownHandler(event:KeyboardEvent):void
[override]
CheckBoxTileList
  
onItemClick(event:ListEvent):void
CheckBoxTileList
Property Detail
_filterControlInterfaceproperty
protected var _filterControlInterface:FilterControlImpl

addAllItemproperty 
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
addAllItemTextproperty 
addAllItemText:String

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


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

Register with the container on creation complete


Implementation
    public function get autoRegister():Boolean
    public function set autoRegister(value:Boolean):void
bindingTriggerEventproperty 
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
dataFieldproperty 
dataField:String

For Selected Value Support


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

Width of the dropdown


Implementation
    public function get dropdownWidth():Number
    public function set dropdownWidth(value:Number):void
filterComparisionTypeproperty 
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
filterOperationproperty 
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
filterTriggerEventproperty 
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

See also

com.flexicious.controls.interfaces.IDelayedChange
gridproperty 
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
gridColumnproperty 
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
hasSearchproperty 
hasSearch:Boolean


Implementation
    public function get hasSearch():Boolean
    public function set hasSearch(value:Boolean):void
isAllSelectedproperty 
isAllSelected:Boolean  [read-only]

Returns true if the all item is selected false otherwise


Implementation
    public function get isAllSelected():Boolean
rendererStyleNameproperty 
public var rendererStyleName:String

searchFieldproperty 
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
selectedValuesproperty 
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
toolTipFunctionproperty 
public var toolTipFunction:Function

ooltip to show on each of the checkboxes.

useTriStateproperty 
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)

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

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




Copyright 2012 Flexicious LLC. All rights reserved.

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