DashboardCategoryControl

java.lang.Object
- Dashboard.DashboardCategoryControl

Direct Known Subclasses:

EmbeddedWidgetSetControl
```
public class DashboardCategoryControl
extends Object
```
UI class that displays a dashboard category

Field Summary

Fields
Modifier and Type	Field and Description
`static BBjString`	`DASHBOARD_CATEGORY_CONTROL_TITLE_BAR_NAME$` Dashboard category control title bar name
`static BBjString`	`DASHBOARD_CATEGORY_CONTROL_TITLE_TEXT_NAME$` Dashboard category control title text name
`static BBjString`	`DASHBOARD_CATEGORY_WINDOW_NAME$` Dashboard category window name
`BBjString`	`Title$` Title of the dashboard category control
`BBjVector`	`WidgetMidpointsVector!` BBjVector containing the midpoints for the widgets

Constructor Summary

Constructors
Constructor and Description
`DashboardCategoryControl(DashboardCategory p_dashboardCategory!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$)` Constructs a DashboardCategoryControl
`DashboardCategoryControl(DashboardCategory p_dashboardCategory!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$, BBjNumber p_titleBar)` Constructs a DashboardCategoryControl
`DashboardCategoryControl(DashboardCategory p_dashboardCategory!, DashboardControl p_dashboardControl!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$)` Constructs a DashboardCategoryControl

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activateWidget(DashboardWidgetControl p_dashboardWidgetControl!, BBjNumber p_activate)` Sets the active dashboard widget control that is part of the dashboard category control
`void`	`deselectWidgetControl()` Deselects the current widget control
`void`	`destroy()` Destroys the dashboard category control
`BBjNumber`	`getActiveDashboardWidgetControlPosition(BBjString p_widgetName$)` Returns the current position of an active dashboard widget control that is part of the dashboard category control
`BBjVector`	`getActiveDashboardWidgetControls()` Returns the active dashboard widget controls in the dashboard category control
`BBjColor`	`getBackColor()` Returns the background color of the dashboard category control
`BBjControl`	`getBBjControl(BBjString p_controlName$)` Returns a BBj control give a name
`DashboardCategory`	`getDashboardCategory()` Returns the encapuslated dashboard category used in the dashboard category control
`BBjChildWindow`	`getDashboardCategoryWindow()` Returns the window of the dashboard category control
`DashboardControl`	`getDashboardControl()` Returns the dashboard control that this dashboard category control is a part of
`DashboardWidgetControl`	`getDashboardWidgetControl(BBjString p_widgetName$)` Returns a dashboard widget control
`BBjVector`	`getDashboardWidgetControls()` Returns the dashboard widget controls in the dashboard category control
`BBjNumber`	`getInactiveDashboardWidgetControlPosition(BBjString p_widgetName$)` Returns the current position of an inactive dashboard widget control that is part of the dashboard category control
`BBjVector`	`getInactiveDashboardWidgetControls()` Returns the inactive dashboard widget controls in the dashboard category control
`BBjString`	`getName()` Returns the name of the dashboard category control
`BBjNumber`	`getNumActiveDashboardWidgetControls()` Returns the number of active dashboard widget controls in the dashboard category control
`BBjNumber`	`getNumDashboardWidgetControls()` Returns the number of dashboard widget controls in the dashboard category control
`BBjNumber`	`getNumInactiveDashboardWidgetControls()` Returns the number of inactive dashboard widget controls in the dashboard category control
`void`	`layoutWidgets()` Laysout the widget contained in the dashboard category control
`void`	`OnWidgetSelect(BBjCustomEvent p_event!)` Called when a widget is selected
`void`	`refresh()` Refreshes the control
`void`	`removeDashboardWidgetControl(BBjString p_widgetName$)` An internal method that removes a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object's unique name
`void`	`removeDashboardWidgetControl(DashboardWidgetControl p_dashboardWidgetControl!)` An internal method that removes a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object
`void`	`repositionDashboardWidgetControl(BBjString p_widgetName$)` An internal method that repositions a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object's unique name
`void`	`repositionDashboardWidgetControl(BBjString p_widgetName$, BBjNumber p_destPosition)` An internal method that repositions a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object's unique name and a destination position
`void`	`repositionDashboardWidgetControl(DashboardWidgetControl p_dashboardWidgetControl!)` An internal method that repositions a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object
`void`	`repositionDashboardWidgetControl(DashboardWidgetControl p_dashboardWidgetControl!, BBjNumber p_destPosition)` An internal method that repositions a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object and a destination position
`void`	`resetContainerHeight()` Resets the container height based on widget height, number of rows, and row spacing
`void`	`setBackColor(BBjColor p_backColor!)` Sets the background color of the dashboard category control
`void`	`setSize(BBjNumber p_width, BBjNumber p_height)` Sets the size of the dashboard category control
`void`	`setTitle(BBjString p_title$)` Sets the title of the dashboard category control
`void`	`setVisible(BBjNumber p_visible)` Sets the control visibility

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

- Field Detail
  - WidgetMidpointsVector!
```
public BBjVector WidgetMidpointsVector!
```
    BBjVector containing the midpoints for the widgets
  - Title$
```
public BBjString Title$
```
    Title of the dashboard category control
  - DASHBOARD_CATEGORY_WINDOW_NAME$
```
public static BBjString DASHBOARD_CATEGORY_WINDOW_NAME$
```
    Dashboard category window name
  - DASHBOARD_CATEGORY_CONTROL_TITLE_BAR_NAME$
```
public static BBjString DASHBOARD_CATEGORY_CONTROL_TITLE_BAR_NAME$
```
    Dashboard category control title bar name
  - DASHBOARD_CATEGORY_CONTROL_TITLE_TEXT_NAME$
```
public static BBjString DASHBOARD_CATEGORY_CONTROL_TITLE_TEXT_NAME$
```
    Dashboard category control title text name
- Constructor Detail
  - DashboardCategoryControl
```
public DashboardCategoryControl(DashboardCategory p_dashboardCategory!,
DashboardControl p_dashboardControl!,
BBjWindow p_parentWindow!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_flags$)
```
    Constructs a DashboardCategoryControl
    
    Parameters:
    
    p_dashboardCategory! - DashboardCategory to display in the control
    
    p_dashboardControl! - DashboardControl which this control is a member of
    
    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 for the control that specify the behavior and the appearance of the control
    
    See Also:
    
    BBjWindow::addChildWindow for the list of valid flag options
  - DashboardCategoryControl
```
public DashboardCategoryControl(DashboardCategory p_dashboardCategory!,
BBjWindow p_parentWindow!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_flags$)
```
    Constructs a DashboardCategoryControl
    
    Parameters:
    
    p_dashboardCategory! - DashboardCategory to display in the 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 for the control that specify the behavior and the appearance of the control
    
    See Also:
    
    BBjWindow::addChildWindow for the list of valid flag options
  - DashboardCategoryControl
```
public DashboardCategoryControl(DashboardCategory p_dashboardCategory!,
BBjWindow p_parentWindow!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_flags$,
BBjNumber p_titleBar)
```
    Constructs a DashboardCategoryControl
    
    Parameters:
    
    p_dashboardCategory! - DashboardCategory to display in the 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 for the control that specify the behavior and the appearance of the control
    
    p_titleBar - Indicates if the the control should include title bar, 0 = No title bar, 1 = Title bar
    
    See Also:
    
    BBjWindow::addChildWindow for the list of valid flag options
- Method Detail
  - getDashboardCategory
```
public DashboardCategory getDashboardCategory()
```
    Returns the encapuslated dashboard category used in the dashboard category control
    
    Returns:
    
    DashboardCategory encapsualted by the dashboard category control otherwise null()
  - OnWidgetSelect
```
public void OnWidgetSelect(BBjCustomEvent p_event!)
```
    Called when a widget is selected
    
    Parameters:
    
    p_event! - BBjCustomEvent which contains event informaiton
  - deselectWidgetControl
```
public void deselectWidgetControl()
```
    Deselects the current widget control
  - setVisible
```
public void setVisible(BBjNumber p_visible)
```
    Sets the control visibility
    
    Parameters:
    
    p_visible - Indicates the control's visibility. 0 = invisible, 1 = visible
  - setTitle
```
public void setTitle(BBjString p_title$)
```
    Sets the title of the dashboard category control
    
    Parameters:
    
    p_title$ - Title of the dashboard category control
  - refresh
```
public void refresh()
```
    Refreshes the control
  - getDashboardWidgetControl
```
public DashboardWidgetControl getDashboardWidgetControl(BBjString p_widgetName$)
```
    Returns a dashboard widget control
    
    Parameters:
    
    p_widgetName$ - Name of the dashboard widget control to return
    
    Returns:
    
    DashboardWidgetControl associated with the passed name, otherwiser null()
  - setSize
```
public void setSize(BBjNumber p_width,
BBjNumber p_height)
```
    Sets the size of the dashboard category control
    
    Parameters:
    
    p_width - Width for the dashboard category control
    
    p_height - Height for the dashboard category control
  - resetContainerHeight
```
public void resetContainerHeight()
```
    Resets the container height based on widget height, number of rows, and row spacing
  - layoutWidgets
```
public void layoutWidgets()
```
    Laysout the widget contained in the dashboard category control
  - getDashboardCategoryWindow
```
public BBjChildWindow getDashboardCategoryWindow()
```
    Returns the window of the dashboard category control
    
    Returns:
    
    BBjChildWindow that is used to house the dashboard category control
  - removeDashboardWidgetControl
```
public void removeDashboardWidgetControl(DashboardWidgetControl p_dashboardWidgetControl!)
```
    An internal method that removes a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object
    
    Parameters:
    
    p_dashboardWidgetControl! - The dashboard widget control to remove
    
    Since:
    
    BBj 18.20
  - removeDashboardWidgetControl
```
public void removeDashboardWidgetControl(BBjString p_widgetName$)
```
    An internal method that removes a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object's unique name
    
    Parameters:
    
    p_widgetName$ - The name of the widget control to remove
  - getActiveDashboardWidgetControlPosition
```
public BBjNumber getActiveDashboardWidgetControlPosition(BBjString p_widgetName$)
```
    Returns the current position of an active dashboard widget control that is part of the dashboard category control
    
    Parameters:
    
    p_widgetName$ - Name of the widget control to get obtain position for
    
    Returns:
    
    The 0-based position of the widget control
  - getInactiveDashboardWidgetControlPosition
```
public BBjNumber getInactiveDashboardWidgetControlPosition(BBjString p_widgetName$)
```
    Returns the current position of an inactive dashboard widget control that is part of the dashboard category control
    
    Parameters:
    
    p_widgetName$ - Name of the widget control to get obtain position for
    
    Returns:
    
    The 0-based position of the widget control
    
    Since:
    
    BBj 16.20
  - repositionDashboardWidgetControl
```
public void repositionDashboardWidgetControl(DashboardWidgetControl p_dashboardWidgetControl!)
```
    An internal method that repositions a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object
    This method is called as a result of the user dragging and dropping a widget control into a new position. The method determines the new placement of the widget control, then calls the repositionDashboardWidgetControl() method with the control and destination position.
    
    Parameters:
    
    p_dashboardWidgetControl! - The DashboardWidgetControl to reposition
    
    Since:
    
    BBj 18.20
  - repositionDashboardWidgetControl
```
public void repositionDashboardWidgetControl(BBjString p_widgetName$)
```
    An internal method that repositions a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object's unique name
    
    Parameters:
    
    p_widgetName$ - The name of the DashboardWidgetControl to reposition
  - repositionDashboardWidgetControl
```
public void repositionDashboardWidgetControl(DashboardWidgetControl p_dashboardWidgetControl!,
BBjNumber p_destPosition)
```
    An internal method that repositions a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object and a destination position
    
    Parameters:
    
    p_dashboardWidgetControl! - The DashboardWidgetControl to reposition
    
    p_destPosition - The destination position of the DashboardWidgetControl (a zero-based index)
    
    Since:
    
    BBj 18.20
  - repositionDashboardWidgetControl
```
public void repositionDashboardWidgetControl(BBjString p_widgetName$,
BBjNumber p_destPosition)
```
    An internal method that repositions a dashboard widget control that is part of the dashboard category control given the DashboardWidgetControl object's unique name and a destination position
    
    Parameters:
    
    p_widgetName$ - The name of the DashboardWidgetControl to reposition
    
    p_destPosition - The destination position of the DashboardWidgetControl (a zero-based index)
  - activateWidget
```
public void activateWidget(DashboardWidgetControl p_dashboardWidgetControl!,
BBjNumber p_activate)
```
    Sets the active dashboard widget control that is part of the dashboard category control
    
    Parameters:
    
    p_widgetName$ - Name of the widget control to make active/deactive
    
    p_activate - Active status, 0 = inactive, 1 = active
  - getName
```
public BBjString getName()
```
    Returns the name of the dashboard category control
    
    Returns:
    
    Name of the dashboard category control
  - getNumDashboardWidgetControls
```
public BBjNumber getNumDashboardWidgetControls()
```
    Returns the number of dashboard widget controls in the dashboard category control
    
    Returns:
    
    Returns the number of dashboard widget controls
  - getNumActiveDashboardWidgetControls
```
public BBjNumber getNumActiveDashboardWidgetControls()
```
    Returns the number of active dashboard widget controls in the dashboard category control
    
    Returns:
    
    Returns the number of active dashboard widget controls
  - getNumInactiveDashboardWidgetControls
```
public BBjNumber getNumInactiveDashboardWidgetControls()
```
    Returns the number of inactive dashboard widget controls in the dashboard category control
    
    Returns:
    
    Returns the number of inactive dashboard widget controls
  - getDashboardWidgetControls
```
public BBjVector getDashboardWidgetControls()
```
    Returns the dashboard widget controls in the dashboard category control
    
    Returns:
    
    BBjVector containing the dashboard widget controls
  - getActiveDashboardWidgetControls
```
public BBjVector getActiveDashboardWidgetControls()
```
    Returns the active dashboard widget controls in the dashboard category control
    
    Returns:
    
    BBjVector containing the active dashboard widget controls
  - getInactiveDashboardWidgetControls
```
public BBjVector getInactiveDashboardWidgetControls()
```
    Returns the inactive dashboard widget controls in the dashboard category control
    
    Returns:
    
    BBjVector containing the inactive dashboard widget controls
  - getDashboardControl
```
public DashboardControl getDashboardControl()
```
    Returns the dashboard control that this dashboard category control is a part of
    
    Returns:
    
    DashboardControl that this dashboard category control is a part of or null().
  - setBackColor
```
public void setBackColor(BBjColor p_backColor!)
```
    Sets the background color of the dashboard category control
    
    Parameters:
    
    p_backColor! - BBjColor which specifies the background color
  - getBBjControl
```
public BBjControl getBBjControl(BBjString p_controlName$)
```
    Returns a BBj control give a name
    
    Parameters:
    
    p_controlName$ - Name of the BBjControl to obtain
    
    Returns:
    
    BBjControl associated with the provide name, otherwise null()
  - getBackColor
```
public BBjColor getBackColor()
```
    Returns the background color of the dashboard category control
    
    Returns:
    
    BBjColor that specifies the background color
  - destroy
```
public void destroy()
```
    Destroys the dashboard category control

Class DashboardCategoryControl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WidgetMidpointsVector!

Title$

DASHBOARD_CATEGORY_WINDOW_NAME$

DASHBOARD_CATEGORY_CONTROL_TITLE_BAR_NAME$

DASHBOARD_CATEGORY_CONTROL_TITLE_TEXT_NAME$

Constructor Detail

DashboardCategoryControl

DashboardCategoryControl

DashboardCategoryControl

Method Detail

getDashboardCategory

OnWidgetSelect

deselectWidgetControl

setVisible

setTitle

refresh

getDashboardWidgetControl

setSize

resetContainerHeight

layoutWidgets

getDashboardCategoryWindow

removeDashboardWidgetControl

removeDashboardWidgetControl

getActiveDashboardWidgetControlPosition

getInactiveDashboardWidgetControlPosition

repositionDashboardWidgetControl

repositionDashboardWidgetControl

repositionDashboardWidgetControl

repositionDashboardWidgetControl

activateWidget

getName

getNumDashboardWidgetControls

getNumActiveDashboardWidgetControls

getNumInactiveDashboardWidgetControls

getDashboardWidgetControls

getActiveDashboardWidgetControls

getInactiveDashboardWidgetControls

getDashboardControl

setBackColor

getBBjControl

getBackColor

destroy