DashboardWidget

java.lang.Object
- Dashboard.DashboardItem
- - Dashboard.DashboardWidget

Direct Known Subclasses:

EmbeddedWidget
```
public class DashboardWidget
extends DashboardItem
```
Data class that encapsulates the entities which comprise a dashboard widget

Field Summary

Fields
Modifier and Type	Field and Description
`static BBjNumber`	`ALIGN_CENTER` Constant specifying that the DashboardWidget's title should be aligned in the center.
`static BBjNumber`	`ALIGN_LEFT` Constant specifying that the DashboardWidget's title should be aligned left.
`static BBjNumber`	`ALIGN_RIGHT` 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.
`static BBjNumber`	`CUSTOM_WIDGET_TYPE` Custom widget type constant
`DashboardCategory`	`DashboardCategory!` DashboardCategory which a part of
`static BBjNumber`	`DOCK_LEFT` Constant for dock left that is used to specify the location when creating a DashboardWidgetFilter via the addFilter() method
`static BBjNumber`	`DOCK_RIGHT` Constant for dock right that is used to specify the location when creating a DashboardWidgetFilter via the addFilter() method
`static BBjNumber`	`FILTER_TYPE_EDITBOX` Constant for Editbox-based filter used in the addFilter() method.
`static BBjNumber`	`FILTER_TYPE_LISTBUTTON` Constant for a BBjListButton-based filter used in the addFilter() method.
`static BBjNumber`	`FILTER_TYPE_LISTEDIT` 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.
`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.
`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` Constant for DashboardWidget popup menu triggered by a left click used in the addMenu() and getDashboardWidgetMenu() methods.
`static BBjNumber`	`MENU_TRIGGER_OPTIONS_CLICK` 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` Constant for DashboardWidget popup menu triggered by a right click used in the addMenu() and getDashboardWidgetMenu() methods.
`static BBjNumber`	`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.
`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.
`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 Summary

Constructors
Constructor and Description
`DashboardWidget(DashboardCategory p_dashboardCategory!, Widget p_widget!)` Constructs a DashboardWidget
`DashboardWidget(Widget p_widget!)` Constructs a DashboardWidget

Method Summary

All Methods Instance Methods Concrete Methods
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
`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
`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
`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
`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
`DashboardWidgetMenu`	`addMenu(BBjPopupMenu p_menu!, BBjNumber p_triggerType)` Creates a DashboardWidgetMenu, adds it to the specified DashboardWidget, then returns the newly-created menu object
`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.
`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 DashboardWidget::getON_WIDGET_CLICK() DashboardWidget::getON_WIDGET_LEFT_CLICK() DashboardWidget::getON_WIDGET_RIGHT_CLICK() DashboardWidget::getON_WIDGET_REFRESH() DashboardWidget::getON_WIDGET_SELECT() 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 DashboardWidget::getON_WIDGET_CLICK() DashboardWidget::getON_WIDGET_LEFT_CLICK() DashboardWidget::getON_WIDGET_RIGHT_CLICK() DashboardWidget::getON_WIDGET_REFRESH() DashboardWidget::getON_WIDGET_SELECT() 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)

Methods inherited from class Dashboard.DashboardItem
getBackColor, getName, getTitle, getUserData, setBackColor, setName, setTitle, setUserData

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DashboardCategory!
```
public DashboardCategory DashboardCategory!
```
    DashboardCategory which a part of
  - WidgetClickEventName!
```
public BBjString WidgetClickEventName!
```
    Unique name to identify the DashboardWidgetClick event
  - WidgetClickCallbackObject!
```
public CustomObject WidgetClickCallbackObject!
```
    Custom object containing the method to be called when the DashboardWidgetClick event is processed
  - WidgetClickCallbackRoutine!
```
public BBjString WidgetClickCallbackRoutine!
```
    Name of the subroutine or method that is to be called when the DashboardWidgetClick event is processed
  - WidgetLeftClickEventName!
```
public BBjString WidgetLeftClickEventName!
```
    Unique name to identify the DashboardWidgetLeftClick event
  - WidgetLeftClickCallbackObject!
```
public CustomObject WidgetLeftClickCallbackObject!
```
    Custom object containing the method to be called when the DashboardWidgetLeftClick event is processed
  - WidgetLeftClickCallbackRoutine!
```
public BBjString WidgetLeftClickCallbackRoutine!
```
    Name of the subroutine or method that is to be called when the DashboardWidgetLeftClick event is processed
  - WidgetRightClickEventName!
```
public BBjString WidgetRightClickEventName!
```
    Unique name to identify the DashboardWidgetRightClick event
  - WidgetRightClickCallbackObject!
```
public CustomObject WidgetRightClickCallbackObject!
```
    Custom object containing the method to be called when the DashboardWidgetRightClick event is processed
  - WidgetRightClickCallbackRoutine!
```
public BBjString WidgetRightClickCallbackRoutine!
```
    Name of the subroutine or method that is to be called when the DashboardWidgetRightClick event is processed
  - WidgetRefreshEventName!
```
public BBjString WidgetRefreshEventName!
```
    Refresh event name
  - WidgetRefreshCallbackObject!
```
public CustomObject WidgetRefreshCallbackObject!
```
    Refresh event callback object
  - WidgetRefreshCallbackRoutine!
```
public BBjString WidgetRefreshCallbackRoutine!
```
    Refresh event callback routine
  - WidgetSelectEventName!
```
public BBjString WidgetSelectEventName!
```
    Select event name
  - WidgetSelectCallbackObject!
```
public CustomObject WidgetSelectCallbackObject!
```
    Select event callback object
  - WidgetSelectCallbackRoutine!
```
public BBjString WidgetSelectCallbackRoutine!
```
    Select event callback routine
  - PopoutWidgetWidth
```
public BBjNumber PopoutWidgetWidth
```
    The desired width of the widget when popped out
  - PopoutWidgetHeight
```
public BBjNumber PopoutWidgetHeight
```
    The desired height of the widget when popped out
  - TitlebarNameForeColor!
```
public BBjColor TitlebarNameForeColor!
```
    Color of the text in the widget titlebar's name section
  - TitlebarNameFont!
```
public Font TitlebarNameFont!
```
    Font for the text in the widget titlebar's name section
  - TitlebarNameBackColor!
```
public BBjColor TitlebarNameBackColor!
```
    Background color of the widget titlebar's name section
  - TitlebarNameSelectedBackColor!
```
public BBjColor TitlebarNameSelectedBackColor!
```
    Background color of the widget titlebar's name section when it is selected
  - TitlebarAlignment!
```
public BBjNumber TitlebarAlignment!
```
    The alignment of the titlebar's text, based on one of the ALIGN_* constants. The default is ALIGN_CENTER. @since BBj 16.20
  - TitlebarDecorationBackColor!
```
public BBjColor TitlebarDecorationBackColor!
```
    Background color of the widget titlebar's window decoration section
  - TitlebarDecorationSelectedBackColor!
```
public BBjColor TitlebarDecorationSelectedBackColor!
```
    Background color of the widget titlebar's window decoration section when it is selected
  - TitlebarSeparatorColor!
```
public BBjColor TitlebarSeparatorColor!
```
    Background color of the widget titlebar's window decoration section separator
  - TitlebarSeparatorSelectedColor!
```
public BBjColor TitlebarSeparatorSelectedColor!
```
    Background color of the widget titlebar's window decoration section separator when it is selected
  - BorderColor!
```
public BBjColor BorderColor!
```
    Border color of the dashboard widget
  - BorderSelectedColor!
```
public BBjColor BorderSelectedColor!
```
    Border color of a dashboard widget when it is selected
  - ImageList$
```
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. @since BBj 17.00
  - ImageListHiRes$
```
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. @since BBj 17.00
  - ClonedState
```
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. @since BBj 18.10
  - ON_WIDGET_REFRESH
```
public static BBjNumber ON_WIDGET_REFRESH
```
    Constant for widget refresh event used in the setCallback() method
  - ON_WIDGET_SELECT
```
public static BBjNumber ON_WIDGET_SELECT
```
    Constant for widget select event used in the setCallback() method
  - ON_WIDGET_CLICK
```
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.
  - ON_WIDGET_LEFT_CLICK
```
public static BBjNumber ON_WIDGET_LEFT_CLICK
```
    Constant for widget left click event used in the setCallback() method
  - ON_WIDGET_RIGHT_CLICK
```
public static BBjNumber ON_WIDGET_RIGHT_CLICK
```
    Constant for widget right click event used in the setCallback() method
  - ON_POPUP_ITEM_SELECT
```
public static BBjNumber ON_POPUP_ITEM_SELECT
```
    Constant for the popup menu selection event used in the DashboardWidgetMenu::setCallback() method. @since BBj 18.10
  - FILTER_TYPE_LISTBUTTON
```
public static BBjNumber FILTER_TYPE_LISTBUTTON
```
    Constant for a BBjListButton-based filter used in the addFilter() method. @since BBj 16.00
  - FILTER_TYPE_LISTEDIT
```
public static BBjNumber FILTER_TYPE_LISTEDIT
```
    Constant for BBjListEdit-based filter used in the addFilter() method. @since BBj 16.00
  - FILTER_TYPE_EDITBOX
```
public static BBjNumber FILTER_TYPE_EDITBOX
```
    Constant for Editbox-based filter used in the addFilter() method. @since BBj 16.00
  - MENU_TRIGGER_LEFT_CLICK
```
public static BBjNumber MENU_TRIGGER_LEFT_CLICK
```
    Constant for DashboardWidget popup menu triggered by a left click used in the addMenu() and getDashboardWidgetMenu() methods. @since BBj 18.10
  - MENU_TRIGGER_RIGHT_CLICK
```
public static BBjNumber MENU_TRIGGER_RIGHT_CLICK
```
    Constant for DashboardWidget popup menu triggered by a right click used in the addMenu() and getDashboardWidgetMenu() methods. @since BBj 18.10
  - MENU_TRIGGER_OPTIONS_CLICK
```
public static BBjNumber MENU_TRIGGER_OPTIONS_CLICK
```
    Constant for DashboardWidget popup menu triggered by clicking on the Options tool button used in the addMenu() and getDashboardWidgetMenu() methods. @since BBj 18.10
  - DOCK_LEFT
```
public static BBjNumber DOCK_LEFT
```
    Constant for dock left that is used to specify the location when creating a DashboardWidgetFilter via the addFilter() method
  - DOCK_RIGHT
```
public static BBjNumber DOCK_RIGHT
```
    Constant for dock right that is used to specify the location when creating a DashboardWidgetFilter via the addFilter() method
  - ALIGN_LEFT
```
public static BBjNumber ALIGN_LEFT
```
    Constant specifying that the DashboardWidget's title should be aligned left. @since BBj 16.20
  - ALIGN_CENTER
```
public static BBjNumber ALIGN_CENTER
```
    Constant specifying that the DashboardWidget's title should be aligned in the center. @since BBj 16.20
  - ALIGN_RIGHT
```
public static BBjNumber ALIGN_RIGHT
```
    Constant specifying that the DashboardWidget's title should be aligned right. @since BBj 16.20
  - BAR_CHART_WIDGET_TYPE
```
public static BBjNumber BAR_CHART_WIDGET_TYPE
```
    Bar chart widget type constant
  - PIE_CHART_WIDGET_TYPE
```
public static BBjNumber PIE_CHART_WIDGET_TYPE
```
    Pie chart widget type constant
  - LINE_CHART_WIDGET_TYPE
```
public static BBjNumber LINE_CHART_WIDGET_TYPE
```
    Line chart widget type constant
  - AREA_CHART_WIDGET_TYPE
```
public static BBjNumber AREA_CHART_WIDGET_TYPE
```
    Area chart widget type constant
  - RING_CHART_WIDGET_TYPE
```
public static BBjNumber RING_CHART_WIDGET_TYPE
```
    Ring chart widget type constant
  - XY_CHART_WIDGET_TYPE
```
public static BBjNumber XY_CHART_WIDGET_TYPE
```
    XY chart widget type constant
  - STACKED_BAR_CHART_WIDGET_TYPE
```
public static BBjNumber STACKED_BAR_CHART_WIDGET_TYPE
```
    Stacked Bar chart widget type constant
  - STACKED_PERCENTAGE_BAR_CHART_WIDGET_TYPE
```
public static BBjNumber STACKED_PERCENTAGE_BAR_CHART_WIDGET_TYPE
```
    Stacked Percentage Bar chart widget type constant
  - STACKED_AREA_CHART_WIDGET_TYPE
```
public static BBjNumber STACKED_AREA_CHART_WIDGET_TYPE
```
    Stacked area chart widget type constant
  - HTML_VIEW_WIDGET_TYPE
```
public static BBjNumber HTML_VIEW_WIDGET_TYPE
```
    HTML View chart widget type constant
  - IMAGE_WIDGET_TYPE
```
public static BBjNumber IMAGE_WIDGET_TYPE
```
    Image widget type constant
  - GRID_WIDGET_TYPE
```
public static BBjNumber GRID_WIDGET_TYPE
```
    Grid widget type constant
  - JASPER_VIEWER_WIDGET_TYPE
```
public static BBjNumber JASPER_VIEWER_WIDGET_TYPE
```
    Jasper Viewer widget type constant
  - CUSTOM_WIDGET_TYPE
```
public static BBjNumber CUSTOM_WIDGET_TYPE
```
    Custom widget type constant
  - GRIDEX_WIDGET_TYPE
```
public static BBjNumber GRIDEX_WIDGET_TYPE
```
    JGridEx widget type constant
- Constructor Detail
  - DashboardWidget
```
public DashboardWidget(Widget p_widget!)
```
    Constructs a DashboardWidget
    
    Parameters:
    
    p_widget! - Widget that will be encapsulated by this DashboardWidget
  - DashboardWidget
```
public DashboardWidget(DashboardCategory p_dashboardCategory!,
Widget p_widget!)
```
    Constructs a DashboardWidget
    
    Parameters:
    
    p_dashboardCategory! - Category of the widget that will be encapsulated by this DashboardWidget
    
    p_widget! - Widget that will be encapsulated by this DashboardWidget
- Method Detail
  - clone
```
public DashboardWidget clone()
```
    Clones the DashboardWidget
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    Returns a new cloned DashboardWidget
  - setActive
```
public void setActive(BBjNumber p_active)
```
    Sets the status to active or inactive
    
    Parameters:
    
    p_active - Specify 1 for active and 0 for inactive
  - setSelected
```
public void setSelected(BBjNumber p_selected)
```
    Sets the DashboardWidget to be selected or deselected
    
    Parameters:
    
    p_selected - Specify 1 for selected and 0 for deselected
  - setPopoutEnabled
```
public void setPopoutEnabled(BBjNumber p_popoutEnabled)
```
    Sets the popout enabled or disabled
    
    Parameters:
    
    p_popoutEnabled - Specify 1 for enabled and 0 for disabled
  - setOptionsEnabled
```
public void setOptionsEnabled(BBjNumber p_optionsEnabled)
```
    Sets the options enabled or disabled
    
    Parameters:
    
    p_optionsEnabled - Specify 1 for enabled and 0 for disabled
  - setSaveEnabled
```
public void setSaveEnabled(BBjNumber p_saveEnabled)
```
    Sets the save enabled or disabled
    
    Parameters:
    
    p_saveEnabled - Specify 1 for enabled and 0 for disabled
  - setEmailEnabled
```
public void setEmailEnabled(BBjNumber p_emailEnabled)
```
    Sets the email enabled or disabled
    
    Parameters:
    
    p_emailEnabled - Specify 1 for enabled and 0 for disabled
  - setViewDataEnabled
```
public void setViewDataEnabled(BBjNumber p_viewDataEnabled)
```
    Sets the view data enabled or disabled
    
    Parameters:
    
    p_viewDataEnabled - Specify 1 for enabled and 0 for disabled
  - setExportDataEnabled
```
public void setExportDataEnabled(BBjNumber p_exportDataEnabled)
```
    Sets the export data enabled or disabled
    
    Parameters:
    
    p_exportDataEnabled - Specify 1 for enabled and 0 for disabled
  - setRefreshEnabled
```
public void setRefreshEnabled(BBjNumber p_refreshEnabled)
```
    Sets the refresh enabled or disabled
    
    Parameters:
    
    p_refreshEnabled - Specify 1 for enabled and 0 for disabled
  - setAutoRefreshEnabled
```
public void setAutoRefreshEnabled(BBjNumber p_autoRefreshEnabled)
```
    Sets the auto refresh enabled or disabled
    
    Parameters:
    
    p_autoRefreshEnabled - Specify 1 for enabled and 0 for disabled
  - setCloseEnabled
```
public void setCloseEnabled(BBjNumber p_closeEnabled)
```
    Sets the close enabled or disabled
    
    Parameters:
    
    p_closeEnabled - Specify 1 for enabled and 0 for disabled
  - setAutoRefreshRate
```
public void setAutoRefreshRate(BBjNumber p_autoRefreshRate)
```
    Sets the auto refresh rate
    
    Parameters:
    
    p_autoRefreshRate - Number of seconds for the auto refresh interval. Must be between 1 and 999
  - setAutoRefreshUnit
```
public void setAutoRefreshUnit(BBjNumber p_autoRefreshUnit)
```
    Sets the auto refresh unit
    
    Parameters:
    
    p_autoRefreshUnit - Unit for refresh interval, can be one of the following constants: AutoRefreshUnit.getSECONDS(), AutoRefreshUnit.getMINUTES(), AutoRefreshUnit.getHOURS()
  - isActive
```
public BBjNumber isActive()
```
    Returns that active status
    
    Returns:
    
    Returns 1 for active and 0 for inactive
  - isSelected
```
public BBjNumber isSelected()
```
    Returns that selected status
    
    Returns:
    
    Returns 1 for selected and 0 for deselected
  - isPopoutEnabled
```
public BBjNumber isPopoutEnabled()
```
    Returns if the poput is enabled or disabled
    
    Returns:
    
    Returns 1 for enabled and 0 for disabled
  - isOptionsEnabled
```
public BBjNumber isOptionsEnabled()
```
    Returns if the options is enabled or disabled
    
    Returns:
    
    Returns 1 for enabled and 0 for disabled
  - isSaveEnabled
```
public BBjNumber isSaveEnabled()
```
    Returns if save is enabled or disabled
    
    Returns:
    
    Returns 1 for enabled and 0 for disabled
  - isEmailEnabled
```
public BBjNumber isEmailEnabled()
```
    Returns if email is enabled or disabled
    
    Returns:
    
    Returns 1 for enabled and 0 for disabled
  - isViewDataEnabled
```
public BBjNumber isViewDataEnabled()
```
    Returns if view data is enabled or disabled
    
    Returns:
    
    Returns 1 for enabled and 0 for disabled
  - isExportDataEnabled
```
public BBjNumber isExportDataEnabled()
```
    Returns if export data is enabled or disabled
    
    Returns:
    
    Returns 1 for enabled and 0 for disabled
  - isRefreshEnabled
```
public BBjNumber isRefreshEnabled()
```
    Returns if refresh is enabled or disabled
    
    Returns:
    
    Returns 1 for enabled and 0 for disabled
  - isAutoRefreshEnabled
```
public BBjNumber isAutoRefreshEnabled()
```
    Returns if auto refresh is enabled or disabled
    
    Returns:
    
    Returns 1 for enabled and 0 for disabled
  - isCloseEnabled
```
public BBjNumber isCloseEnabled()
```
    Returns if close is enabled or disabled
    
    Returns:
    
    Returns 1 for enabled and 0 for disabled
  - getAutoRefreshRate
```
public BBjNumber getAutoRefreshRate()
```
    Returns the auto refresh interval
    
    Returns:
    
    Returns the auto refresh interval in seconds
  - getAutoRefreshUnit
```
public BBjNumber getAutoRefreshUnit()
```
    Returns the auto refresh unit
    
    Returns:
    
    Returns the auto refresh unit, which will be one of the following constants: AutoRefreshUnit.getSECONDS(), AutoRefreshUnit.getMINUTES(), AutoRefreshUnit.getHOURS()
  - getAutoRefreshEnabled
```
public BBjNumber getAutoRefreshEnabled()
```
    Returns the auto refresh enabled state (1 for enabled and 0 for disabled)
    
    Returns:
    
    Returns the auto refresh enabled state (1 for enabled and 0 for disabled)
    
    Since:
    
    BBj 18.20
  - setPopoutSize
```
public void setPopoutSize(BBjNumber p_width,
BBjNumber p_height)
```
    Sets the desired size of the widget when it's popped out
    
    Parameters:
    
    p_width - The desired width of the popout
    
    p_height - The desired height of the popout
  - addFilter
```
public 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.
    
    Parameters:
    
    p_filterName$ - Unique name of the filter
    
    p_filterEntries! - BBjVector of filter values
    
    p_toolTip$ - Tool tip the filter
    
    p_dockLocation - Dock location of the filter. Values can be DashboardWidget.getDOCK_LEFT(), DashboardWidget.getDOCK_RIGHT()
    
    Returns:
    
    Returns the created DashboardWidgetFilter
  - addFilter
```
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.
    
    Parameters:
    
    p_filterName$ - Unique name of the filter
    
    p_filterEntries! - BBjVector of filter values
    
    p_toolTip$ - Tool tip the filter
    
    p_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()
    
    Returns:
    
    Returns the created DashboardWidgetFilter
    
    Since:
    
    BBj 16.00
  - addFilter
```
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.
    
    Parameters:
    
    p_filterName$ - Unique name of the filter
    
    p_filterEntries! - LinkedHashMap of filter keys/values
    
    p_toolTip$ - Tool tip the filter
    
    p_dockLocation - Dock location of the filter. Values can be DashboardWidget.getDOCK_LEFT() or DashboardWidget.getDOCK_RIGHT()
    
    Returns:
    
    Returns the created DashboardWidgetFilter
    
    See Also:
    
    LinkedHashMap documentation for more information on how to create and manipulate a LinkedHashMap object
  - addFilter
```
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.
    
    Parameters:
    
    p_filterName$ - Unique name of the filter
    
    p_filterEntries! - LinkedHashMap of filter keys/values
    
    p_toolTip$ - Tool tip the filter
    
    p_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()
    
    Returns:
    
    Returns the created DashboardWidgetFilter
    
    Since:
    
    BBj 16.00
    
    See Also:
    
    LinkedHashMap documentation for more information on how to create and manipulate a LinkedHashMap object
  - addLink
```
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.
    
    Parameters:
    
    p_url$ - URL of the link
    
    p_text$ - Text of the link
    
    p_toolTip$ - Tool tip for the link
    
    p_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 = Browse
    
    Returns:
    
    Returns the created DashboardWidgetLink
  - addMenu
```
public 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.
    
    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().
    
    Returns:
    
    Returns the created DashboardWidgetMenu
    
    Since:
    
    BBj 18.10
    
    See Also:
    
    BBjSysGui::addPopupMenu documentation to create the BBjPopupMenu parameter
  - setCallback
```
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
    - DashboardWidget::getON_WIDGET_CLICK()
    - DashboardWidget::getON_WIDGET_LEFT_CLICK()
    - DashboardWidget::getON_WIDGET_RIGHT_CLICK()
    - DashboardWidget::getON_WIDGET_REFRESH()
    - DashboardWidget::getON_WIDGET_SELECT()
    Parameters:
    
    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 triggered
  - setCallback
```
public 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
    - DashboardWidget::getON_WIDGET_CLICK()
    - DashboardWidget::getON_WIDGET_LEFT_CLICK()
    - DashboardWidget::getON_WIDGET_RIGHT_CLICK()
    - DashboardWidget::getON_WIDGET_REFRESH()
    - DashboardWidget::getON_WIDGET_SELECT()
    Parameters:
    
    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 triggered
    
    p_callbackRoutine! - Routine to call when the event is triggered
  - getWidget
```
public Widget getWidget()
```
    Returns the encapsulated widget
    
    Returns:
    
    Returns with Widget that is encapsulated
  - getDashboardWidgetFilterLeft
```
public DashboardWidgetFilter getDashboardWidgetFilterLeft()
```
    Returns the left dashboard widget filter
    
    Returns:
    
    Returns the left DashboardWidgetFilter
  - getDashboardWidgetFilterRight
```
public DashboardWidgetFilter getDashboardWidgetFilterRight()
```
    Returns the right dashboard widget filter
    
    Returns:
    
    Returns the right DashboardWidgetFilter
  - getDashboardWidgetLinkLeft
```
public DashboardWidgetLink getDashboardWidgetLinkLeft()
```
    Returns the left dashboard widget link
    
    Returns:
    
    Returns the left DashboardWidgetLink
  - getDashboardWidgetLinkRight
```
public DashboardWidgetLink getDashboardWidgetLinkRight()
```
    Returns the right dashboard widget link
    
    Returns:
    
    Returns the right DashboardWidgetLink
  - getDashboardWidgetMenu
```
public DashboardWidgetMenu getDashboardWidgetMenu(BBjNumber p_triggerType)
```
    Returns the custom popup menu associated with the dashboard widget given the menu trigger type
    
    Parameters:
    
    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().
    
    Returns:
    
    Returns the designated DashboardWidgetMenu
    
    Since:
    
    BBj 18.10
  - destroy
```
public void destroy()
```
    Destroys the DashboardWidget
  - isDestroyed
```
public BBjNumber isDestroyed()
```
    Returns if the widget is destroyed
    
    Returns:
    
    Returns 1 if destroyed, otherwise 0 is returned
  - getWidgetType
```
public BBjNumber getWidgetType()
```
    Returns the widget type
    
    Returns:
    
    The widget type
  - refresh
```
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.
    
    Since:
    
    BBj 17.00
  - setWidgetControl
```
public void setWidgetControl(WidgetControl p_WidgetControl!)
```
    Sets the WidgetControl (view) that's associated with the DashboardWidget (model)
    
    Parameters:
    
    The - WidgetControl for this DashboardWidget
    
    Since:
    
    BBj 17.00

Class DashboardWidget

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Dashboard.DashboardItem

Methods inherited from class java.lang.Object

Field Detail

DashboardCategory!

WidgetClickEventName!

WidgetClickCallbackObject!

WidgetClickCallbackRoutine!

WidgetLeftClickEventName!

WidgetLeftClickCallbackObject!

WidgetLeftClickCallbackRoutine!

WidgetRightClickEventName!

WidgetRightClickCallbackObject!

WidgetRightClickCallbackRoutine!

WidgetRefreshEventName!

WidgetRefreshCallbackObject!

WidgetRefreshCallbackRoutine!

WidgetSelectEventName!

WidgetSelectCallbackObject!

WidgetSelectCallbackRoutine!

PopoutWidgetWidth

PopoutWidgetHeight

TitlebarNameForeColor!

TitlebarNameFont!

TitlebarNameBackColor!

TitlebarNameSelectedBackColor!

TitlebarAlignment!

TitlebarDecorationBackColor!

TitlebarDecorationSelectedBackColor!

TitlebarSeparatorColor!

TitlebarSeparatorSelectedColor!

BorderColor!

BorderSelectedColor!

ImageList$

ImageListHiRes$

ClonedState

ON_WIDGET_REFRESH

ON_WIDGET_SELECT

ON_WIDGET_CLICK

ON_WIDGET_LEFT_CLICK

ON_WIDGET_RIGHT_CLICK

ON_POPUP_ITEM_SELECT

FILTER_TYPE_LISTBUTTON

FILTER_TYPE_LISTEDIT

FILTER_TYPE_EDITBOX

MENU_TRIGGER_LEFT_CLICK

MENU_TRIGGER_RIGHT_CLICK

MENU_TRIGGER_OPTIONS_CLICK

DOCK_LEFT

DOCK_RIGHT

ALIGN_LEFT

ALIGN_CENTER

ALIGN_RIGHT

BAR_CHART_WIDGET_TYPE

PIE_CHART_WIDGET_TYPE

LINE_CHART_WIDGET_TYPE

AREA_CHART_WIDGET_TYPE

RING_CHART_WIDGET_TYPE

XY_CHART_WIDGET_TYPE

STACKED_BAR_CHART_WIDGET_TYPE

STACKED_PERCENTAGE_BAR_CHART_WIDGET_TYPE

STACKED_AREA_CHART_WIDGET_TYPE

HTML_VIEW_WIDGET_TYPE

IMAGE_WIDGET_TYPE

GRID_WIDGET_TYPE

JASPER_VIEWER_WIDGET_TYPE

CUSTOM_WIDGET_TYPE

GRIDEX_WIDGET_TYPE

Constructor Detail

DashboardWidget

DashboardWidget

Method Detail

clone

setActive

setSelected

setPopoutEnabled

setOptionsEnabled