jsx3.gui.ImageButtonAPI


DestroyFires after this image button is removed from the DOM.
ExecuteFires after the user clicks this image button or after an equivalent event.
MenuFires after the user right-clicks this image button and before the bound context menu displays.
ToggleFires when the user changes the state of this image button.

Executejsxexecute

Fires after the user clicks this image button or after an equivalent event.

Context Variables

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

Togglejsxtoggle

Fires when the user changes the state of this image button. Canceling this event prevents the change of state.
Cancelable: Evaluate to false to cancel event.

Context Variables

this {jsx3.gui.ImageButton} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.
intSTATE {int} - the new state if not vetoed.

Menujsxmenu

Fires after the user right-clicks this image button 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.ImageButton} - 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.

Destroyjsxdestroy

Fires after this image button is removed from the DOM.

Context Variables

this {jsx3.gui.ImageButton} - the object that publishes this event.
objPARENT {jsx3.app.Model} - the parent of this image button before it is removed from the DOM.