DashboardControl

java.lang.Object
- Dashboard.DashboardControl

```
public class DashboardControl
extends Object
```
UI class that displays a dashboard in a BBjChildWindow

Field Summary

Fields
Modifier and Type	Field and Description
`static BBjString`	`BUI_BUSY_INDICATOR_TEXT$` The text to display when displaying the BUI BBjBusyIndicator.
`static BBjString`	`CUSTOMIZE_CONTROL_BAR_BACKGROUND_NAME$` Customize control bar background name
`static BBjString`	`CUSTOMIZE_DONE_BUTTON_NAME$` Customize done button name
`static BBjString`	`CUSTOMIZE_PREVIEW_ADD_BUTTON_1_NAME$` Customize preview add button 1 name
`static BBjString`	`CUSTOMIZE_PREVIEW_HTMLVIEW_1_NAME$` Customize preview html view 1 name
`static BBjString`	`CUSTOMIZE_PREVIEW_IMAGE_1_NAME$` Customize preview image 1 name
`static BBjString`	`CUSTOMIZE_PREVIEW_NEXT_BUTTON_NAME$` Customize Next button name
`static BBjString`	`CUSTOMIZE_PREVIEW_PREV_BUTTON_NAME$` Customize Previous button name
`static BBjString`	`CUSTOMIZE_PREVIEW_STATUS_TEXT$` Customize status text
`static BBjString`	`CUSTOMIZE_PREVIEW_WIDGET_FONT_SCALING_CHECKBOX_NAME$` Customize preview Fixed Widget Size Checkbox
`static BBjString`	`CUSTOMIZE_PREVIEW_WIDGET_FONT_SCALING_SLIDER_NAME$` Customize preview widget window name
`static BBjString`	`CUSTOMIZE_PREVIEW_WIDGET_SIZE_CHECKBOX_NAME$` Customize preview Fixed Widget Size Checkbox
`static BBjString`	`CUSTOMIZE_PREVIEW_WIDGET_SIZE_SLIDER_NAME$` Customize preview widget window name
`static BBjString`	`CUSTOMIZE_PREVIEW_WIDGET_TITLE_NAME$` Customize preview widget title name
`static BBjString`	`CUSTOMIZE_PREVIEW_WIDGET_WINDOW_NAME$` Customize preview widget window name
`static BBjString`	`CUSTOMIZE_WINDOW_NAME$` Customize window name
`static BBjString`	`DASHBOARD_CONTROL_BUSY_TEXT$` The text to display when initializing the categories and widgets.
`static BBjString`	`DASHBOARD_CONTROL_CUSTOMIZE_BUTTON_NAME$` Dashboard control customize button name
`static BBjString`	`DASHBOARD_CONTROL_REFRESH_BUTTON_NAME$` Dashboard control refresh button name
`static BBjString`	`DASHBOARD_CONTROL_TAB_CTRL_NAME$` Dashboard control tab ctrl name
`static BBjString`	`DASHBOARD_CONTROL_TITLE_BAR_NAME$` Dashboard control title bar name
`static BBjString`	`DASHBOARD_CONTROL_TITLE_TEXT_NAME$` Dashboard control title text name
`static BBjString`	`DASHBOARD_CONTROL_TOOL_BAR_NAME$` Dashboard control tool bar name
`static BBjString`	`DASHBOARD_CONTROL_WINDOW_NAME$` Dashboard control window name
`static BBjString`	`DASHBOARD_GLASS_PANE_NAME$` Dashboard glass pane name
`BBjNumber`	`ShowBuiBusyOnLoad` A number acting as a boolean that determines whether the DashboardControl should show the BUI BBjBusyIndicator when loading the widgets.
`BBjNumber`	`TitleBarHeight` Height of the title bar
`BBjNumber`	`ToolBarHeight` Height of the tool bar

Constructor Summary

Constructors
Constructor and Description
`DashboardControl(Dashboard p_dashboard!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$)` Constructs a DashboardControl
`DashboardControl(Dashboard p_dashboard!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$, BBjNumber p_titleBar, BBjNumber p_toolBar)` Constructs a DashboardControl
`DashboardControl(Dashboard p_dashboard!, DashboardWindow p_dashboardWindow!, BBjWindow p_parentWindow!, BBjString p_flags$)` Constructs a DashboardControl

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()` Destroys the dashboard control
`void`	`enableRefreshButton()` Enables/Disables the refresh button
`BBjColor`	`getBackColor()` Returns the background color of the dashboard control
`BBjControl`	`getBBjControl(BBjString p_controlName$)` Returns a dashboard window BBj control
`Dashboard`	`getDashboard()` Returns the encapsualted dashboard
`DashboardCategoryControl`	`getDashboardCategoryControl(BBjString p_categoryName$)` Returns a dashboard category control given its unique name
`BBjChildWindow`	`getDashboardControlWindow()` Returns the window of the dashboard control
`DashboardWindow`	`getDashboardWindow()` Returns the dashboard window that houses the dashboard control
`BBjString`	`getName()` Returns the name of the widget control
`BBjChildWindow`	`getToolBar()` Returns the toolbar of the dashboard control
`HashMap`	`getWidgetAttributesHashMap()` Returns the widget attributes
`void`	`layout()` Lays out the widets in the currently selected category
`void`	`layoutAll()` Lays out the widets in all categories
`void`	`OnAddWidget(BBjToolButtonPushEvent p_event!)` Called when the Add Widget button is pushed in the Customize window, changing a widget's state from inactive to active
`void`	`OnColorThemeSelect(BBjListChangeEvent p_event!)` Called when the user selects a color theme from the Customize window
`void`	`OnCustomize(BBjButtonPushEvent p_event!)` Called when the customize button is pressed
`void`	`OnCustomizeDone(BBjSysGuiEvent p_event!)` Called when the Done tool button is pushed in the Customize window
`void`	`OnCustomizeNext(BBjSysGuiEvent p_event!)` Called when the Next tool button is pushed in the Customize window
`void`	`OnCustomizePrev(BBjSysGuiEvent p_event!)` Called when the Prev tool button is pushed in the Customize window
`void`	`OnCustomizeResize(BBjResizeEvent p_event!)` Called when the Customize window is resized.
`void`	`OnCustomizeResizeTimer(BBjTimerEvent p_event!)` Called when the resize timer is triggered
`void`	`OnDoNotUseWidgetFontScaling(BBjCheckOffEvent p_event!)` Called when the user chooses to use a dynamic widget size
`void`	`OnFontSelect(BBjListChangeEvent p_event!)` Called when the user selects a custom font from the Customize window
`void`	`OnPreviewScroll(BBjWindowScrollEvent p_event!)` Called when the preview window is scrolled in the Customize window
`void`	`OnRefresh(BBjButtonPushEvent p_event!)` Called when the Refresh tool button is pushed
`void`	`OnTabSelect(BBjTabSelectedEvent p_event!)` Called when a tab is selected
`void`	`OnUseDynamicWidgetSize(BBjCheckOffEvent p_event!)` Called when the user chooses to use a dynamic widget size
`void`	`OnUseFixedWidgetSize(BBjCheckOnEvent p_event!)` Called when the user chooses to use a fixed widget size
`void`	`OnUseWidgetFontScaling(BBjCheckOnEvent p_event!)` Called when the user chooses to use a fixed widget size
`void`	`OnWidgetFontScalingScroll(BBjControlScrollEvent p_event!)` Called when the user selects a custom font scaling factor from the Customize window
`void`	`OnWidgetSizeScroll(BBjControlScrollEvent p_event!)` Called when the user selects a color theme from the Customize window
`void`	`refresh()` Refreshes the widgets in the currently selected category
`void`	`refreshAll()` Refreshes the widgets in all categories
`void`	`removeDashboardCategoryControl(BBjString p_categoryName$)` Remove a dashboard category control
`void`	`setBackColor(BBjColor p_backColor!)` Sets the background color of the dashboard control
`void`	`setBusyText(BBjString p_busyText$)` Sets the specified text to be displayed when loading widgets into the DashboardCategory
`void`	`setGlassPaneVisible(BBjNumber p_visible)` Called when the visibiliy of the glass pane
`void`	`setSize(BBjNumber p_width, BBjNumber p_height)` Sets the control size
`void`	`setTitle(BBjString p_title$)` Sets the title of the dashboard control
`void`	`setVisible(BBjNumber p_visible)` Sets the control visibility
`void`	`storeWidgetProps()` Stores the properties of all DashboardCategories and Widgets in the current Dashboard

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

- Field Detail
  - TitleBarHeight
```
public BBjNumber TitleBarHeight
```
    Height of the title bar
  - ToolBarHeight
```
public BBjNumber ToolBarHeight
```
    Height of the tool bar
  - DASHBOARD_CONTROL_WINDOW_NAME$
```
public static BBjString DASHBOARD_CONTROL_WINDOW_NAME$
```
    Dashboard control window name
  - DASHBOARD_CONTROL_TAB_CTRL_NAME$
```
public static BBjString DASHBOARD_CONTROL_TAB_CTRL_NAME$
```
    Dashboard control tab ctrl name
  - DASHBOARD_CONTROL_TITLE_BAR_NAME$
```
public static BBjString DASHBOARD_CONTROL_TITLE_BAR_NAME$
```
    Dashboard control title bar name
  - DASHBOARD_CONTROL_TITLE_TEXT_NAME$
```
public static BBjString DASHBOARD_CONTROL_TITLE_TEXT_NAME$
```
    Dashboard control title text name
  - DASHBOARD_CONTROL_TOOL_BAR_NAME$
```
public static BBjString DASHBOARD_CONTROL_TOOL_BAR_NAME$
```
    Dashboard control tool bar name
  - DASHBOARD_CONTROL_CUSTOMIZE_BUTTON_NAME$
```
public static BBjString DASHBOARD_CONTROL_CUSTOMIZE_BUTTON_NAME$
```
    Dashboard control customize button name
  - DASHBOARD_CONTROL_REFRESH_BUTTON_NAME$
```
public static BBjString DASHBOARD_CONTROL_REFRESH_BUTTON_NAME$
```
    Dashboard control refresh button name
  - DASHBOARD_GLASS_PANE_NAME$
```
public static BBjString DASHBOARD_GLASS_PANE_NAME$
```
    Dashboard glass pane name
  - CUSTOMIZE_PREVIEW_STATUS_TEXT$
```
public static BBjString CUSTOMIZE_PREVIEW_STATUS_TEXT$
```
    Customize status text
  - CUSTOMIZE_PREVIEW_PREV_BUTTON_NAME$
```
public static BBjString CUSTOMIZE_PREVIEW_PREV_BUTTON_NAME$
```
    Customize Previous button name
  - CUSTOMIZE_PREVIEW_NEXT_BUTTON_NAME$
```
public static BBjString CUSTOMIZE_PREVIEW_NEXT_BUTTON_NAME$
```
    Customize Next button name
  - DASHBOARD_CONTROL_BUSY_TEXT$
```
public static BBjString DASHBOARD_CONTROL_BUSY_TEXT$
```
    The text to display when initializing the categories and widgets. @since BBj 17.11
  - CUSTOMIZE_WINDOW_NAME$
```
public static BBjString CUSTOMIZE_WINDOW_NAME$
```
    Customize window name
  - CUSTOMIZE_CONTROL_BAR_BACKGROUND_NAME$
```
public static BBjString CUSTOMIZE_CONTROL_BAR_BACKGROUND_NAME$
```
    Customize control bar background name
  - CUSTOMIZE_DONE_BUTTON_NAME$
```
public static BBjString CUSTOMIZE_DONE_BUTTON_NAME$
```
    Customize done button name
  - CUSTOMIZE_PREVIEW_HTMLVIEW_1_NAME$
```
public static BBjString CUSTOMIZE_PREVIEW_HTMLVIEW_1_NAME$
```
    Customize preview html view 1 name
  - CUSTOMIZE_PREVIEW_IMAGE_1_NAME$
```
public static BBjString CUSTOMIZE_PREVIEW_IMAGE_1_NAME$
```
    Customize preview image 1 name
  - CUSTOMIZE_PREVIEW_ADD_BUTTON_1_NAME$
```
public static BBjString CUSTOMIZE_PREVIEW_ADD_BUTTON_1_NAME$
```
    Customize preview add button 1 name
  - CUSTOMIZE_PREVIEW_WIDGET_TITLE_NAME$
```
public static BBjString CUSTOMIZE_PREVIEW_WIDGET_TITLE_NAME$
```
    Customize preview widget title name
  - CUSTOMIZE_PREVIEW_WIDGET_WINDOW_NAME$
```
public static BBjString CUSTOMIZE_PREVIEW_WIDGET_WINDOW_NAME$
```
    Customize preview widget window name
  - CUSTOMIZE_PREVIEW_WIDGET_SIZE_SLIDER_NAME$
```
public static BBjString CUSTOMIZE_PREVIEW_WIDGET_SIZE_SLIDER_NAME$
```
    Customize preview widget window name
  - CUSTOMIZE_PREVIEW_WIDGET_FONT_SCALING_SLIDER_NAME$
```
public static BBjString CUSTOMIZE_PREVIEW_WIDGET_FONT_SCALING_SLIDER_NAME$
```
    Customize preview widget window name
  - CUSTOMIZE_PREVIEW_WIDGET_SIZE_CHECKBOX_NAME$
```
public static BBjString CUSTOMIZE_PREVIEW_WIDGET_SIZE_CHECKBOX_NAME$
```
    Customize preview Fixed Widget Size Checkbox
  - CUSTOMIZE_PREVIEW_WIDGET_FONT_SCALING_CHECKBOX_NAME$
```
public static BBjString CUSTOMIZE_PREVIEW_WIDGET_FONT_SCALING_CHECKBOX_NAME$
```
    Customize preview Fixed Widget Size Checkbox
  - ShowBuiBusyOnLoad
```
public BBjNumber ShowBuiBusyOnLoad
```
    A number acting as a boolean that determines whether the DashboardControl should show the BUI BBjBusyIndicator when loading the widgets. @since BBj 16.20
  - BUI_BUSY_INDICATOR_TEXT$
```
public static BBjString BUI_BUSY_INDICATOR_TEXT$
```
    The text to display when displaying the BUI BBjBusyIndicator. @since BBj 16.20
- Constructor Detail
  - DashboardControl
```
public DashboardControl(Dashboard p_dashboard!,
DashboardWindow p_dashboardWindow!,
BBjWindow p_parentWindow!,
BBjString p_flags$)
```
    Constructs a DashboardControl
    
    Parameters:
    
    p_dashboard! - Dashboard to display in the dashboard control
    
    p_dashboardWindow! - Parent dashboard window
    
    p_parentWindow! - Parent window of the control
    
    p_flags$ - Flags that affect behavior and appearance of the control
    
    See Also:
    
    BBjWindow::addChildWindow for the list of valid flag options
  - DashboardControl
```
public DashboardControl(Dashboard p_dashboard!,
BBjWindow p_parentWindow!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_flags$)
```
    Constructs a DashboardControl
    
    Parameters:
    
    p_dashboard! - Dashboard to display in the dashboard control
    
    p_parentWindow! - Parent window of the control
    
    p_x - X location of the control
    
    p_y - Y location of the control
    
    p_width - Width of the control
    
    p_height - Height of the control
    
    p_flags$ - Flags that affect behavior and appearance of the control
    
    See Also:
    
    BBjWindow::addChildWindow for the list of valid flag options
  - DashboardControl
```
public DashboardControl(Dashboard p_dashboard!,
BBjWindow p_parentWindow!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_flags$,
BBjNumber p_titleBar,
BBjNumber p_toolBar)
```
    Constructs a DashboardControl
    
    Parameters:
    
    p_dashboard! - Dashboard to display in the dashboard control
    
    p_parentWindow! - Parent window of the control
    
    p_x - X location of the control
    
    p_y - Y location of the control
    
    p_width - Width of the control
    
    p_height - Height of the control
    
    p_flags$ - Flags that affect behavior and appearance of the control
    
    p_titleBar - Indicates if the the control should include title bar, 0 = No title bar, 1 = Title bar
    
    p_toolBar - Indicates if the the control should include tool bar, 0 = No tool bar, 1 = Tool bar
    
    See Also:
    
    BBjWindow::addChildWindow for the list of valid flag options
- Method Detail
  - storeWidgetProps
```
public void storeWidgetProps()
```
    Stores the properties of all DashboardCategories and Widgets in the current Dashboard
  - setVisible
```
public void setVisible(BBjNumber p_visible)
```
    Sets the control visibility
    
    Parameters:
    
    p_visible - Indicates the conrol visibility. 0 = invisible, 1 = visible
  - setSize
```
public void setSize(BBjNumber p_width,
BBjNumber p_height)
```
    Sets the control size
    
    Parameters:
    
    p_width - Width of the control
    
    p_height - Height of the control
  - setTitle
```
public void setTitle(BBjString p_title$)
```
    Sets the title of the dashboard control
    
    Parameters:
    
    p_title$ - Title of the dashboard control
  - OnTabSelect
```
public void OnTabSelect(BBjTabSelectedEvent p_event!)
```
    Called when a tab is selected
    
    Parameters:
    
    p_event! - BBjTabSelectedEvent which contains event information
  - layout
```
public void layout()
```
    Lays out the widets in the currently selected category
  - layoutAll
```
public void layoutAll()
```
    Lays out the widets in all categories
  - refresh
```
public void refresh()
```
    Refreshes the widgets in the currently selected category
  - refreshAll
```
public void refreshAll()
```
    Refreshes the widgets in all categories
  - enableRefreshButton
```
public void enableRefreshButton()
```
    Enables/Disables the refresh button
  - getName
```
public BBjString getName()
```
    Returns the name of the widget control
    
    Returns:
    
    Name of the widget control
  - getDashboard
```
public Dashboard getDashboard()
```
    Returns the encapsualted dashboard
    
    Returns:
    
    Dashboard that is encapsulated in the DashboardControl
  - getWidgetAttributesHashMap
```
public HashMap getWidgetAttributesHashMap()
```
    Returns the widget attributes
    
    Returns:
    
    HashMap containg the widget attributes
  - getDashboardControlWindow
```
public BBjChildWindow getDashboardControlWindow()
```
    Returns the window of the dashboard control
    
    Returns:
    
    BBjChildWindow which is the window for the dashboard control
  - getToolBar
```
public BBjChildWindow getToolBar()
```
    Returns the toolbar of the dashboard control
    
    Returns:
    
    BBjChildWindow which is the toolbar for the dashboard control
  - getDashboardWindow
```
public DashboardWindow getDashboardWindow()
```
    Returns the dashboard window that houses the dashboard control
    
    Returns:
    
    DashboardWindow which houses the dashboard control
  - setBackColor
```
public void setBackColor(BBjColor p_backColor!)
```
    Sets the background color of the dashboard control
    
    Parameters:
    
    p_backColor! - BBjColor that specifies the desired background color for the dashboard control
  - getBackColor
```
public BBjColor getBackColor()
```
    Returns the background color of the dashboard control
    
    Returns:
    
    BBjColor that specifies the background color of the dashboard control
  - removeDashboardCategoryControl
```
public void removeDashboardCategoryControl(BBjString p_categoryName$)
```
    Remove a dashboard category control
    
    Parameters:
    
    p_categoryName$ - Name of the category control to remove
  - getDashboardCategoryControl
```
public DashboardCategoryControl getDashboardCategoryControl(BBjString p_categoryName$)
```
    Returns a dashboard category control given its unique name
    
    Parameters:
    
    p_categoryName$ - Name of the category control to obtain
    
    Returns:
    
    DashboardCategoryControl associated with the passed name or null() if not found
  - OnWidgetSizeScroll
```
public void OnWidgetSizeScroll(BBjControlScrollEvent p_event!)
```
    Called when the user selects a color theme from the Customize window
    
    Parameters:
    
    p_event! - BBjListChangeEvent which contains event information
  - OnUseFixedWidgetSize
```
public void OnUseFixedWidgetSize(BBjCheckOnEvent p_event!)
```
    Called when the user chooses to use a fixed widget size
    
    Parameters:
    
    p_event! - BBjCheckOnEvent which contains event information
  - OnUseDynamicWidgetSize
```
public void OnUseDynamicWidgetSize(BBjCheckOffEvent p_event!)
```
    Called when the user chooses to use a dynamic widget size
    
    Parameters:
    
    p_event! - BBjCheckOffEvent which contains event information
  - OnUseWidgetFontScaling
```
public void OnUseWidgetFontScaling(BBjCheckOnEvent p_event!)
```
    Called when the user chooses to use a fixed widget size
    
    Parameters:
    
    p_event! - BBjCheckOnEvent which contains event information
  - OnDoNotUseWidgetFontScaling
```
public void OnDoNotUseWidgetFontScaling(BBjCheckOffEvent p_event!)
```
    Called when the user chooses to use a dynamic widget size
    
    Parameters:
    
    p_event! - BBjCheckOffEvent which contains event information
  - OnColorThemeSelect
```
public void OnColorThemeSelect(BBjListChangeEvent p_event!)
```
    Called when the user selects a color theme from the Customize window
    
    Parameters:
    
    p_event! - BBjListChangeEvent which contains event information
  - OnFontSelect
```
public void OnFontSelect(BBjListChangeEvent p_event!)
```
    Called when the user selects a custom font from the Customize window
    
    Parameters:
    
    p_event! - BBjListChangeEvent which contains event information
  - OnWidgetFontScalingScroll
```
public void OnWidgetFontScalingScroll(BBjControlScrollEvent p_event!)
```
    Called when the user selects a custom font scaling factor from the Customize window
    
    Parameters:
    
    p_event! - BBjControlScrollEvent which contains event information
  - OnCustomize
```
public void OnCustomize(BBjButtonPushEvent p_event!)
```
    Called when the customize button is pressed
    
    Parameters:
    
    p_event! - BBjButtonPushEvent which contains event information
  - setGlassPaneVisible
```
public void setGlassPaneVisible(BBjNumber p_visible)
```
    Called when the visibiliy of the glass pane
    
    Parameters:
    
    p_visible - Indicates the visibility of the glass pane. O = invisible, 1 = visible
  - setBusyText
```
public void setBusyText(BBjString p_busyText$)
```
    Sets the specified text to be displayed when loading widgets into the DashboardCategory
    
    Parameters:
    
    p_busyText$ - A string indicating why the dashboard is busy. The default is "Creating Widgets".
    
    Since:
    
    BBj 17.11
  - OnAddWidget
```
public void OnAddWidget(BBjToolButtonPushEvent p_event!)
```
    Called when the Add Widget button is pushed in the Customize window, changing a widget's state from inactive to active
    
    Parameters:
    
    p_event! - BBjToolButtonPushEvent which contains event information
  - OnPreviewScroll
```
public void OnPreviewScroll(BBjWindowScrollEvent p_event!)
```
    Called when the preview window is scrolled in the Customize window
    
    Parameters:
    
    p_event! - BBjWindowScrollEvent which contains event information
  - OnCustomizePrev
```
public void OnCustomizePrev(BBjSysGuiEvent p_event!)
```
    Called when the Prev tool button is pushed in the Customize window
    
    Parameters:
    
    p_event! - BBjToolButtonPushEvent which contains event information
  - OnCustomizeNext
```
public void OnCustomizeNext(BBjSysGuiEvent p_event!)
```
    Called when the Next tool button is pushed in the Customize window
    
    Parameters:
    
    p_event! - BBjToolButtonPushEvent which contains event information
  - OnCustomizeDone
```
public void OnCustomizeDone(BBjSysGuiEvent p_event!)
```
    Called when the Done tool button is pushed in the Customize window
    
    Parameters:
    
    p_event! - BBjToolButtonPushEvent which contains event information
  - OnCustomizeResize
```
public void OnCustomizeResize(BBjResizeEvent p_event!)
```
    Called when the Customize window is resized.
    
    Parameters:
    
    p_event! - BBjResizeEvent which contains event information
  - OnCustomizeResizeTimer
```
public void OnCustomizeResizeTimer(BBjTimerEvent p_event!)
```
    Called when the resize timer is triggered
    
    Parameters:
    
    p_event! - BBjTimerEvent object
  - OnRefresh
```
public void OnRefresh(BBjButtonPushEvent p_event!)
```
    Called when the Refresh tool button is pushed
    
    Parameters:
    
    p_event! - BBjToolButtonPushEvent which contains event information
  - destroy
```
public void destroy()
```
    Destroys the dashboard control
  - getBBjControl
```
public BBjControl getBBjControl(BBjString p_controlName$)
```
    Returns a dashboard window BBj control
    
    Parameters:
    
    p_controlName$ - Unique name of the control to retrieve
    
    Returns:
    
    BBjControl found by name, otherwise null() is returned

Class DashboardControl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TitleBarHeight

ToolBarHeight

DASHBOARD_CONTROL_WINDOW_NAME$

DASHBOARD_CONTROL_TAB_CTRL_NAME$

DASHBOARD_CONTROL_TITLE_BAR_NAME$

DASHBOARD_CONTROL_TITLE_TEXT_NAME$

DASHBOARD_CONTROL_TOOL_BAR_NAME$

DASHBOARD_CONTROL_CUSTOMIZE_BUTTON_NAME$

DASHBOARD_CONTROL_REFRESH_BUTTON_NAME$

DASHBOARD_GLASS_PANE_NAME$

CUSTOMIZE_PREVIEW_STATUS_TEXT$

CUSTOMIZE_PREVIEW_PREV_BUTTON_NAME$

CUSTOMIZE_PREVIEW_NEXT_BUTTON_NAME$

DASHBOARD_CONTROL_BUSY_TEXT$

CUSTOMIZE_WINDOW_NAME$

CUSTOMIZE_CONTROL_BAR_BACKGROUND_NAME$

CUSTOMIZE_DONE_BUTTON_NAME$

CUSTOMIZE_PREVIEW_HTMLVIEW_1_NAME$

CUSTOMIZE_PREVIEW_IMAGE_1_NAME$

CUSTOMIZE_PREVIEW_ADD_BUTTON_1_NAME$

CUSTOMIZE_PREVIEW_WIDGET_TITLE_NAME$

CUSTOMIZE_PREVIEW_WIDGET_WINDOW_NAME$

CUSTOMIZE_PREVIEW_WIDGET_SIZE_SLIDER_NAME$

CUSTOMIZE_PREVIEW_WIDGET_FONT_SCALING_SLIDER_NAME$

CUSTOMIZE_PREVIEW_WIDGET_SIZE_CHECKBOX_NAME$

CUSTOMIZE_PREVIEW_WIDGET_FONT_SCALING_CHECKBOX_NAME$

ShowBuiBusyOnLoad

BUI_BUSY_INDICATOR_TEXT$

Constructor Detail

DashboardControl

DashboardControl

DashboardControl

Method Detail

storeWidgetProps

setVisible

setSize

setTitle

OnTabSelect

layout

layoutAll

refresh

refreshAll

enableRefreshButton

getName

getDashboard

getWidgetAttributesHashMap

getDashboardControlWindow

getToolBar

getDashboardWindow

setBackColor

getBackColor

removeDashboardCategoryControl

getDashboardCategoryControl

OnWidgetSizeScroll

OnUseFixedWidgetSize

OnUseDynamicWidgetSize

OnUseWidgetFontScaling

OnDoNotUseWidgetFontScaling

OnColorThemeSelect

OnFontSelect

OnWidgetFontScalingScroll

OnCustomize

setGlassPaneVisible

setBusyText

OnAddWidget

OnPreviewScroll

OnCustomizePrev

OnCustomizeNext

OnCustomizeDone

OnCustomizeResize

OnCustomizeResizeTimer

OnRefresh

destroy

getBBjControl