Dashboard

Class DashboardWidgetMenu

java.lang.Object

Dashboard.DashboardWidgetMenu

public class DashboardWidgetMenu
extends Object

Data class for a custom popup menu associated with a dashboard widget

The dashboard utility uses this method internally when you execute the DashboardWidget::addMenu() method to create a DashboardWidgetMenu and add it to an existing DashboardWidget

Since:

BBj 18.10

Field Summary

Fields

Modifier and Type	Field and Description
CustomObject	MenuItemSelectCallbackObject! CustomObject that contains the routine to handle a selection event from the custom popup menu.
BBjString	MenuItemSelectCallbackRoutine! Routine to handle a selection event from the custom popup menu.
BBjString	MenuItemSelectName! Name of the menu selection event.
BBjNumber	MenuTriggerType The user event that triggers the display of the menu.
static BBjNumber	ON_POPUP_ITEM_SELECT Constant for the popup menu selection event used in the setCallback() method.
BBjPopupMenu	PopupMenu! The BBjPopupMenu to display when triggered by a user event.

Constructor Summary

Constructors

Constructor and Description
DashboardWidgetMenu(BBjPopupMenu p_bbjPopupMenu!, BBjNumber p_triggerType) Constructs a DashboardWidgetMenu

Method Summary

Modifier and Type	Method and Description
DashboardWidgetMenu	clone() Creates and returns a clone of the DashboardWidgetMenu
void	destroy() Destroys the DashboardWidgetMenu
void	setCallback(BBjNumber p_event, BBjString p_callbackRoutine!) Sets a callback for a menu item selection event from the DashboardWidgetMenu
void	setCallback(BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) Sets a callback for a menu item selection event from the DashboardWidgetMenu

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MenuItemSelectName!

public BBjString MenuItemSelectName!

Name of the menu selection event. @since BBj 18.10

MenuItemSelectCallbackObject!

public CustomObject MenuItemSelectCallbackObject!

CustomObject that contains the routine to handle a selection event from the custom popup menu. @since BBj 18.10

MenuItemSelectCallbackRoutine!

public BBjString MenuItemSelectCallbackRoutine!

Routine to handle a selection event from the custom popup menu. @since BBj 18.10

ON_POPUP_ITEM_SELECT

public static BBjNumber ON_POPUP_ITEM_SELECT

Constant for the popup menu selection event used in the setCallback() method. @since BBj 18.10

PopupMenu!

public BBjPopupMenu PopupMenu!

The BBjPopupMenu to display when triggered by a user event. @since BBj 18.10

MenuTriggerType

public BBjNumber MenuTriggerType

The user event that triggers the display of the menu. Values can be DashboardWidget.getMENU_TRIGGER_LEFT_CLICK(), DashboardWidget.getMENU_TRIGGER_RIGHT_CLICK(), or DashboardWidget.getMENU_TRIGGER_OPTIONS_CLICK(). @since BBj 18.10

Constructor Detail

DashboardWidgetMenu

public DashboardWidgetMenu(BBjPopupMenu p_bbjPopupMenu!,
BBjNumber p_triggerType)

Constructs a DashboardWidgetMenu

The dashboard utility uses this method internally when you execute the DashboardWidget::addMenu() method to create a DashboardWidgetMenu and add it to an existing DashboardWidget

Parameters:

p_menu! - An existing BBjPopupMenu that was previously created via the BBj API

p_triggerType - The event type that triggers the popup menu. Values can be DashboardWidget.getMENU_TRIGGER_LEFT_CLICK(), DashboardWidget.getMENU_TRIGGER_RIGHT_CLICK(), or DashboardWidget.getMENU_TRIGGER_OPTIONS_CLICK().

Since:

BBj 18.10

See Also:

BBjSysGui::addPopupMenu documentation to create the BBjPopupMenu parameter

Method Detail

clone

public DashboardWidgetMenu clone()

Creates and returns a clone of the DashboardWidgetMenu

Overrides:

clone in class Object

Returns:

Returns the cloned DashboardWidgetMenu

Since:

BBj 18.10

destroy

public void destroy()

Destroys the DashboardWidgetMenu

Since:

BBj 18.10

setCallback

public void setCallback(BBjNumber p_event,
BBjString p_callbackRoutine!)

Sets a callback for a menu item selection event from the DashboardWidgetMenu

After you create a DashboardWidgetMenu object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to a menu selection event. The WidgetControl automatically responds to the user selecting a menu item from the popup menu, creates the relevant DashboardWidgetMenuSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.

Parameters:

p_event - Indicates the event registering for. Value is always DashboardWidgetMenu.getON_POPUP_ITEM_SELECT().

p_callbackRoutine! - Routine to call when the event is triggered

Since:

BBj 18.10

setCallback

public void setCallback(BBjNumber p_event,
CustomObject p_callbackObject!,
BBjString p_callbackRoutine!)

Sets a callback for a menu item selection event from the DashboardWidgetMenu

After you create a DashboardWidgetMenu object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to a menu selection event. The WidgetControl automatically responds to the user selecting a menu item from the popup menu, creates the relevant DashboardWidgetMenuSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.

Parameters:

p_event - Indicates the event registering for. Value is always DashboardWidgetMenu.getON_POPUP_ITEM_SELECT().

p_callbackObject! - CustomObject that contains the routine to call when the event is triggered

p_callbackRoutine! - Routine to call when the event is triggered

Since:

BBj 18.10