jsx3.gui.MenuAPI


Before ShowFires before this menu displays.
DestroyFires after this menu is removed from the DOM.
ExecuteFires after the user clicks an item in this menu or after an equivalent event.
HideFires after this menu closes.
SpyglassFires after the user hovers the mouse over this menu and before the spyglass displays.

Executejsxexecute

Fires after the user clicks an item in this menu or after an equivalent event.

Context Variables

this {jsx3.gui.Menu} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {String} - the CDF jsxid of the selected record.
objRECORD {jsx3.xml.Entity} - the object handle to the CDF record.

Before Showjsxmenu

Fires before this menu displays. Canceling this event prevents the menu from displaying.
Cancelable: Evaluate to false to cancel event.

Context Variables

this {jsx3.gui.Menu} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.
objANCHOR {HTMLElement} - the on-screen HTML element next to which the menu displays. May be null if a context menu or invoked by a hot key.
intINDEX {int} - the 1-based nesting index of the menu. The root menu or context menu is 1. Nested menus are 2, 3, 4, and so on. May be null if invoked by hot key.
strPARENTID {String} - the CDF jsxid of the menu item expanding to show a nested menu. May be null if a top-level menu.

Spyglassjsxspy

Fires after the user hovers the mouse over this menu 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.Menu} - the object that publishes this event.
objEVENT {jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {String} - the CDF jsxid of the spied record.

Hidejsxhide

Fires after this menu closes.

Context Variables

this {jsx3.gui.Menu} - the object that publishes this event.

Destroyjsxdestroy

Fires after this menu is removed from the DOM.

Context Variables

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