public class DashboardWidgetMenu
DashboardWidgetMenu 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
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. Values can be DashboardWidget.getMENU_TRIGGER_LEFT_CLICK(), DashboardWidget.getMENU_TRIGGER_RIGHT_CLICK(), or DashboardWidget.getMENU_TRIGGER_OPTIONS_CLICK(). |
static BBjNumber | ON_POPUP_ITEM_SELECT=BBjAPI().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 and Description |
---|
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 |
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 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. |
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. |
public CustomObject MenuItemSelectCallbackObject!
CustomObject that contains the routine to handle a selection event from the custom popup menu.
BBj 18.10
public BBjString MenuItemSelectCallbackRoutine!
Routine to handle a selection event from the custom popup menu.
BBj 18.10
public BBjString MenuItemSelectName!
Name of the menu selection event.
BBj 18.10
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().
BBj 18.10
public static BBjNumber ON_POPUP_ITEM_SELECT=BBjAPI().ON_POPUP_ITEM_SELECT
Constant for the popup menu selection event used in the setCallback() method.
BBj 18.10
public BBjPopupMenu PopupMenu!
The BBjPopupMenu to display when triggered by a user event.
BBj 18.10
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
p_menu!
An existing BBjPopupMenu that was previously created via the BBj APIp_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(). The BBjSysGui::addPopupMenu documentation to create the BBjPopupMenu parameter
BBj 18.10
public DashboardWidgetMenu clone()
Creates and returns a clone of the DashboardWidgetMenu
BBj 18.10
public void destroy()
Destroys the DashboardWidgetMenu
BBj 18.10
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.
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 BBj 18.10
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.
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 triggeredp_callbackRoutine!
Routine to call when the event is triggered BBj 18.10