Class FieldSelection

Object
   |
   +--FieldSelection

class FieldSelection

Defined in form.js

collapse

void collapse(<Object> elm, <Boolean> toStart)

Collapse the field's selection

Parameters:
elm - Field
toStart - Collapse to start (true) or to end (false). Defaults to true

get

String get(<Object> elm)

Return the current selected text in a given field

Parameters:
elm - Field

getCaret

Number getCaret(<Object> elm)

Return the current caret position in a given field. Note that even when the selection size of the field is greater than 1, the caret position represents the selection start position

Parameters:
elm - Field

getRange

Object getRange(<Object> elm)

Retrieves information about the selection range of a given field. The value returned is an object containing 3 properties: start, end and size

Parameters:
elm - Field

prepare

void prepare(<Object> elm)

Add event listeners in the field so that we can have up-to-dated information about its selection when applying masks. This is only needed when running MS Internet Explorer

Parameters:
elm - Field

setCaret

void setCaret(<Object> elm, <Number> pos)

Set the caret position of a field

Parameters:
elm - Field
pos - Caret position

setRange

void setRange(<Object> elm, <Number> start, <Number> end)

Change the selection range of a field

Parameters:
elm - Field
start - Selection start
end - Selection end