DashboardWindow

```
public class DashboardWindow
```
DashboardWindow UI class that displays a dashboard in a BBjTopLevelWindow

See Also:
[]

Field Summary

Fields
Modifier and Type	Field and Description
`static BBjString`	`DASHBOARD_EXIT_BUTTON_NAME$="dashboardExitButton"` Dashboard exit button name
`static BBjString`	`DASHBOARD_WINDOW_NAME$="dashboardWindow"` Dashboard window name
`BBjNumber`	`ExitMenuButtonWidth=80` Width of the exit button
`BBjNumber`	`MinHeight=400` Minimum height of the window
`BBjNumber`	`MinWidth=320` Minimum width of the window

Constructor Summary
Constructors
Constructor and Description
DashboardWindow(Dashboard p_dashboard!)
Constructs a DashboardWindow

Constructors
Constructor and Description
`DashboardWindow(Dashboard p_dashboard!)` Constructs a DashboardWindow

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`destroy()` Destroys the dashboard window
`void`	`doModal()` Shows the dashboard window modally, returns when the dashboard window is closed
`BBjColor`	`getBackColor()` Returns the background color of the dashboard window
`BBjControl`	`getBBjControl(BBjString p_controlName$)` Returns a dashboard window BBj control
`Dashboard`	`getDashboard()` Returns the encapsualted dashboard
`DashboardControl`	`getDashboardControl()` Returns the encapsualted dashboard control
`BBjString`	`getTitle()` Gets the dashboard window's title
`void`	`OnResize(BBjResizeEvent p_event!)` Called when the window is resized by the user
`void`	`OnResizeTimer(BBjTimerEvent p_event!)` Called when the resize timer is triggered
`void`	`setBackColor(BBjColor p_backColor!)` Sets the window background color
`void`	`setBuiBusyIndicatorText(BBjString p_BuiBusyIndicatorText$)` Sets the specified text to be displayed in the BUI BBjBusyIndicator when loading widgets into the DashboardCategory Note that this is a convenience method on the DashboardWindow to access the DashboardControl's related public field variables.
`void`	`setBusyText(BBjString p_busyText$)` Sets the specified text to be displayed when loading widgets into the DashboardCategory Note that this is a convenience method on the DashboardWindow to access the DashboardControl's setBusyText() method.
`void`	`setShowBuiBusyOnLoad(BBjNumber p_showBuiBusyOnLoad)` Sets whether to show a BUI BBjBusyIndicator when loading widgets into the DashboardCategory Note that this is a convenience method to access the DashboardControl's related public field variables.
`void`	`setSize(BBjNumber p_width, BBjNumber p_height)` Sets the window size
`void`	`setTitle(BBjString p_title$)` Sets the dashboard window's title
`void`	`setVisible(BBjNumber p_visible)` Sets the window visibility

Field Detail
- DASHBOARD_EXIT_BUTTON_NAME$="dashboardExitButton"
```
public static BBjString DASHBOARD_EXIT_BUTTON_NAME$="dashboardExitButton"
```
  Dashboard exit button name
- DASHBOARD_WINDOW_NAME$="dashboardWindow"
```
public static BBjString DASHBOARD_WINDOW_NAME$="dashboardWindow"
```
  Dashboard window name
- ExitMenuButtonWidth=80
```
public BBjNumber ExitMenuButtonWidth=80
```
  Width of the exit button
- MinHeight=400
```
public BBjNumber MinHeight=400
```
  Minimum height of the window
- MinWidth=320
```
public BBjNumber MinWidth=320
```
  Minimum width of the window

Constructor Detail
- DashboardWindow
```
public DashboardWindow(Dashboard p_dashboard!)
```
  Constructs a DashboardWindow
  
  Parameters:
  p_dashboard! Dashboard to display in the dashboard window

- Method Detail
  - destroy
```
public void destroy()
```
    Destroys the dashboard window
  - doModal
```
public void doModal()
```
    Shows the dashboard window modally, returns when the dashboard window is closed
  - getBackColor
```
public BBjColor getBackColor()
```
    Returns the background color of the dashboard window
    
    Returns:
    BBjColor that is the backgrond color of the dashboard window
  - 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
  - getDashboard
```
public Dashboard getDashboard()
```
    Returns the encapsualted dashboard
    
    Returns:
    Dashboard that is encapsulated in the DashboardWindow
  - getDashboardControl
```
public DashboardControl getDashboardControl()
```
    Returns the encapsualted dashboard control
    
    Returns:
    BBjControl found by name, otherwise null() is returned
  - getTitle
```
public BBjString getTitle()
```
    Gets the dashboard window's title
    
    Returns:
    A BBjString containing the dashboard window's title
    Since:
    BBj 17.11
  - OnResize
```
public void OnResize(BBjResizeEvent p_event!)
```
    Called when the window is resized by the user
    
    Parameters:
    p_event! BBjResizeEvent object
  - OnResizeTimer
```
public void OnResizeTimer(BBjTimerEvent p_event!)
```
    Called when the resize timer is triggered
    
    Parameters:
    p_event! BBjTimerEvent object
  - setBackColor
```
public void setBackColor(BBjColor p_backColor!)
```
    Sets the window background color
    
    Parameters:
    p_backColor! BBjColor that specifes the background color
  - setBuiBusyIndicatorText
```
public void setBuiBusyIndicatorText(BBjString p_BuiBusyIndicatorText$)
```
    Sets the specified text to be displayed in the BUI BBjBusyIndicator when loading widgets into the DashboardCategory
    
    Note that this is a convenience method on the DashboardWindow to access the DashboardControl's related public field variables.
    Parameters:
    p_BuiBusyIndicatorText$ A string indicating why the dashboard is busy. The default is "Creating Widgets".
    Since:
    BBj 16.20
  - setBusyText
```
public void setBusyText(BBjString p_busyText$)
```
    Sets the specified text to be displayed when loading widgets into the DashboardCategory
    
    Note that this is a convenience method on the DashboardWindow to access the DashboardControl's setBusyText() method.
    Parameters:
    p_busyText$ A string indicating why the dashboard is busy. The default is "Creating Widgets".
    Since:
    BBj 17.11
  - setShowBuiBusyOnLoad
```
public void setShowBuiBusyOnLoad(BBjNumber p_showBuiBusyOnLoad)
```
    Sets whether to show a BUI BBjBusyIndicator when loading widgets into the DashboardCategory
    
    Note that this is a convenience method to access the DashboardControl's related public field variables.
    Parameters:
    p_showBuiBusyOnLoad A number acting as a boolean that determines whether the associated DashboardControl should show the BUI BBjBusyIndicator when loading the widgets. The default is 0.
    Since:
    BBj 16.20
  - setSize
```
public void setSize(BBjNumber p_width, BBjNumber p_height)
```
    Sets the window size
    
    Parameters:
    p_width Width of the window
    p_height Height of the window
  - setTitle
```
public void setTitle(BBjString p_title$)
```
    Sets the dashboard window's title
    
    Parameters:
    p_title$ The new title for the dashboard window
    Since:
    BBj 17.11
  - setVisible
```
public void setVisible(BBjNumber p_visible)
```
    Sets the window visibility
    
    Parameters:
    p_visible Indicates the window visibility. 0=invisible, 1=visible

Class DashboardWindow

Field Summary

Constructor Summary

Method Summary

Field Detail

DASHBOARD_EXIT_BUTTON_NAME$="dashboardExitButton"

DASHBOARD_WINDOW_NAME$="dashboardWindow"

ExitMenuButtonWidth=80

MinHeight=400

MinWidth=320

Constructor Detail

DashboardWindow

Method Detail

destroy

doModal

getBackColor

getBBjControl

getDashboard

getDashboardControl

getTitle

OnResize

OnResizeTimer

setBackColor

setBuiBusyIndicatorText

setBusyText

setShowBuiBusyOnLoad

setSize

setTitle

setVisible