API Docs for:
Show:

flexiciousNmsp.TriStateCheckBox Class

Extends UIComponent

A Checkbox that implements ITriStateCheckBoxFilterControl (IFilterControl) which enables it to be used within the filtering/binding infrasturcture. In addition to the on and off states supported by the regular check box, the Tristate checkbox supports an additional middle state, which is depicted by a checkbox with a fill, an is designed to indicate that the checkbox is neither on or off, just in a undefined/null state.

Constructor

flexiciousNmsp.TriStateCheckBox

()

Properties

allowUserToSelectMiddle

Boolean

Allows user to select the middle mode.

Default: false

delayDuration

Int

The amount of time (in milliseconds) to wait before dispatching the DELAY_CHANGE event.

Default: 500

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

Unknown

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

gridColumn

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

radioButtonMode

Boolean

In single select datagrids, set this to true for the icon to appear as if it is a radio button

Default: false

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