public class DashboardWidget extends DashboardItem
DashboardWidget Data class that encapsulates the entities which comprise a dashboard widget
Modifier and Type | Field and Description |
---|---|
static BBjNumber | ALIGN_CENTER=1 Constant specifying that the DashboardWidget's title should be aligned in the center. |
static BBjNumber | ALIGN_LEFT=0 Constant specifying that the DashboardWidget's title should be aligned left. |
static BBjNumber | ALIGN_RIGHT=2 Constant specifying that the DashboardWidget's title should be aligned right. |
static BBjNumber | AREA_CHART_WIDGET_TYPE Area chart widget type constant |
static BBjNumber | BAR_CHART_WIDGET_TYPE Bar chart widget type constant |
BBjColor | BorderColor! Border color of the dashboard widget |
BBjColor | BorderSelectedColor! Border color of a dashboard widget when it is selected |
BBjNumber | ClonedState Specifies whether the DashboardWidget is cloned. DashboardWidgets are cloned when they are popped out or displayed in the Customize screen. By executing the DashboardWidget::getClonedState() method in response to a DashboardEvent, you can determine whether your code is dealing with the original or popped out dashboard widget. |
static BBjNumber | CUSTOM_WIDGET_TYPE Custom widget type constant |
DashboardCategory | DashboardCategory! DashboardCategory which a part of |
static BBjNumber | DOCK_LEFT=0 Constant for dock left that is used to specify the location when creating a DashboardWidgetFilter via the addFilter() method |
static BBjNumber | DOCK_RIGHT=1 Constant for dock right that is used to specify the location when creating a DashboardWidgetFilter via the addFilter() method |
static BBjNumber | FILTER_TYPE_EDITBOX=2 Constant for Editbox-based filter used in the addFilter() method. |
static BBjNumber | FILTER_TYPE_LISTBUTTON=0 Constant for a BBjListButton-based filter used in the addFilter() method. |
static BBjNumber | FILTER_TYPE_LISTEDIT=1 Constant for BBjListEdit-based filter used in the addFilter() method. |
static BBjNumber | GRID_WIDGET_TYPE Grid widget type constant |
static BBjNumber | GRIDEX_WIDGET_TYPE JGridEx widget type constant |
static BBjNumber | HTML_VIEW_WIDGET_TYPE HTML View chart widget type constant |
static BBjNumber | IMAGE_WIDGET_TYPE Image widget type constant |
static BBjString | ImageList$ See the Dashboard::ImageList field variable for more information - The imagelist used by the DashboardWidget for its icons, such as on the Exit, Configure, and Popout buttons. This is used for device pixel ratios 2.0 and lower. Because this is a static, it only has to be called on a single DashboardWidget. |
static BBjString | ImageListHiRes$ See the Dashboard::ImageList field variable for more information - The high-res imagelist used by the DashboardWidget for its icons, such as on the Exit, Configure, and Popout buttons. This is used for device pixel ratios greater than 2.0. Because this is a static, it only has to be called on a single DashboardWidget. |
static BBjNumber | JASPER_VIEWER_WIDGET_TYPE Jasper Viewer widget type constant |
static BBjNumber | LINE_CHART_WIDGET_TYPE Line chart widget type constant |
static BBjNumber | MENU_TRIGGER_LEFT_CLICK=0 Constant for DashboardWidget popup menu triggered by a left click used in the addMenu() and getDashboardWidgetMenu() methods. |
static BBjNumber | MENU_TRIGGER_OPTIONS_CLICK=2 Constant for DashboardWidget popup menu triggered by clicking on the Options tool button used in the addMenu() and getDashboardWidgetMenu() methods. |
static BBjNumber | MENU_TRIGGER_RIGHT_CLICK=1 Constant for DashboardWidget popup menu triggered by a right click used in the addMenu() and getDashboardWidgetMenu() methods. |
static BBjNumber | ON_POPUP_ITEM_SELECT=BBjAPI().ON_POPUP_ITEM_SELECT Constant for the popup menu selection event used in the DashboardWidgetMenu::setCallback() method. |
static BBjNumber | ON_WIDGET_CLICK Constant for widget click event used in the setCallback() method. This event is independent of the mouse button (left, middle, right) and overrides any callbacks associated with the ON_WIDGET_LEFT_CLICK or ON_WIDGET_RIGHT_CLICK event types. |
static BBjNumber | ON_WIDGET_LEFT_CLICK Constant for widget left click event used in the setCallback() method |
static BBjNumber | ON_WIDGET_REFRESH Constant for widget refresh event used in the setCallback() method |
static BBjNumber | ON_WIDGET_RIGHT_CLICK Constant for widget right click event used in the setCallback() method |
static BBjNumber | ON_WIDGET_SELECT Constant for widget select event used in the setCallback() method |
static BBjNumber | PIE_CHART_WIDGET_TYPE Pie chart widget type constant |
BBjNumber | PopoutWidgetHeight The desired height of the widget when popped out |
BBjNumber | PopoutWidgetWidth The desired width of the widget when popped out |
static BBjNumber | RING_CHART_WIDGET_TYPE Ring chart widget type constant |
static BBjNumber | STACKED_AREA_CHART_WIDGET_TYPE Stacked area chart widget type constant |
static BBjNumber | STACKED_BAR_CHART_WIDGET_TYPE Stacked Bar chart widget type constant |
static BBjNumber | STACKED_PERCENTAGE_BAR_CHART_WIDGET_TYPE Stacked Percentage Bar chart widget type constant |
BBjNumber | TitlebarAlignment! The alignment of the titlebar's text, based on one of the ALIGN_* constants. The default is ALIGN_CENTER. |
BBjColor | TitlebarDecorationBackColor! Background color of the widget titlebar's window decoration section |
BBjColor | TitlebarDecorationSelectedBackColor! Background color of the widget titlebar's window decoration section when it is selected |
BBjColor | TitlebarNameBackColor! Background color of the widget titlebar's name section |
Font | TitlebarNameFont! Font for the text in the widget titlebar's name section |
BBjColor | TitlebarNameForeColor! Color of the text in the widget titlebar's name section |
BBjColor | TitlebarNameSelectedBackColor! Background color of the widget titlebar's name section when it is selected |
BBjColor | TitlebarSeparatorColor! Background color of the widget titlebar's window decoration section separator |
BBjColor | TitlebarSeparatorSelectedColor! Background color of the widget titlebar's window decoration section separator when it is selected |
CustomObject | WidgetClickCallbackObject! Custom object containing the method to be called when the DashboardWidgetClick event is processed |
BBjString | WidgetClickCallbackRoutine! Name of the subroutine or method that is to be called when the DashboardWidgetClick event is processed |
BBjString | WidgetClickEventName! Unique name to identify the DashboardWidgetClick event |
CustomObject | WidgetLeftClickCallbackObject! Custom object containing the method to be called when the DashboardWidgetLeftClick event is processed |
BBjString | WidgetLeftClickCallbackRoutine! Name of the subroutine or method that is to be called when the DashboardWidgetLeftClick event is processed |
BBjString | WidgetLeftClickEventName! Unique name to identify the DashboardWidgetLeftClick event |
CustomObject | WidgetRefreshCallbackObject! Refresh event callback object |
BBjString | WidgetRefreshCallbackRoutine! Refresh event callback routine |
BBjString | WidgetRefreshEventName! Refresh event name |
CustomObject | WidgetRightClickCallbackObject! Custom object containing the method to be called when the DashboardWidgetRightClick event is processed |
BBjString | WidgetRightClickCallbackRoutine! Name of the subroutine or method that is to be called when the DashboardWidgetRightClick event is processed |
BBjString | WidgetRightClickEventName! Unique name to identify the DashboardWidgetRightClick event |
CustomObject | WidgetSelectCallbackObject! Select event callback object |
BBjString | WidgetSelectCallbackRoutine! Select event callback routine |
BBjString | WidgetSelectEventName! Select event name |
static BBjNumber | XY_CHART_WIDGET_TYPE XY chart widget type constant |
Constructor and Description |
---|
DashboardWidget(Widget p_widget!) DashboardWidget Constructs a DashboardWidget |
DashboardWidget(DashboardCategory p_dashboardCategory!, Widget p_widget!) DashboardWidget Constructs a DashboardWidget |
Modifier and Type | Method and Description |
---|---|
DashboardWidgetFilter | addFilter(BBjString p_filterName$, BBjVector p_filterEntries!, BBjString p_toolTip$, BBjNumber p_dockLocation) Creates a DashboardWidgetFilter, adds it to the specified DashboardWidget, then returns the newly-created filter object This method adds a BBjListButton type of filter to the widget and fills it with the supplied vector items Use this method to create a DashboardWidgetFilter object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetFilter object, which instructs the WidgetControl to execute your custom code when the user selects an item from the filter. |
DashboardWidgetFilter | addFilter(BBjString p_filterName$, BBjVector p_filterEntries!, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_filterType) Creates a DashboardWidgetFilter, adds it to the specified DashboardWidget, then returns the newly-created filter object This method adds a specified type of filter to the widget and fills it with the supplied vector items Use this method to create a DashboardWidgetFilter object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetFilter object, which instructs the WidgetControl to execute your custom code when the user selects an item from the filter. |
DashboardWidgetFilter | addFilter(BBjString p_filterName$, LinkedHashMap p_filterEntries!, BBjString p_toolTip$, BBjNumber p_dockLocation) Creates a DashboardWidgetFilter, adds it to the specified DashboardWidget, then returns the newly-created filter object This method adds a BBjListButton type of filter to the widget and fills it with the supplied LinkedHashMap keys and values Use this method to create a DashboardWidgetFilter object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetFilter object, which instructs the WidgetControl to execute your custom code when the user selects an item from the filter. |
DashboardWidgetFilter | addFilter(BBjString p_filterName$, LinkedHashMap p_filterEntries!, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_filterType) Creates a DashboardWidgetFilter, adds it to the specified DashboardWidget, then returns the newly-created filter object This method adds a specified type of filter to the widget and fills it with the supplied LinkedHashMap keys and values Use this method to create a DashboardWidgetFilter object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetFilter object, which instructs the WidgetControl to execute your custom code when the user selects an item from the filter. |
DashboardWidgetLink | addLink(BBjString p_url$, BBjString p_text$, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_browseOnSelect) Creates a DashboardWidgetLink, adds it to the specified DashboardWidget, then returns the newly-created link object Use this method to create a DashboardWidgetLink object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetLink object, which instructs the WidgetControl to execute your custom code when the user clicks the link. |
DashboardWidgetMenu | addMenu(BBjPopupMenu p_menu!, BBjNumber p_triggerType) Creates a DashboardWidgetMenu, adds it to the specified DashboardWidget, then returns the newly-created menu object Use this method to create a DashboardWidgetMenu object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetMenu object, which instructs the WidgetControl to execute your custom code when the user selects a menu item from the DashboardWidgetMenu's popup menu. |
DashboardWidget | clone() Clones the DashboardWidget |
void | destroy() Destroys the DashboardWidget |
BBjNumber | getAutoRefreshEnabled() Returns the auto refresh enabled state (1 for enabled and 0 for disabled) |
BBjNumber | getAutoRefreshRate() Returns the auto refresh interval |
BBjNumber | getAutoRefreshUnit() Returns the auto refresh unit |
DashboardWidgetFilter | getDashboardWidgetFilterLeft() Returns the left dashboard widget filter |
DashboardWidgetFilter | getDashboardWidgetFilterRight() Returns the right dashboard widget filter |
DashboardWidgetLink | getDashboardWidgetLinkLeft() Returns the left dashboard widget link |
DashboardWidgetLink | getDashboardWidgetLinkRight() Returns the right dashboard widget link |
DashboardWidgetMenu | getDashboardWidgetMenu(BBjNumber p_triggerType) Returns the custom popup menu associated with the dashboard widget given the menu trigger type |
Widget | getWidget() Returns the encapsulated widget |
BBjNumber | getWidgetType() Returns the widget type |
BBjNumber | isActive() Returns that active status |
BBjNumber | isAutoRefreshEnabled() Returns if auto refresh is enabled or disabled |
BBjNumber | isCloseEnabled() Returns if close is enabled or disabled |
BBjNumber | isDestroyed() Returns if the widget is destroyed |
BBjNumber | isEmailEnabled() Returns if email is enabled or disabled |
BBjNumber | isExportDataEnabled() Returns if export data is enabled or disabled |
BBjNumber | isOptionsEnabled() Returns if the options is enabled or disabled |
BBjNumber | isPopoutEnabled() Returns if the poput is enabled or disabled |
BBjNumber | isRefreshEnabled() Returns if refresh is enabled or disabled |
BBjNumber | isSaveEnabled() Returns if save is enabled or disabled |
BBjNumber | isSelected() Returns that selected status |
BBjNumber | isViewDataEnabled() Returns if view data is enabled or disabled |
void | refresh() Refreshes the entire DashboardWidget, updating the view for the object including the inner Widget as well as any DashboardWidgetFilters and DashboardWidgetLinks that have been defined. This method may be used in response to a callback event that executes custom code to modify one or more of the filters and links. If the custom code only modifies the inner widget, then it's faster to call the widget's refresh method as that only affects the widget and not the filters or links. |
void | setActive(BBjNumber p_active) Sets the status to active or inactive |
void | setAutoRefreshEnabled(BBjNumber p_autoRefreshEnabled) Sets the auto refresh enabled or disabled |
void | setAutoRefreshRate(BBjNumber p_autoRefreshRate) Sets the auto refresh rate |
void | setAutoRefreshUnit(BBjNumber p_autoRefreshUnit) Sets the auto refresh unit |
void | setCallback(BBjNumber p_event, BBjString p_callbackRoutine!) Sets a callback for a dashboard widget event Call this method to have your custom code execute in response to a dashboard event, such as
The WidgetControl automatically responds to the desired event, creates the relevant subclass of the DashboardWidgetEvent 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 dashboard widget event Call this method to have your custom code execute in response to a dashboard event, such as
The WidgetControl automatically responds to the desired event, creates the relevant subclass of the DashboardWidgetEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event. |
void | setCloseEnabled(BBjNumber p_closeEnabled) Sets the close enabled or disabled |
void | setEmailEnabled(BBjNumber p_emailEnabled) Sets the email enabled or disabled |
void | setExportDataEnabled(BBjNumber p_exportDataEnabled) Sets the export data enabled or disabled |
void | setOptionsEnabled(BBjNumber p_optionsEnabled) Sets the options enabled or disabled |
void | setPopoutEnabled(BBjNumber p_popoutEnabled) Sets the popout enabled or disabled |
void | setPopoutSize(BBjNumber p_width, BBjNumber p_height) Sets the desired size of the widget when it's popped out |
void | setRefreshEnabled(BBjNumber p_refreshEnabled) Sets the refresh enabled or disabled |
void | setSaveEnabled(BBjNumber p_saveEnabled) Sets the save enabled or disabled |
void | setSelected(BBjNumber p_selected) Sets the DashboardWidget to be selected or deselected |
void | setViewDataEnabled(BBjNumber p_viewDataEnabled) Sets the view data enabled or disabled |
void | setWidgetControl(WidgetControl p_WidgetControl!) Sets the WidgetControl (view) that's associated with the DashboardWidget (model) |
getBackColor, getName, getTitle, getUserData, setBackColor, setName, setTitle, setUserData
public static BBjNumber ALIGN_CENTER=1
Constant specifying that the DashboardWidget's title should be aligned in the center.
BBj 16.20
public static BBjNumber ALIGN_LEFT=0
Constant specifying that the DashboardWidget's title should be aligned left.
BBj 16.20
public static BBjNumber ALIGN_RIGHT=2
Constant specifying that the DashboardWidget's title should be aligned right.
BBj 16.20
public static BBjNumber AREA_CHART_WIDGET_TYPE
Area chart widget type constant
public static BBjNumber BAR_CHART_WIDGET_TYPE
Bar chart widget type constant
public BBjColor BorderColor!
Border color of the dashboard widget
public BBjColor BorderSelectedColor!
Border color of a dashboard widget when it is selected
public BBjNumber ClonedState
Specifies whether the DashboardWidget is cloned. DashboardWidgets are cloned when they are popped out or displayed in the Customize screen. By executing the DashboardWidget::getClonedState() method in response to a DashboardEvent, you can determine whether your code is dealing with the original or popped out dashboard widget.
BBj 18.10
public static BBjNumber CUSTOM_WIDGET_TYPE
Custom widget type constant
public DashboardCategory DashboardCategory!
DashboardCategory which a part of
public static BBjNumber DOCK_LEFT=0
Constant for dock left that is used to specify the location when creating a DashboardWidgetFilter via the addFilter() method
public static BBjNumber DOCK_RIGHT=1
Constant for dock right that is used to specify the location when creating a DashboardWidgetFilter via the addFilter() method
public static BBjNumber FILTER_TYPE_EDITBOX=2
Constant for Editbox-based filter used in the addFilter() method.
BBj 16.00
public static BBjNumber FILTER_TYPE_LISTBUTTON=0
Constant for a BBjListButton-based filter used in the addFilter() method.
BBj 16.00
public static BBjNumber FILTER_TYPE_LISTEDIT=1
Constant for BBjListEdit-based filter used in the addFilter() method.
BBj 16.00
public static BBjNumber GRID_WIDGET_TYPE
Grid widget type constant
public static BBjNumber GRIDEX_WIDGET_TYPE
JGridEx widget type constant
public static BBjNumber HTML_VIEW_WIDGET_TYPE
HTML View chart widget type constant
public static BBjNumber IMAGE_WIDGET_TYPE
Image widget type constant
public static BBjString ImageList$
See the Dashboard::ImageList field variable for more information - The imagelist used by the DashboardWidget for its icons, such as on the Exit, Configure, and Popout buttons. This is used for device pixel ratios 2.0 and lower. Because this is a static, it only has to be called on a single DashboardWidget.
BBj 17.00
public static BBjString ImageListHiRes$
See the Dashboard::ImageList field variable for more information - The high-res imagelist used by the DashboardWidget for its icons, such as on the Exit, Configure, and Popout buttons. This is used for device pixel ratios greater than 2.0. Because this is a static, it only has to be called on a single DashboardWidget.
BBj 17.00
public static BBjNumber JASPER_VIEWER_WIDGET_TYPE
Jasper Viewer widget type constant
public static BBjNumber LINE_CHART_WIDGET_TYPE
Line chart widget type constant
public static BBjNumber MENU_TRIGGER_LEFT_CLICK=0
Constant for DashboardWidget popup menu triggered by a left click used in the addMenu() and getDashboardWidgetMenu() methods.
BBj 18.10
public static BBjNumber MENU_TRIGGER_OPTIONS_CLICK=2
Constant for DashboardWidget popup menu triggered by clicking on the Options tool button used in the addMenu() and getDashboardWidgetMenu() methods.
BBj 18.10
public static BBjNumber MENU_TRIGGER_RIGHT_CLICK=1
Constant for DashboardWidget popup menu triggered by a right click used in the addMenu() and getDashboardWidgetMenu() methods.
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 DashboardWidgetMenu::setCallback() method.
BBj 18.10
public static BBjNumber ON_WIDGET_CLICK
Constant for widget click event used in the setCallback() method. This event is independent of the mouse button (left, middle, right) and overrides any callbacks associated with the ON_WIDGET_LEFT_CLICK or ON_WIDGET_RIGHT_CLICK event types.
public static BBjNumber ON_WIDGET_LEFT_CLICK
Constant for widget left click event used in the setCallback() method
public static BBjNumber ON_WIDGET_REFRESH
Constant for widget refresh event used in the setCallback() method
public static BBjNumber ON_WIDGET_RIGHT_CLICK
Constant for widget right click event used in the setCallback() method
public static BBjNumber ON_WIDGET_SELECT
Constant for widget select event used in the setCallback() method
public static BBjNumber PIE_CHART_WIDGET_TYPE
Pie chart widget type constant
public BBjNumber PopoutWidgetHeight
The desired height of the widget when popped out
public BBjNumber PopoutWidgetWidth
The desired width of the widget when popped out
public static BBjNumber RING_CHART_WIDGET_TYPE
Ring chart widget type constant
public static BBjNumber STACKED_AREA_CHART_WIDGET_TYPE
Stacked area chart widget type constant
public static BBjNumber STACKED_BAR_CHART_WIDGET_TYPE
Stacked Bar chart widget type constant
public static BBjNumber STACKED_PERCENTAGE_BAR_CHART_WIDGET_TYPE
Stacked Percentage Bar chart widget type constant
public BBjNumber TitlebarAlignment!
The alignment of the titlebar's text, based on one of the ALIGN_* constants. The default is ALIGN_CENTER.
BBj 16.20
public BBjColor TitlebarDecorationBackColor!
Background color of the widget titlebar's window decoration section
public BBjColor TitlebarDecorationSelectedBackColor!
Background color of the widget titlebar's window decoration section when it is selected
public BBjColor TitlebarNameBackColor!
Background color of the widget titlebar's name section
public Font TitlebarNameFont!
Font for the text in the widget titlebar's name section
public BBjColor TitlebarNameForeColor!
Color of the text in the widget titlebar's name section
public BBjColor TitlebarNameSelectedBackColor!
Background color of the widget titlebar's name section when it is selected
public BBjColor TitlebarSeparatorColor!
Background color of the widget titlebar's window decoration section separator
public BBjColor TitlebarSeparatorSelectedColor!
Background color of the widget titlebar's window decoration section separator when it is selected
public CustomObject WidgetClickCallbackObject!
Custom object containing the method to be called when the DashboardWidgetClick event is processed
public BBjString WidgetClickCallbackRoutine!
Name of the subroutine or method that is to be called when the DashboardWidgetClick event is processed
public BBjString WidgetClickEventName!
Unique name to identify the DashboardWidgetClick event
public CustomObject WidgetLeftClickCallbackObject!
Custom object containing the method to be called when the DashboardWidgetLeftClick event is processed
public BBjString WidgetLeftClickCallbackRoutine!
Name of the subroutine or method that is to be called when the DashboardWidgetLeftClick event is processed
public BBjString WidgetLeftClickEventName!
Unique name to identify the DashboardWidgetLeftClick event
public CustomObject WidgetRefreshCallbackObject!
Refresh event callback object
public BBjString WidgetRefreshCallbackRoutine!
Refresh event callback routine
public BBjString WidgetRefreshEventName!
Refresh event name
public CustomObject WidgetRightClickCallbackObject!
Custom object containing the method to be called when the DashboardWidgetRightClick event is processed
public BBjString WidgetRightClickCallbackRoutine!
Name of the subroutine or method that is to be called when the DashboardWidgetRightClick event is processed
public BBjString WidgetRightClickEventName!
Unique name to identify the DashboardWidgetRightClick event
public CustomObject WidgetSelectCallbackObject!
Select event callback object
public BBjString WidgetSelectCallbackRoutine!
Select event callback routine
public BBjString WidgetSelectEventName!
Select event name
public static BBjNumber XY_CHART_WIDGET_TYPE
XY chart widget type constant
public DashboardWidget(Widget p_widget!)
DashboardWidget Constructs a DashboardWidget
p_widget!
Widget that will be encapsulated by this DashboardWidgetpublic DashboardWidget(DashboardCategory p_dashboardCategory!, Widget p_widget!)
DashboardWidget Constructs a DashboardWidget
p_dashboardCategory!
Category of the widget that will be encapsulated by this DashboardWidgetp_widget!
Widget that will be encapsulated by this DashboardWidgetpublic DashboardWidgetFilter addFilter(BBjString p_filterName$, BBjVector p_filterEntries!, BBjString p_toolTip$, BBjNumber p_dockLocation)
Creates a DashboardWidgetFilter, adds it to the specified DashboardWidget, then returns the newly-created filter object
This method adds a BBjListButton type of filter to the widget and fills it with the supplied vector items
Use this method to create a DashboardWidgetFilter object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetFilter object, which instructs the WidgetControl to execute your custom code when the user selects an item from the filter.
p_filterName$
Unique name of the filterp_filterEntries!
BBjVector of filter valuesp_toolTip$
Tool tip the filterp_dockLocation
Dock location of the filter. Values can be DashboardWidget.getDOCK_LEFT(), DashboardWidget.getDOCK_RIGHT()public DashboardWidgetFilter addFilter(BBjString p_filterName$, BBjVector p_filterEntries!, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_filterType)
Creates a DashboardWidgetFilter, adds it to the specified DashboardWidget, then returns the newly-created filter object
This method adds a specified type of filter to the widget and fills it with the supplied vector items
Use this method to create a DashboardWidgetFilter object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetFilter object, which instructs the WidgetControl to execute your custom code when the user selects an item from the filter.
p_filterName$
Unique name of the filterp_filterEntries!
BBjVector of filter valuesp_toolTip$
Tool tip the filterp_dockLocation
Dock location of the filter. Values can be DashboardWidget.getDOCK_LEFT(), DashboardWidget.getDOCK_RIGHT()p_filterType
Type of filter control. Values can be DashboardWidget.getFILTER_TYPE_LISTBUTTON(), DashboardWidget.getFILTER_TYPE_LISTEDIT(), DashboardWidget.getFILTER_TYPE_EDITBOX() BBj 16.00
public DashboardWidgetFilter addFilter(BBjString p_filterName$, LinkedHashMap p_filterEntries!, BBjString p_toolTip$, BBjNumber p_dockLocation)
Creates a DashboardWidgetFilter, adds it to the specified DashboardWidget, then returns the newly-created filter object
This method adds a BBjListButton type of filter to the widget and fills it with the supplied LinkedHashMap keys and values
Use this method to create a DashboardWidgetFilter object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetFilter object, which instructs the WidgetControl to execute your custom code when the user selects an item from the filter.
p_filterName$
Unique name of the filterp_filterEntries!
LinkedHashMap of filter keys/valuesp_toolTip$
Tool tip the filterp_dockLocation
Dock location of the filter. Values can be DashboardWidget.getDOCK_LEFT() or DashboardWidget.getDOCK_RIGHT() Oracle's LinkedHashMap documentation for more information on how to create and manipulate a LinkedHashMap object
public DashboardWidgetFilter addFilter(BBjString p_filterName$, LinkedHashMap p_filterEntries!, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_filterType)
Creates a DashboardWidgetFilter, adds it to the specified DashboardWidget, then returns the newly-created filter object
This method adds a specified type of filter to the widget and fills it with the supplied LinkedHashMap keys and values
Use this method to create a DashboardWidgetFilter object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetFilter object, which instructs the WidgetControl to execute your custom code when the user selects an item from the filter.
p_filterName$
Unique name of the filterp_filterEntries!
LinkedHashMap of filter keys/valuesp_toolTip$
Tool tip the filterp_dockLocation
Dock location of the filter. Values can be DashboardWidget.getDOCK_LEFT() or DashboardWidget.getDOCK_RIGHT()p_filterType
Type of filter control. Values can be DashboardWidget.getFILTER_TYPE_LISTBUTTON(), DashboardWidget.getFILTER_TYPE_LISTEDIT(), DashboardWidget.getFILTER_TYPE_EDITBOX() Oracle's LinkedHashMap documentation for more information on how to create and manipulate a LinkedHashMap object
BBj 16.00
public DashboardWidgetLink addLink(BBjString p_url$, BBjString p_text$, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_browseOnSelect)
Creates a DashboardWidgetLink, adds it to the specified DashboardWidget, then returns the newly-created link object
Use this method to create a DashboardWidgetLink object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetLink object, which instructs the WidgetControl to execute your custom code when the user clicks the link.
p_url$
URL of the linkp_text$
Text of the linkp_toolTip$
Tool tip for the linkp_dockLocation
Dock location of the link. Valid values are DashboardWidget.getDOCK_LEFT() or DashboardWidget.getDOCK_RIGHT()p_browseOnSelect
Indicates if the URL should be browsed to when selected. 0=Do not browse, 1=Browsepublic DashboardWidgetMenu addMenu(BBjPopupMenu p_menu!, BBjNumber p_triggerType)
Creates a DashboardWidgetMenu, adds it to the specified DashboardWidget, then returns the newly-created menu object
Use this method to create a DashboardWidgetMenu object by adding it to the desired DashboardWidget. The next step is to execute the setCallback() method on the resultant DashboardWidgetMenu object, which instructs the WidgetControl to execute your custom code when the user selects a menu item from the DashboardWidgetMenu's popup menu.
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 DashboardWidget clone()
Clones the DashboardWidget
public void destroy()
Destroys the DashboardWidget
public BBjNumber getAutoRefreshEnabled()
Returns the auto refresh enabled state (1 for enabled and 0 for disabled)
BBj 18.20
public BBjNumber getAutoRefreshRate()
Returns the auto refresh interval
public BBjNumber getAutoRefreshUnit()
Returns the auto refresh unit
public DashboardWidgetFilter getDashboardWidgetFilterLeft()
Returns the left dashboard widget filter
public DashboardWidgetFilter getDashboardWidgetFilterRight()
Returns the right dashboard widget filter
public DashboardWidgetLink getDashboardWidgetLinkLeft()
Returns the left dashboard widget link
public DashboardWidgetLink getDashboardWidgetLinkRight()
Returns the right dashboard widget link
public DashboardWidgetMenu getDashboardWidgetMenu(BBjNumber p_triggerType)
Returns the custom popup menu associated with the dashboard widget given the menu trigger type
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(). BBj 18.10
public Widget getWidget()
Returns the encapsulated widget
public BBjNumber getWidgetType()
Returns the widget type
public BBjNumber isActive()
Returns that active status
public BBjNumber isAutoRefreshEnabled()
Returns if auto refresh is enabled or disabled
public BBjNumber isCloseEnabled()
Returns if close is enabled or disabled
public BBjNumber isDestroyed()
Returns if the widget is destroyed
public BBjNumber isEmailEnabled()
Returns if email is enabled or disabled
public BBjNumber isExportDataEnabled()
Returns if export data is enabled or disabled
public BBjNumber isOptionsEnabled()
Returns if the options is enabled or disabled
public BBjNumber isPopoutEnabled()
Returns if the poput is enabled or disabled
public BBjNumber isRefreshEnabled()
Returns if refresh is enabled or disabled
public BBjNumber isSaveEnabled()
Returns if save is enabled or disabled
public BBjNumber isSelected()
Returns that selected status
public BBjNumber isViewDataEnabled()
Returns if view data is enabled or disabled
public void refresh()
Refreshes the entire DashboardWidget, updating the view for the object including the inner Widget as well as any DashboardWidgetFilters and DashboardWidgetLinks that have been defined. This method may be used in response to a callback event that executes custom code to modify one or more of the filters and links. If the custom code only modifies the inner widget, then it's faster to call the widget's refresh method as that only affects the widget and not the filters or links.
BBj 17.00
public void setActive(BBjNumber p_active)
Sets the status to active or inactive
p_active
Specify 1 for active and 0 for inactivepublic void setAutoRefreshEnabled(BBjNumber p_autoRefreshEnabled)
Sets the auto refresh enabled or disabled
p_autoRefreshEnabled
Specify 1 for enabled and 0 for disabledpublic void setAutoRefreshRate(BBjNumber p_autoRefreshRate)
Sets the auto refresh rate
p_autoRefreshRate
Number of seconds for the auto refresh interval. Must be between 1 and 999public void setAutoRefreshUnit(BBjNumber p_autoRefreshUnit)
Sets the auto refresh unit
p_autoRefreshUnit
Unit for refresh interval, can be one of the following constants: AutoRefreshUnit.getSECONDS(), AutoRefreshUnit.getMINUTES(), AutoRefreshUnit.getHOURS()public void setCallback(BBjNumber p_event, BBjString p_callbackRoutine!)
Sets a callback for a dashboard widget event Call this method to have your custom code execute in response to a dashboard event, such as
The WidgetControl automatically responds to the desired event, creates the relevant subclass of the DashboardWidgetEvent 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. Valid values are DashboardWidget.getON_WIDGET_REFRESH() or DashboardWidget.getON_WIDGET_SELECT()p_callbackRoutine!
Routine to call when the event is triggeredpublic void setCallback(BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine!)
Sets a callback for a dashboard widget event Call this method to have your custom code execute in response to a dashboard event, such as
The WidgetControl automatically responds to the desired event, creates the relevant subclass of the DashboardWidgetEvent 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. Use a value like DashboardWidget.getON_WIDGET_REFRESH() or DashboardWidget.getON_WIDGET_LEFT_CLICK()p_callbackObject!
CustomObject that contains the routine to call when the event is triggeredp_callbackRoutine!
Routine to call when the event is triggeredpublic void setCloseEnabled(BBjNumber p_closeEnabled)
Sets the close enabled or disabled
p_closeEnabled
Specify 1 for enabled and 0 for disabledpublic void setEmailEnabled(BBjNumber p_emailEnabled)
Sets the email enabled or disabled
p_emailEnabled
Specify 1 for enabled and 0 for disabledpublic void setExportDataEnabled(BBjNumber p_exportDataEnabled)
Sets the export data enabled or disabled
p_exportDataEnabled
Specify 1 for enabled and 0 for disabledpublic void setOptionsEnabled(BBjNumber p_optionsEnabled)
Sets the options enabled or disabled
p_optionsEnabled
Specify 1 for enabled and 0 for disabledpublic void setPopoutEnabled(BBjNumber p_popoutEnabled)
Sets the popout enabled or disabled
p_popoutEnabled
Specify 1 for enabled and 0 for disabledpublic void setPopoutSize(BBjNumber p_width, BBjNumber p_height)
Sets the desired size of the widget when it's popped out
p_width
The desired width of the popoutp_height
The desired height of the popoutpublic void setRefreshEnabled(BBjNumber p_refreshEnabled)
Sets the refresh enabled or disabled
p_refreshEnabled
Specify 1 for enabled and 0 for disabledpublic void setSaveEnabled(BBjNumber p_saveEnabled)
Sets the save enabled or disabled
p_saveEnabled
Specify 1 for enabled and 0 for disabledpublic void setSelected(BBjNumber p_selected)
Sets the DashboardWidget to be selected or deselected
p_selected
Specify 1 for selected and 0 for deselectedpublic void setViewDataEnabled(BBjNumber p_viewDataEnabled)
Sets the view data enabled or disabled
p_viewDataEnabled
Specify 1 for enabled and 0 for disabledpublic void setWidgetControl(WidgetControl p_WidgetControl!)
Sets the WidgetControl (view) that's associated with the DashboardWidget (model)
The
WidgetControl for this DashboardWidget BBj 17.00