API Docs for:
Show:

flexiciousNmsp.MultiSelectComboBox Class

Extends UIComponent

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

Constructor

flexiciousNmsp.MultiSelectComboBox

()

Properties

addAllItemText

String

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

Default: flxConstants.DEFAULT_ALL_ITEM_TEXT

alwaysVisible

Boolean

IF set to true, popup will always be visible, and text box wont.

Default: false

dataField

String

Name of the field in the items in the dataProvider Array to use as the value of drop-down list. By default, the control uses a property named data on each Array object and displays it.

However, if the dataProvider items do not contain a data property, you can set the dataField property to use a different property.

. This is also used as the search field.

Default: data

dropdownWidth

Number

Width of the dropdown. If -1, the popup will take the width of the control.

Default: -1

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

Default: auto

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. Valid values are : "Equals,NotEquals,BeginsWith,EndsWith,Contains,DoesNotContain,GreaterThan,LessThan,GreaterThanEquals,LessThanEquals,InList,NotInList,Between"

Default: Equals

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.

Default: change

grid

TreeGrid

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

grid

TreeGridColumn

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

hasSearch

Boolean

Whether or not there is an active search

Default: false

highlightedRowIndex

Number

The row currently highlighted on basis of either the keyboard or mouse inputs.

Default: -1

iconHeight

Integer

Width of the inside and outside icons

Default: 19

iconWidth

Integer

Width of the inside and outside icons

Default: 16

labelField

String

Name of the field in the items in the dataProvider Array to display as the label in the TextInput portion and drop-down list. By default, the control uses a property named label on each Array object and displays it.

However, if the dataProvider items do not contain a label property, you can set the labelField property to use a different property.

Default: label

labelFunction

Function

User-supplied function to run on each item to determine its label. By default the control uses a property named label on each dataProvider item to determine its label. However, some data sets do not have a label property, or do not have another property that can be used for displaying as a label.

An example is a data set that has lastName and firstName fields but you want to display full names. You use labelFunction to specify a callback function that uses the appropriate fields and return a displayable String.

The labelFunction takes a single argument which is the item in the dataProvider and returns a String:

 myLabelFunction(item:Object):String
 

Default: null

outsideIcon

String

The icon that is displayed outside the textbox, based on the outsideIconPosition property. [Style(name="outsideIcon", type="Class" , inherit="no")]

Default: flxConstants.IMAGE_PATH+'/downArrowIcon.png'

popup

UIComponent

The Div that contains all the checkboxes.

Default: null

registered

Boolean

Whether or not this control has been registered. This should not be set by your code.

Default: false

searchField

String

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

Default: null

selectedValues

Array

A List of strings that map to the dataField value of this control, representing the selected items within this control