com.flexicious.controls.MultiSelectComboBox

	Property	Defined By
		addAllItem : Boolean Flag to indicate whether to include the "All" item in this list of items	MultiSelectComboBox
		addAllItemText : String Text of the "All" item.	MultiSelectComboBox
		addOkCancel : Boolean = true Flag to control the additon of Ok and Cancel link buttons.	MultiSelectComboBox
		addSearchBox : Boolean = false Flag to add a SearchBox to filter the MSCB items.	MultiSelectComboBox
		alignRightEdgeOfPopup : Boolean = false If set to true, the popups right edge will be aligned with the buttons right edge	MultiSelectComboBox
		autoRegister : Boolean Register with the container on creation complete	MultiSelectComboBox
		bindingTriggerEvent : String The event to trigger the binding on.	MultiSelectComboBox
		borderAdjust : Boolean Workaround for the right border issue with MSCB	MultiSelectComboBox
		buttonBox : HBox	MultiSelectComboBox
		buttonCancel : LinkButton The Cancel Button .	MultiSelectComboBox
		buttonCancelLabel : String = Cancel The text of the Cancel button.	MultiSelectComboBox
		buttonOk : LinkButton The OK Button.	MultiSelectComboBox
		buttonOkLabel : String = Ok The text of the OK button.	MultiSelectComboBox
		dataField : String The property on the type of the object in the dataprovider that should be included the list of selectedValues.	MultiSelectComboBox
		dataProvider : Object The data provider for the underlying list.	MultiSelectComboBox
		dropdownWidth : Number Width of the dropdown.	MultiSelectComboBox
		filterComparisionType : String This is usually automatically set, you don't have to manually set it, unless you're sending strings as Date objects.	MultiSelectComboBox
		filterOperation : String The filter operation to apply to the comparison See the FilterExpression class for a list.	MultiSelectComboBox
		filterTriggerEvent : String The event that the filter triggers on.	MultiSelectComboBox
		grid : IExtendedDataGrid The grid that the filter belongs to - can be null if filter is used outside the grid	MultiSelectComboBox
		gridColumn : IDataGridFilterColumn The grid column that the filter belongs to - can be null if filter is used outside the grid	MultiSelectComboBox
		isAllSelected : Boolean [read-only] Returns true if cbList.isAllSelected	MultiSelectComboBox
		labelField : String The property on the type of the object in the dataprovider that should be the label for the checkboxes in the list.	MultiSelectComboBox
		labelFunction : Function A function to run on each item to determine its label.	MultiSelectComboBox
		labelMaxLength : Number = -1 Maximum number of characters to display in the label.	MultiSelectComboBox
		rendererStyleName : String	MultiSelectComboBox
		rowCount : Number Number of rows to be displayed.	MultiSelectComboBox
		searchBox : TextInput	MultiSelectComboBox
		searchBoxWatermark : String = Search Watermark for the search box.	MultiSelectComboBox
		searchField : String The field to search on, usually same as the data field.	MultiSelectComboBox
		selectedItems : Array List of items that are selected	MultiSelectComboBox
		selectedValues : ArrayCollection A list of the 'dataField' property values for each of the items in the selectedItems list.	MultiSelectComboBox
		useModuleFactory : Boolean [read-only] Flag that indicates to use the module factory of the grid to show popups.	MultiSelectComboBox
		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.	MultiSelectComboBox

	Property	Defined By
		cbList : CheckBoxList An extended List that checkbox.	MultiSelectComboBox
		_filterControlInterface : FilterControlImpl	MultiSelectComboBox
		hbox : HBox The box that holds the ok and cancel buttons	MultiSelectComboBox
		_previousSelectedItems : Array	MultiSelectComboBox

	Method	Defined By
		MultiSelectComboBox()	MultiSelectComboBox
		clear():void Calls clear on the underlying checkboxlist.	MultiSelectComboBox
		close():void [override]	MultiSelectComboBox
		getValue():Object Generic function that returns the value of a IFilterControl.	MultiSelectComboBox
		itemToLabel(data:Object):String	MultiSelectComboBox
		setSourceFromControl():void	MultiSelectComboBox
		setValue(val:Object):void Generic function that sets the value of a IFilterControl	MultiSelectComboBox

	Method	Defined By
		commitProperties():void [override]	MultiSelectComboBox
		createChildren():void [override]	MultiSelectComboBox
		createOkCancel():void	MultiSelectComboBox
		createSearchBox():void	MultiSelectComboBox
		filterByText(item:Object):Boolean	MultiSelectComboBox
		onCancelButtonClick(event:MouseEvent, doclose:Boolean = true):void	MultiSelectComboBox
		onSearchBoxChange(event:Event):void	MultiSelectComboBox
		setLabel():void Sets the text field label.	MultiSelectComboBox
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override]	MultiSelectComboBox

	Event	Summary	Defined By
		clear	Dispatched when the clear method is called	MultiSelectComboBox

Description	Defined By
buttonBoxStyleName	Type: string The style to apply to the Ok/Cancel button box	MultiSelectComboBox
buttonStyleName	Type: string The style to apply to the Ok/Cancel buttons	MultiSelectComboBox
filterIcon	Type: Class Format: EmbeddedFile CSS Inheritance: no When filterControl=textInput, the icon that is displayed inside the textbox, based on the insideIconPosition property.	MultiSelectComboBox
searchBoxStyleName	Type: string The style to apply to the Search box	MultiSelectComboBox
useModuleFactory	Type: Boolean A flag that asks the mscb to use its module factory when instantiating the popup. This is required when you are using the mscb inside a module.	MultiSelectComboBox

Property Detail

_filterControlInterface

property

protected var _filterControlInterface:FilterControlImpl

_previousSelectedItems

property

_previousSelectedItems:Array

This property can be used as the source for data binding.

Implementation
protected function get _previousSelectedItems():Array
protected function set _previousSelectedItems(value:Array):void

addAllItem

property

addAllItem:Boolean

Flag to indicate whether to include the "All" item in this list of items

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

addOkCancel

property

public var addOkCancel:Boolean = true

Flag to control the additon of Ok and Cancel link buttons.

addSearchBox

property

public var addSearchBox:Boolean = false

Flag to add a SearchBox to filter the MSCB items.

alignRightEdgeOfPopup

property

public var alignRightEdgeOfPopup:Boolean = false

If set to true, the popups right edge will be aligned with the buttons right edge

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

borderAdjust:Boolean

Workaround for the right border issue with MSCB

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

buttonBox

property

public var buttonBox:HBox

buttonCancel

property

public var buttonCancel:LinkButton

The Cancel Button . Is only available after createChildren is called.

buttonCancelLabel

property

public var buttonCancelLabel:String = Cancel

The text of the Cancel button. Defaults to "Cancel"

buttonOk

property

public var buttonOk:LinkButton

The OK Button. Is only available after createChildren is called.

buttonOkLabel

property

public var buttonOkLabel:String = Ok

The text of the OK button. Defaults to "Ok"

cbList

property

cbList:CheckBoxList

An extended List that checkbox.

This property can be used as the source for data binding.

Implementation
protected function get cbList():CheckBoxList
protected function set cbList(value:CheckBoxList):void

dataField

property

dataField:String

The property on the type of the object in the dataprovider that should be included the list of selectedValues.

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

dataProvider

property

dataProvider:Object

The data provider for the underlying list.

Implementation
public function get dataProvider():Object
public function set dataProvider(value:Object):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

hbox

property

hbox:HBox

The box that holds the ok and cancel buttons

This property can be used as the source for data binding.

Implementation
protected function get hbox():HBox
protected function set hbox(value:HBox):void

isAllSelected

property

isAllSelected:Boolean [read-only]

Returns true if cbList.isAllSelected

Implementation
public function get isAllSelected():Boolean

labelField

property

labelField:String

The property on the type of the object in the dataprovider that should be the label for the checkboxes in the list.

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

labelFunction

property

labelFunction:Function

A function to run on each item to determine its label.

Implementation
public function get labelFunction():Function
public function set labelFunction(value:Function):void

labelMaxLength

property

public var labelMaxLength:Number = -1

Maximum number of characters to display in the label. -1 means display everything.

rendererStyleName

property

public var rendererStyleName:String

rowCount

property

rowCount:Number

Number of rows to be displayed. If the height of the component has been explicitly set, this property might not have any effect.

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

searchBox

property

public var searchBox:TextInput

searchBoxWatermark

property

public var searchBoxWatermark:String = Search

Watermark for the search box.

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

selectedItems

property

selectedItems:Array

List of items that are selected

Implementation
public function get selectedItems():Array
public function set selectedItems(value:Array):void

selectedValues

property

selectedValues:ArrayCollection

A list of the 'dataField' property values for each of the items in the selectedItems list.

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

useModuleFactory

property

useModuleFactory:Boolean [read-only]

Flag that indicates to use the module factory of the grid to show popups. Use this when you are using modules and your parent application is not under your control. Please note, you will still need to ensure that the parent application imports PopupManager. http://bugs.adobe.com/jira/browse/SDK-873

Implementation
public function get useModuleFactory():Boolean

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

Constructor Detail

MultiSelectComboBox

()

Constructor

public function MultiSelectComboBox()

Method Detail

clear

()

method

public function clear():void

Calls clear on the underlying checkboxlist. If All Item is added, it is selected.

()

method

override public function close():void

commitProperties

()

method

override protected function commitProperties():void

createChildren

()

method

override protected function createChildren():void

createOkCancel

()

method

protected function createOkCancel():void

createSearchBox

()

method

protected function createSearchBox():void

filterByText

()

method

protected function filterByText(item:Object):Boolean

Parameters

item:Object

Returns

Boolean

getValue

()

method

public function getValue():Object

Generic function that returns the value of a IFilterControl.

Returns

Object

itemToLabel

()

method

public function itemToLabel(data:Object):String

Parameters

data:Object

Returns

String

onCancelButtonClick

()

method

protected function onCancelButtonClick(event:MouseEvent, doclose:Boolean = true):void

Parameters

	`event:MouseEvent`

	`doclose:Boolean` (default = `true`)

onSearchBoxChange

()

method

protected function onSearchBoxChange(event:Event):void

Parameters

event:Event

setLabel

()

method

protected function setLabel():void

Sets the text field label.

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`

Event Detail

clear

Event

Dispatched when the clear method is called

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

Flexicious Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
MultiSelectComboBox	Properties \| Methods \| Events \| Styles

Package	com.flexicious.controls
Class	public class MultiSelectComboBox
Inheritance	MultiSelectComboBox mx.controls.PopUpButton
Implements	IMultiSelectDataBoundControl, IMultiSelectFilterControl
Subclasses	MultiSelectComboBoxEx