flexiciousNmsp.TextInput Class
A TextInput that implements ITextFilterControl (IFilterControl) and ITextDataBoundControl (IDataBoundControl) which enables it to be used within the filtering/binding infrasturcture. It also adds support for a number of features like autocomplete, inside and outside icons, etc.
Constructor
flexiciousNmsp.TextInput
()
Item Index
Properties
- autoCompleteOptions
- autoCompleteSource
- autoCompleteStyleName
- clearTextOnIconClick
- delayDuration
- enableAutoComplete
- enableDelayChange
- filterComparisionType
- filterOperation
- filterTriggerEvent
- grid
- grid
- hasSearch
- iconGap
- iconHeight
- iconWidth
- idValue
- inputMask
- inputMaskOptions
- insideIcon
- insideIconPosition
- onInsideIconClick
- onOutsideIconClick
- outsideIcon
- outsideIconPosition
- registered
- searchField
- showIconWhenHasText
- watermark
- watermarkOptions
- watermarkStyle
Properties
autoCompleteOptions
Object
Plugin specific options for the autocomplete. Depending on the flavor of Flexicious you go with, flexicious will use either the JQuery, Dojo or EXT versions of the autocomplete. This object will be used to pass in additional parameters for autocomplete.
Default: null
autoCompleteSource
Object
The source for the autocomplete dropdown (the list of items).
Default: null
autoCompleteStyleName
String
Style name for the auto complete dropdown [Style(name="autoCompleteStyleName", type="String")]
Default: null
clearTextOnIconClick
Boolean
If you specify an Icon Style, setting this variable to true will clear the text on icon click. Used for a "clear" icon.
Default: false
delayDuration
Int
The amount of time (in milliseconds) to wait before dispatching the DELAY_CHANGE event.
Default: 500
enableAutoComplete
Boolean
Enables auto complete behavior. Please ensure you set the autocompletesource property.
Default: false
enableDelayChange
Int
Whether or not to enable the DELAY_CHANGE event.
Default: 500
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
FlexDataGrid
The grid that the filter belongs to - can be null if filter is used outside the grid
Default: null
grid
Unknown
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
iconGap
Integer
The spacing between insideIcon, outsideIcon, and the text input [Style(name="iconGap", type="Number", inherit="no")]
Default: 2
iconHeight
Integer
Width of the inside and outside icons
Default: 12
iconWidth
Integer
Width of the inside and outside icons
Default: 12
idValue
Object
To enable use of the text input in picker type scenarios where we display a label string in the text input, but expose a store for the ID value.
Default: null
inputMask
Text
Input mask for the text input
Default: null
inputMaskOptions
Object
Plugin specific options for the input mask. Depending on the flavor of Flexicious you go with, flexicious will use either the JQuery, Dojo or EXT versions of the input mask. This object will be used to pass in additional parameters for input mask.
Default: null
insideIcon
String
The icon that is displayed inside the textbox, based on the insideIconPosition property. [Style(name="insideIcon", type="Class", inherit="no")]
Default: null
insideIconPosition
String
The position of the icon that is displayed inside the textbox. Default 'right'
Default: right
onInsideIconClick
Function
Dispatched when the user clicks on a the icon specified by the insideIcon property
Default: null
onOutsideIconClick
Function
Dispatched when the user clicks on a the icon specified by the outsideIcon property
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: null
outsideIconPosition
String
The position of the icon that is displayed outside the textbox. Default 'right' [Style(name="outsideIconPosition", type="String", enumeration="left,right")]
Default: right
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
showIconWhenHasText
Boolean
Flag to control whether the icon only shows up when there is text in the box
Default: 500
watermark
String
The watermark to show when there is no text entered into the text input. Depending on the flavor of Flexicious you go with, flexicious will use either the JQuery, Dojo or EXT versions of the watermark.
Default: ""
watermarkOptions
Object
Plugin specific options for the watermark. Depending on the flavor of Flexicious you go with, flexicious will use either the JQuery, Dojo or EXT versions of the water mark. This object will be used to pass in additional parameters for water mark.
Default: null
watermarkStyle
String
Style to apply to the watermark label
Default: watermarkStyle