behavior: edit

Standard single line input element behavior. This behavior can be applied to any element that has flow:text and white-space:pre model.

Elements

that have this behavior applied by default:

<input type="text" /> - inline single line

Attributes

that this behavior knows about:

value="text" - initial value of the input element
size=integer - determines value of (intrinsic and default) width of the element.
maxlength=integer - maximum number of characters that this element can contain.
filter="filter-expr" - limits set of characters allowed to input in the field. filter-expr string accepts single characters and character ranges. Example: ".@0~9a~zA~Z" - all alpha-numeric characters, '.' and '@'. If you just want to exclude some characters then you can prepend filter with '^' sign. So this filter="^.,-" filter will allow to input any character except '.', ',' and '-'.
novalue="text" - if textbox is empty then it shows text provided by the novalue attribute. You can style this state by using :empty CSS selector.
readonly - declares that element is read only.
spellcheck="yes" - enables spell checking in the element.

Events

Together with the standard set of events (mouse, keyboard, focus) behavior: button generates:

EDIT_VALUE_CHANGED event - value of the element was changed due to user actions. Posted (asynchronous) event.
EDIT_VALUE_CHANGING event - is sent before making any change of value of the element. By handling this event you can filter characters before they get inserted into the editor. Synchronous event where:

event.reason is one of

const BY_INS_CHAR = 3; // changing by typing single character.
const BY_INS_CHARS = 4; // pasting from clipboard
const BY_DEL_CHAR = 5; // by DELETE/BACKSPACE click
const BY_DEL_CHARS = 6; // by selection removal

event.data - string, read/write. Contains character(s) to be inserted if reason is one of BY_INS_*** values;

Value

string, reflects current status of internal editing buffer.

Special key combinations

LEFT, CTRL+LEFT, SHIFT+LEFT, CTRL+SHIFT+LEFT
RIGHT, CTRL+RIGHT, SHIFT+RIGHT, CTRL+SHIFT+RIGHT
HOME, SHIFT+HOME
END, SHIFT+END
BACKSPACE, ALT+BACKSPACE, CTRL+BACKSPACE
CTRL+A
DELETE, SHIFT+DELETE, CTRL+DELETE
INSERT, SHIFT+INSERT, CTRL+INSERT
CTRL+X
CTRL+V
CTRL+Z
CTRL+(LEFT)SHIFT and CTRL+(RIGHT)SHIFT - in forms having the dir attribute these key combinations switches between dir="ltr" and dir="rtl".

Methods

canUndo: (): true|false - returns true if undo buffer is not empty.
doUndo: (): true|false - discards last change in edit box, returns true if changes were made.
canRedo: (): true|false - returns true if redo buffer is not empty.
doRedo: (): true|false - applies last change, returns true if changes were made.
canCut: (): true|false - returns true if selection exists and the element is not readonly.
doCut: (): true|false - removes characters in selection and puts them into the clipboard, returns true if changes were made.
canCopy: (): true|false - returns true if selection exists.
doCopy: (): true|false - copies characters in selection to the clipboard, returns true if changes were made.
canPaste: (): true|false - returns true if the clipboard contains text.
doPaste: (): true|false - inserts characters from the clipboard at current caret position, returns true if changes were made.
canSelectAll: (): true|false - returns true if the element is not empty.
doSelectAll: (): true|false - selects all characters in the edit box, returns true if changes were made.
selectionStart: (): integer - returns start position of the selection, or caret position if there is no selection.
selectionEnd: (): integer - returns end position of the selection, or caret position if there is no selection.
selectionText: (): string - returns selected text or empty string if there is no selection.
setSelection: (anchorPos: integer, caretPos: integer) - selects text in the edit box. If anchorPos == caretPos then edit box will not contain any selection and caret will be set at that position.
insertText: (text:string) - inserts the text at current caret position, moves caret to the end of the text.
appendText: (text:string) - appends the text to current content of the edit box, moves caret to the end.