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

public class | source

NumericRangeBox

Extends:

react~React.Component → EventDispatcher → UIComponent → NumericRangeBox

A NumericRangeBox that which can be used within the filtering/binding infrastructure. /** An HBox that contains two textboxes to specify a range. Implements IRangeFilterControl (IFilterControl)

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	dataField: * Name of the field in the items in the `dataProvider` Array to use as the value of drop-down list.
public	errorMessageDiv: * The div that holds the error message .
public	errorMessageText: string Text to be used for the error message div.
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	rangeInvalid: * Boolean used to identify if end < start
public	registered: * Whether or not this control has been registered.
public	searchField: * The field to search on, usually same as the data field.
public	separator: * The label that separates the two inputs
public	separatorText: * The text of the separator separating the two text input boxes.
public	textBoxEnd: * The text input that holds the end value.
public	textBoxEndInvalid: * Boolean used to identify the textBoxEnd presently contain invalid values
public	textBoxStart: * The text input that holds the start value.
public	textBoxStartInvalid: * Boolean used to identify the textBoxStart presently contain invalid values

Method Summary

Public Methods
public	checkDirty()
public	clear() Clears out the textboxes
public	componentDidMount()
public	focus() Sets the focus on the first checkbox
public	getClassNames(): string[]
public	getMaxValue(): * Returns the maximum value of the range
public	getMinValue(): * Returns the minimum value of the range
public	getRange(): * Returns an array of [rangeStart,rangeEnd]
public	getRangeEnd(): * The end of the range
public	getRangeStart(): * The start of the range
public	getSearchRangeEnd(): * If the range is invalid, returns the last value of the range.
public	getSearchRangeStart(): * If the range is valid, returns the first value of the range.
public	getValue(): * Generic function that returns the value of a IFilterControl
public	hideErrorTip()
public	isRangeValid(): *
public	isValidNumber(txtBox: ):
public	onChange()
public	onChange_textBoxEnd(evt: *)
public	onChange_textBoxStart(evt: *)
public	onMouseOut(event: *)
public	onMouseOver(event: *)
public	reset() Wipes out the text boxes
public	setActualSize(w: , h: )
public	setRange(value: *)
public	setRangeEnd(o: *) The start of the range
public	setRangeStart(o: *)
public	setValue(val: *) Generic function that sets the value of a IFilterControl
public	showErrorTip(txtBox: *)

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

Public Constructors

public constructor() source

Override:

UIComponent#constructor

Public Members

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 errorMessageDiv: * source

The div that holds the error message .

Properties:

Name	Type	Attribute	Description
errorMessageDiv	*

public errorMessageText: string source

Text to be used for the error message div.

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 MultiSelectNumericRangeBox, 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

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 rangeInvalid: * source

Boolean used to identify if end < start

Properties:

Name	Type	Attribute	Description
rangeInvalid	*

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 separator: * source

The label that separates the two inputs

Properties:

Name	Type	Attribute	Description
separator	*

public separatorText: * source

The text of the separator separating the two text input boxes.

Properties:

Name	Type	Attribute	Description
separatorText	*

public textBoxEnd: * source

The text input that holds the end value.

Properties:

Name	Type	Attribute	Description
textBoxEnd	*

public textBoxEndInvalid: * source

Boolean used to identify the textBoxEnd presently contain invalid values

Properties:

Name	Type	Attribute	Description
textBoxEndInvalid	*

public textBoxStart: * source

The text input that holds the start value.

Properties:

Name	Type	Attribute	Description
textBoxStart	*

public textBoxStartInvalid: * source

Boolean used to identify the textBoxStart presently contain invalid values

Properties:

Name	Type	Attribute	Description
textBoxStartInvalid	*

Public Methods

public checkDirty() source

public clear() source

Clears out the textboxes

public componentDidMount() source

Override:

UIComponent#componentDidMount

public focus() source

Sets the focus on the first checkbox

Override:

UIComponent#focus

public getClassNames(): string[] source

Override:

UIComponent#getClassNames

Return:

string[]

public getMaxValue(): * source

Returns the maximum value of the range

Return:

public getMinValue(): * source

Returns the minimum value of the range

Return:

public getRange(): * source

Returns an array of [rangeStart,rangeEnd]

Return:

public getRangeEnd(): * source

The end of the range

Return:

public getRangeStart(): * source

The start of the range

Return:

public getSearchRangeEnd(): * source

If the range is invalid, returns the last value of the range.

Return:

public getSearchRangeStart(): * source

If the range is valid, returns the first value of the range.

Return:

public getValue(): * source

Generic function that returns the value of a IFilterControl

Return:

public hideErrorTip() source

public isRangeValid(): * source

Return:

public isValidNumber(txtBox: ): source

Params:

Name	Type	Attribute	Description
txtBox	*

Return:

public onChange() source

public onChange_textBoxEnd(evt: *) source

Params:

Name	Type	Attribute	Description
evt	*

public onChange_textBoxStart(evt: *) source

Params:

Name	Type	Attribute	Description
evt	*

public onMouseOut(event: *) source

Params:

Name	Type	Attribute	Description
event	*

public onMouseOver(event: *) source

Params:

Name	Type	Attribute	Description
event	*

public reset() source

Wipes out the text boxes

public setActualSize(w: , h: ) source

Override:

UIComponent#setActualSize

Params:

Name	Type	Attribute	Description
w	*
h	*

public setRange(value: *) source

Params:

Name	Type	Attribute	Description
value	*

public setRangeEnd(o: *) source

The start of the range

Params:

Name	Type	Attribute	Description
o	*

public setRangeStart(o: *) source

Params:

Name	Type	Attribute	Description
o	*

public setValue(val: *) source

Generic function that sets the value of a IFilterControl

Params:

Name	Type	Attribute	Description
val	*

public showErrorTip(txtBox: *) source

Params:

Name	Type	Attribute	Description
txtBox	*

NumericRangeBox

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor() source

Override:

Public Members

public dataField: * source

Properties:

public errorMessageDiv: * source

Properties:

public errorMessageText: string source

public filterComparisionType: * source

Properties:

public filterOperation: * source

Properties:

public filterTriggerEvent: * source

Properties:

public grid: * source

public gridColumn: * source

public hasSearch: * source

Properties:

public rangeInvalid: * source

Properties:

public registered: * source

Properties:

public searchField: * source

Properties:

public separator: * source

Properties:

public separatorText: * source

Properties:

public textBoxEnd: * source

Properties:

public textBoxEndInvalid: * source

Properties:

public textBoxStart: * source

Properties:

public textBoxStartInvalid: * source

Properties:

Public Methods

public checkDirty() source

public clear() source

public componentDidMount() source

Override:

public focus() source

Override:

public getClassNames(): string[] source

Override:

Return:

public getMaxValue(): * source

Return:

public getMinValue(): * source

Return:

public getRange(): * source

Return:

public getRangeEnd(): * source

Return:

public getRangeStart(): * source

Return:

public getSearchRangeEnd(): * source

Return:

public getSearchRangeStart(): * source

Return:

public getValue(): * source

Return:

public hideErrorTip() source

public isRangeValid(): * source

Return:

public isValidNumber(txtBox: *): * source

Params:

Return:

public onChange() source

public onChange_textBoxEnd(evt: *) source

Params:

public onChange_textBoxStart(evt: *) source

Params:

public isValidNumber(txtBox: ): source

public setActualSize(w: , h: ) source