jsx3.gui.TextBoxAPI


BlurFires after this text box loses focus.
ChangeFires after the user edits the value of this text box and this text box loses focus.
DestroyFires after this text box is removed from the DOM.
Double-ClickFires after the user double-clicks this text box.
ExecuteFires after the user presses the Enter key while this text box has focus.
FocusFires after this text box gains focus.
Incr. ChangeFires after each key event that changes the value of this text box.
Key DownFires after a browser keydown event while this text box has focus.
Key PressFires after a browser keypress event while this text box has focus.
Key UpFires after a browser keyup event while this text box has focus.
MenuFires after the user right-clicks this text box and before the bound context menu displays.
Mouse WheelFires after the user uses the mouse scroll wheel while the mouse is over this text box.

Executejsxexecute

Fires after the user presses the Enter key while this text box has focus.

Context Variables

this {jsx3.gui.TextBox} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.

Key Pressjsxkeypress

Fires after a browser keypress event while this text box has focus.

Context Variables

this {jsx3.gui.TextBox} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.

Key Downjsxkeydown

Fires after a browser keydown event while this text box has focus.

Context Variables

this {jsx3.gui.TextBox} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.

Key Upjsxkeyup

Fires after a browser keyup event while this text box has focus.

Context Variables

this {jsx3.gui.TextBox} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.

Changejsxchange

Fires after the user edits the value of this text box and this text box loses focus. Canceling this event prevents the edit from occurring.
Cancelable: Evaluate to false to cancel event.

Context Variables

this {jsx3.gui.TextBox} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.
strPREVIOUS {String} - the value before the text box receives focus.
strVALUE {String} - the new value.

Incr. Changejsxincchange

Fires after each key event that changes the value of this text box. This event fires only once after a key is held down to produce multiple characters. Canceling this event prevents the edit from occurring.
Cancelable: Evaluate to false to cancel event.

Context Variables

this {jsx3.gui.TextBox} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.
strPREVIOUS {String} - the value before the last key event.
strVALUE {String} - the incrementally changed value.

Mouse Wheeljsxmousewheel

Fires after the user uses the mouse scroll wheel while the mouse is over this text box.

Context Variables

this {jsx3.gui.TextBox} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.

Menujsxmenu

Fires after the user right-clicks this text box and before the bound context menu displays. Canceling this event prevents the menu from displaying.
Cancelable: Evaluate to false to cancel event.

Context Variables

this {jsx3.gui.TextBox} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.
objMENU {jsx3.gui.Menu} - the menu to display.

Return Fields

objMENU {jsx3.gui.Menu} - use this field to override the default menu with an instance of jsx3.gui.Menu.

Blurjsxblur

Fires after this text box loses focus.

Context Variables

this {jsx3.gui.TextBox} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.

Focusjsxfocus

Fires after this text box gains focus.

Context Variables

this {jsx3.gui.TextBox} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.

Double-Clickjsxdblclick

Fires after the user double-clicks this text box.

Context Variables

this {jsx3.gui.TextBox} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.

Destroyjsxdestroy

Fires after this text box is removed from the DOM.

Context Variables

this {jsx3.gui.TextBox} - the object that publishes this event.
objPARENT {jsx3.app.Model} - the parent of this text box before it is removed from the DOM.