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

public class | source

DateComboBox

Extends:

react~React.Component → EventDispatcher → UIComponent → ComboBox → DateComboBox

A DateComboBox that which can be used within the filtering/binding infrastructure.

Constructor Summary

Public Constructor
public	constructor(props: *)

Member Summary

Public Members
public	addAllItem: boolean
public	customDateRange: *
public	dateFormatString: * Date format for the custom date range popup
public	dateRange: * The selected date range
public	defaultDateRangeForDatePicker: * One of the DateRange constants, defines the default date range for the when the user clicks on the custom date range.
public	filterComparisionType: *
public	popup: *
public	showTimePicker: boolean Boolean flag to control the visibility of the time picker component when the user chooses to pick a custom date.

Method Summary

Public Methods
public	dispatchEvent(evt: ):
public	getClassNames(): string[]
public	getDateRange(): *
public	getDateRangeOptions(): * An array of DateRange.DATERANGE* constants.
public	getMaxValue(): * Maximum value for the date picker
public	getMinValue(): * Minimum value for the date picker
public	getSearchRangeEnd(): * The calculated date range end
public	getSearchRangeStart(): * The calculated date range start
public	getValue(): * Generic function that returns the value of a IFilterControl
public	onClick(e: *)
public	onDatePicker(picker: *): boolean
public	onDatePickerCancel(evt: *)
public	setDateRange(value: *)
public	setDateRangeOptions(val: ) An array of DateRange.DATERANGE constants.
public	setValue(val: *) Generic function that sets the value of a IFilterControl

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

From class ComboBox
public static	addAllItemToDataProvider(control: *)
public static	itemToLabel(control: , data: ): string
public static	setSelectedItemFromValue(control: *)
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: *
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: )

Public Constructors

public constructor(props: *) source

Override:

ComboBox#constructor

Params:

Name	Type	Attribute	Description
props	*

Public Members

public addAllItem: boolean source

public customDateRange: * source

public dateFormatString: * source

Date format for the custom date range popup

public dateRange: * source

The selected date range

public defaultDateRangeForDatePicker: * source

One of the DateRange constants, defines the default date range for the when the user clicks on the custom date range. Defaults to last DATE_RANGE_LAST_7_DAYS

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

Override:

ComboBox#filterComparisionType

public showTimePicker: boolean source

Boolean flag to control the visibility of the time picker component when the user chooses to pick a custom date.

Public Methods

public dispatchEvent(evt: ): source

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which the dispatchEvent() method is called.

Override:

EventDispatcher#dispatchEvent

Params:

Name	Type	Attribute	Description
evt	*

Return:

public getClassNames(): string[] source

Override:

ComboBox#getClassNames

Return:

string[]

public getDateRange(): * source

Return:

public getDateRangeOptions(): * source

An array of DateRange.DATERANGE* constants.

Return:

public getMaxValue(): * source

Maximum value for the date picker

Return:

public getMinValue(): * source

Minimum value for the date picker

Return:

public getSearchRangeEnd(): * source

The calculated date range end

Return:

public getSearchRangeStart(): * source

The calculated date range start

Return:

public getValue(): * source

Generic function that returns the value of a IFilterControl

Override:

ComboBox#getValue

Return:

public onClick(e: *) source

Params:

Name	Type	Attribute	Description
e	*

public onDatePicker(picker: *): boolean source

Params:

Name	Type	Attribute	Description
picker	*

Return:

boolean

public onDatePickerCancel(evt: *) source

Params:

Name	Type	Attribute	Description
evt	*

public setDateRange(value: *) source

Params:

Name	Type	Attribute	Description
value	*

public setDateRangeOptions(val: *) source

An array of DateRange.DATERANGE* constants.

Params:

Name	Type	Attribute	Description
val	*

public setValue(val: *) source

Generic function that sets the value of a IFilterControl

Override:

ComboBox#setValue

Params:

Name	Type	Attribute	Description
val	*

DateComboBox

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(props: *) source

Override:

Params:

Public Members

public addAllItem: boolean source

public customDateRange: * source

public dateFormatString: * source

public dateRange: * source

public defaultDateRangeForDatePicker: * source

public filterComparisionType: * source

Override:

public popup: * source

public showTimePicker: boolean source

Public Methods

public dispatchEvent(evt: *): * source

Override:

Params:

Return:

public getClassNames(): string[] source

Override:

Return:

public getDateRange(): * source

Return:

public getDateRangeOptions(): * source

Return:

public getMaxValue(): * source

Return:

public getMinValue(): * source

Return:

public getSearchRangeEnd(): * source

Return:

public getSearchRangeStart(): * source

Return:

public getValue(): * source

Override:

Return:

public onClick(e: *) source

Params:

public onDatePicker(picker: *): boolean source

Params:

Return:

public onDatePickerCancel(evt: *) source

Params:

public setDateRange(value: *) source

Params:

public setDateRangeOptions(val: *) source

Params:

public setValue(val: *) source

Override:

Params:

public dispatchEvent(evt: ): source