jsx3.gui.BlockAPI


After MoveFires when the user releases the mouse button after moving this block across the screen.
Before MoveFires when the user depresses the mouse button on this movable block.
ClickFires after the user clicks this block.
Ctrl DropFires after the user drops an object on this block while pressing the Ctrl key.
DestroyFires after this block is removed from the DOM.
Double-ClickFires after the user double-clicks this block.
DragFires when the user drags this block.
DropFires after the user drops an object on this block.
Key DownFires after a browser keydown event when this block has focus.
MenuFires after the user right-clicks this block and before the bound context menu displays.
SpyglassFires after the user hovers the mouse over this block and before the spyglass displays.

Dragjsxdrag

Fires when the user drags this block. Canceling this event prevents the drag from occurring.
Cancelable: Evaluate to false to cancel event.

Context Variables

this {jsx3.gui.Block} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.
strDRAGTYPE {String} - the type of drag (JSXDragType).
strDRAGID {String} - the id of the dragged element (JSXDragId).
objGUI {HTMLElement} - the HTML element acted upon.

Key Downjsxkeydown

Fires after a browser keydown event when this block has focus.

Context Variables

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

Clickjsxclick

Fires after the user clicks this block.

Context Variables

this {jsx3.gui.Block} - 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 block.

Context Variables

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

Dropjsxdrop

Fires after the user drops an object on this block.

Context Variables

this {jsx3.gui.Block} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.
objSOURCE {jsx3.gui.Block} - the object where the drag begins.
strDRAGTYPE {String} - the type of drag (JSXDragType).
strDRAGID {String} - the id of the dragged element (JSXDragId).
objGUI {HTMLElement} - the HTML element acted upon.

Ctrl Dropjsxctrldrop

Fires after the user drops an object on this block while pressing the Ctrl key.

Context Variables

this {jsx3.gui.Block} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.
objSOURCE {jsx3.gui.Block} - the object where the drag begins.
strDRAGTYPE {String} - the type of drag (JSXDragTyp).e
strDRAGID {String} - the id of the dragged element (JSXDragId).
objGUI {HTMLElement} - the HTML element acted upon.

Spyglassjsxspy

Fires after the user hovers the mouse over this block and before the spyglass displays. The event script must evaluate to the HTML content to display in the spyglass. Canceling this event prevents the spyglass from displaying.
Cancelable: Evaluate to false to cancel event.

Context Variables

this {jsx3.gui.Block} - 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 block 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.Block} - 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.

Before Movejsxbeforemove

Fires when the user depresses the mouse button on this movable block. Canceling this event prevents this block from moving.
Cancelable: Evaluate to false to cancel event.

Context Variables

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

Return Fields

bCONSTRAINX {boolean} - set to true if only vertical movement allowed. For example: o = {bCONSTRAINX:true};
bCONSTRAINY {boolean} - set to true if only horizontal movement allowed. For example: o = {bCONSTRAINY:true};

After Movejsxaftermove

Fires when the user releases the mouse button after moving this block across the screen.

Context Variables

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

Destroyjsxdestroy

Fires after this block is removed from the DOM.

Context Variables

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