import ComboBox from 'flexicious-react-datagrid/js/controls/ComboBox.js'

public class | source

ComboBox

Extends:

react~React.Component → EventDispatcher → UIComponent → ComboBox

Direct Subclass:

DateComboBox

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

Static Method Summary

Static Public Methods
public static	addAllItemToDataProvider(control: *)
public static	itemToLabel(control: , data: ): string
public static	setSelectedItemFromValue(control: *)

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	addAllItemText: * Text of the "All" item.
public	allItemDisabled: boolean Flag to control whether or not the first optionis disabled (non selectable)
public	allItemDisabledField: string Field on the data provider that can be used to disable the option object associated with the data provider item.
public	children: *
public	dataField: * Name of the field in the items in the `dataProvider` Array to use as the value of drop-down list.
public	filterComparisionType: * This is usually automatically set, you don't have to manually set it, unless you're sending strings as Date objects.
public	filterOperation: * The filter operation to apply to the comparison See the FilterExpression class for a list.
public	filterTriggerEvent: * The event that the filter triggers on.
public	grid: * The grid that the filter belongs to - can be null if filter is used outside the grid
public	gridColumn: * The grid column that the filter belongs to - can be null if filter is used outside the grid
public	hasSearch: * Whether or not there is an active search
public	ignoreAllItem: boolean used to prevent add all item in the combo
public	labelField: * Name of the field in the items in the `dataProvider` Array to display as the label in the TextInput portion and drop-down list.
public	labelFunction: * User-supplied function to run on each item to determine its label.
public	registered: * Whether or not this control has been registered.
public	searchField: * The field to search on, usually same as the data field.
public	selectedIndex: *

Method Summary

Public Methods
public	changeEventHandler(e: *)
public	clear()
public	commitDataProvider()
public	commitPropertiesAddAllItem()
public	commitPropertiesSelectedValue()
public	componentDidMountCustom()
public	focus() Sets the focus on the textbox
public	getAddAllItem(): * 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
public	getClassNames(): string[]
public	getDataProvider(): Array
public	getSelectedIndex(): *
public	getSelectedItem(): *
public	getSelectedValue(): * Gets the selected value on our comboboxes.
public	getValue(): * Generic function that returns the value of a IFilterControl
public	itemToLabel(data: ): Returns the String that the item renderer displays for the given data object.
public	keyUpHandler(e: *)
public	onChange(e: *)
public	register(container: *)
public	render(): *
public	setAddAllItem(value: *)
public	setDataProvider(value: *)
public	setSelectedIndex(value: *)
public	setSelectedItem(value: *)
public	setSelectedValue(val: *)
public	setValue(val: *) Generic function that sets the value of a IFilterControl
public	updateDisplayList(unscaledWidth: , unscaledHeight: )

Inherited Summary

From class EventDispatcher
public	[prop]: *
public	dead: boolean
public	eventListeners: Array A list of event listeners for this event dispatcher object.
public	typeCache: {}
public	addEventListener(context: , type: , listener: *) Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
public	constructed()
public	dispatchEvent(event: *): boolean Dispatches an event into the event flow.
public	getClassNames(): string[]
public	getStyle(prop: ): Gets the value of the prop property on this object
public	hasEventListener(type: *): Boolean Returns true if an event listener exists
public	implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class.
public	kill() Removes all event listeners
public	killArray(arr: *) Given an array of event dispatchers, calls the kill method on each of them.
public	removeEventListener(type: , listener: ) Removes a listener from the EventDispatcher object.
public	setStyle(prop: , val: ) Sets the value of the prop property on this object

From class UIComponent
public static	clearPendingUpdates()
public static	flushPendingUpdates()
public	childIndex: number
public	children: *[]
public	childrenWithProps: *[]
public	data: * This is a getter/setter for the data property.
public	domElement: HTMLElement The dom element associated with this UIComponent.
public	domListeners: Array A list of event listeners that are added to the domElement (these create html dom event listeners as opposed to js only event listeners)
public	enabled: boolean Whether or not this control is enabled.
public	errorString: *
public	handCursor: *
public	height: number
public	horizontalScrollPolicy: *
public	includeInLayout: boolean
public	initialized: boolean
public	innerHTML: string
public	invalid: Boolean A flag to store if this object has been marked for invalidation.
public	oldDisplay: *
public	parent: *
public	propertyBag: {}
public	props: *
public	reactElement: ReactElement The react element associated with this UIComponent.
public	state: *
public	tagName: *
public	toolTip: *
public	verticalScrollPolicy: *
public	visible: boolean Whether or not this control is enabled.
public	width: number
public	x: *
public	y: *
public	addChild(child: *) This methods takes another UIComponent object, and adds it to the dom as a child of the domElement of this UIComponent.
public	addChildAt(child: , idx: ) This methods takes another UIComponent object, and adds it to the dom as a child of the domElement of this UIComponent.
public	addDomEventListener(evt: , f: ) When you call addEventListener on a UIComponent, certain events, defined by the domEvents array are also associated with the corresponding domElement.
public	addEventListener(context: , type: , listener: *) Calls super.addEventListener, and for dom based events, also adds a HTML Event listener
public	attachClass(newClass: *)
public	componentDidMount()
public	componentWillMount()
public	componentWillReceiveProps(nextProps: *)
public	componentWillUnmount()
public	componentWillUpdate()
public	detachClass(newClass: *)
public	domEventFired(event: *) The event handler that gets triggered from the HTML DOM.
public	focus()
public	getAllChildren(): *
public	getAttribute(attr: ):
public	getAutomationName(): *
public	getChildAt(idx: ): Returns the child of the domElement at the specified index.
public	getClassNames(): string[]
public	getComponentStyleAttribute(attr: ):
public	getData(): * This is a getter/setter for the data property.
public	getElementByTagName(tag: ):
public	getEnabled(): * Sets the enabled flag
public	getErrorString(val: ):
public	getHandCursor(): *
public	getHandCursor(): *
public	getHeight(): *
public	getHorizontalScrollPolicy(): *
public	getHorizontalScrollPosition(): *
public	getIncludeInLayout(val: ):
public	getInnerHTML(): * Getter for the innerHTML property
public	getPixelHeight(): *
public	getStyleAttribute(attr: ):
public	getText(): * Getter for the text property
public	getVerticalScrollPolicy(): *
public	getVerticalScrollPosition(): *
public	getVisible(val: ): Sets the visible flag
public	getWidth(): *
public	getX(): * Gets the X co ordinate
public	getY(): * Gets the Y co ordinate
public	globalToLocal(ptIn: *): flexiciousNmsp.Point Converts the given global Point to local co-ordinates.
public	initFromProps(props: *)
public	initialize() Any initialization code is supposed to go in this method.
public	invalidateDisplayList() This method will queue the component so the display list will render it once the current frame of execution is over.
public	kill() First, calls super.kill(), which takes out all event listeners.
public	localToGlobal(ptIn: *): flexiciousNmsp.Point Converts the given local Point to global co-ordinates.
public	measureText(textToMeasure: ): {"width": } Returns the width of the given text.
public	mergeObjects(obj1: , obj2: ): *
public	move(x: , y: ) Sets the X and Y co ordinates of the current dom element
public	numChildren(): * Gets the number of children of the dom element associated with this UIComponent.
public	owns(elem: *): Boolean Recursively iterates through the parent hierarchy of the given element to check to see if the current node is in its parent hierarchy.
public	ownsPoint(pt: *): boolean
public	removeAllChildren(child: *)
public	removeChild(child: *) This methods takes another UIComponent object, and removes it from the dom.
public	removeChildAt(idx: *) This methods takes another UIComponent object, and removes it from the dom.
public	removeComponentAttribute(attr: *)
public	removeDomEventListener(evt: , f: ) Removes a previously attached DOM event listener.
public	removeEventListener(type: , listener: ) Calls super.addEventListener, and for dom based events, also removes the previously added HTML Event listener
public	removeEventListenerKeepDomListener(type: , listener: ) Calls super.addEventListener, and for dom based events, also removes the previously added HTML Event listener
public	render(): *
public	setActualSize(w: , h: )
public	setActualSizeFromDomElement()
public	setAttribute(attr: , val: )
public	setAutomationName(val: *)
public	setChildIndex(child: , index: ) Sets the visible flag
public	setComponentStyleAttribute(attr: , val: )
public	setData(val: *) This is important, because the grid looks for a "setData" method on the renderer.
public	setDomElement(elem: *) Sets the domElement of this UIComponent to the specified element, and creates a property on the dom element called component to this.
public	setEnabled(val: *) Sets the enabled flag
public	setErrorString(val: *)
public	setHandCursor(val: *)
public	setHeight(val: ):
public	setHorizontalScrollPolicy(policy: *)
public	setHorizontalScrollPosition(val: ):
public	setIncludeInLayout(val: *)
public	setInnerHTML(val: *) Setter for the innerHTML property
public	setState(newState: *)
public	setStateIfDomPresent(state: , db: )
public	setStateInternal(newState: *)
public	setStyleAttribute(attr: , val: )
public	setText(val: *) Setter for the text property
public	setToolTip(val: *)
public	setVerticalScrollPolicy(policy: *)
public	setVerticalScrollPosition(val: ):
public	setVisible(val: *) Sets the visible flag
public	setWidth(val: ):
public	setX(val: ): Sets the X co ordinate
public	setY(val: ): Sets the Y co ordinate
public	updateDisplayList(w: , h: ) Called as a part of render phase.
public	validateNow()
public	validateNowIfValid()

Static Public Methods

public static addAllItemToDataProvider(control: *) source

Params:

Name	Type	Attribute	Description
control	*

public static itemToLabel(control: , data: ): string source

Params:

Name	Type	Attribute	Description
control	*
data	*

Return:

string

public static setSelectedItemFromValue(control: *) source

Params:

Name	Type	Attribute	Description
control	*

Public Constructors

public constructor() source

Override:

UIComponent#constructor

Public Members

public addAllItemText: * source

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

Properties:

Name	Type	Attribute	Description
addAllItemText	*

public allItemDisabled: boolean source

Flag to control whether or not the first optionis disabled (non selectable)

Properties:

Name	Type	Attribute	Description
allItemDisabled	*

public allItemDisabledField: string source

Field on the data provider that can be used to disable the option object associated with the data provider item.

Properties:

Name	Type	Attribute	Description
allItemDisabledField	*

public children: * source

Override:

UIComponent#children

public dataField: * source

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.

Properties:

Name	Type	Attribute	Description
dataField	*

public filterComparisionType: * source

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

Properties:

Name	Type	Attribute	Description
filterComparisionType	*

public filterOperation: * source

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"

Properties:

Name	Type	Attribute	Description
filterOperation	*

public filterTriggerEvent: * source

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

Properties:

Name	Type	Attribute	Description
filterTriggerEvent	*

public grid: * source

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

Properties:

Name	Type	Attribute	Description
grid	*

public gridColumn: * source

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

public hasSearch: * source

Whether or not there is an active search

Properties:

Name	Type	Attribute	Description
hasSearch	*

public ignoreAllItem: boolean source

used to prevent add all item in the combo

public labelField: * source

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.

Properties:

Name	Type	Attribute	Description
labelField	*

public labelFunction: * source

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

Properties:

Name	Type	Attribute	Description
labelFunction	*

public registered: * source

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

Properties:

Name	Type	Attribute	Description
registered	*

public searchField: * source

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

Properties:

Name	Type	Attribute	Description
searchField	*

public selectedIndex: * source

Public Methods

public changeEventHandler(e: *) source

Params:

Name	Type	Attribute	Description
e	*

public clear() source

public commitDataProvider() source

public commitPropertiesAddAllItem() source

public commitPropertiesSelectedValue() source

public componentDidMountCustom() source

public focus() source

Sets the focus on the textbox

Override:

UIComponent#focus

public getAddAllItem(): * source

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

Return:

public getClassNames(): string[] source

Override:

UIComponent#getClassNames

Return:

string[]

public getDataProvider(): Array source

Return:

Array

public getSelectedIndex(): * source

Return:

public getSelectedItem(): * source

Return:

public getSelectedValue(): * source

Gets the selected value on our comboboxes. Just like the selected label, but applies to the data property.

Needs the datafield property to be set.

Return:

public getValue(): * source

Generic function that returns the value of a IFilterControl

Return:

public itemToLabel(data: ): source

Returns the String that the item renderer displays for the given data object.

Params:

Name	Type	Attribute	Description
data	*

Return:

public keyUpHandler(e: *) source

Params:

Name	Type	Attribute	Description
e	*

public onChange(e: *) source

Params:

Name	Type	Attribute	Description
e	*

public register(container: *) source

Params:

Name	Type	Attribute	Description
container	*

public render(): * source

Override:

UIComponent#render

Return:

public setAddAllItem(value: *) source

Params:

Name	Type	Attribute	Description
value	*

public setDataProvider(value: *) source

Params:

Name	Type	Attribute	Description
value	*

public setSelectedIndex(value: *) source

Params:

Name	Type	Attribute	Description
value	*

public setSelectedItem(value: *) source

Params:

Name	Type	Attribute	Description
value	*

public setSelectedValue(val: *) source

Params:

Name	Type	Attribute	Description
val	*

public setValue(val: *) source

Generic function that sets the value of a IFilterControl

Params:

Name	Type	Attribute	Description
val	*

public updateDisplayList(unscaledWidth: , unscaledHeight: ) source

Called as a part of render phase.

Override:

UIComponent#updateDisplayList

Params:

Name	Type	Attribute	Description
unscaledWidth	*
unscaledHeight	*

ComboBox

Extends:

Direct Subclass:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static addAllItemToDataProvider(control: *) source

Params:

public static itemToLabel(control: *, data: *): string source

Params:

Return:

public static setSelectedItemFromValue(control: *) source

Params:

Public Constructors

public constructor() source

Override:

Public Members

public addAllItemText: * source

Properties:

public allItemDisabled: boolean source

Properties:

public allItemDisabledField: string source

Properties:

public children: * source

Override:

public dataField: * source

Properties:

public filterComparisionType: * source

Properties:

public filterOperation: * source

Properties:

public filterTriggerEvent: * source

Properties:

public grid: * source

Properties:

public gridColumn: * source

public hasSearch: * source

Properties:

public ignoreAllItem: boolean source

public labelField: * source

Properties:

public labelFunction: * source

Properties:

public registered: * source

Properties:

public searchField: * source

Properties:

public selectedIndex: * source

Public Methods

public changeEventHandler(e: *) source

Params:

public clear() source

public commitDataProvider() source

public commitPropertiesAddAllItem() source

public commitPropertiesSelectedValue() source

public componentDidMountCustom() source

public focus() source

Override:

public getAddAllItem(): * source

Return:

public getClassNames(): string[] source

Override:

Return:

public getDataProvider(): Array source

Return:

public getSelectedIndex(): * source

Return:

public getSelectedItem(): * source

Return:

public getSelectedValue(): * source

Return:

public getValue(): * source

Return:

public itemToLabel(data: *): * source

Params:

Return:

public keyUpHandler(e: *) source

public static itemToLabel(control: , data: ): string source

public itemToLabel(data: ): source

public updateDisplayList(unscaledWidth: , unscaledHeight: ) source