public class DashboardCategoryControl
DashboardCategoryControl UI class that displays a dashboard category
Modifier and Type | Field and Description |
---|---|
static BBjString | DASHBOARD_CATEGORY_CONTROL_TITLE_BAR_NAME$="dashboardCategoryControlTitleBar" Dashboard category control title bar name |
static BBjString | DASHBOARD_CATEGORY_CONTROL_TITLE_TEXT_NAME$="dashboardCategoryControlTitleText" Dashboard category control title text name |
static BBjString | DASHBOARD_CATEGORY_WINDOW_NAME$="dashboardCategoryWindow" Dashboard category window name |
BBjString | Title$ Title of the dashboard category control |
BBjVector | WidgetMidpointsVector! BBjVector containing the midpoints for the widgets |
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!, DashboardControl p_dashboardControl!, 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 |
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(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 | 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 | 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. |
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(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 | 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 | 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 |
public static BBjString DASHBOARD_CATEGORY_CONTROL_TITLE_BAR_NAME$="dashboardCategoryControlTitleBar"
Dashboard category control title bar name
public static BBjString DASHBOARD_CATEGORY_CONTROL_TITLE_TEXT_NAME$="dashboardCategoryControlTitleText"
Dashboard category control title text name
public static BBjString DASHBOARD_CATEGORY_WINDOW_NAME$="dashboardCategoryWindow"
Dashboard category window name
public BBjString Title$
Title of the dashboard category control
public BBjVector WidgetMidpointsVector!
BBjVector containing the midpoints for the widgets
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
p_dashboardCategory!
DashboardCategory to display in the controlp_parentWindow!
Parent window of the controlp_x
X location of the controlp_y
Y location of the controlp_width
Width of the controlp_height
Height of the controlp_flags$
Flags for the control that specify the behavior and the appearance of the control BBjWindow::addChildWindow for the list of valid flag options
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
p_dashboardCategory!
DashboardCategory to display in the controlp_dashboardControl!
DashboardControl which this control is a member ofp_parentWindow!
Parent window of the controlp_x
X location of the controlp_y
Y location of the controlp_width
Width of the controlp_height
Height of the controlp_flags$
Flags for the control that specify the behavior and the appearance of the control BBjWindow::addChildWindow for the list of valid flag options
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
p_dashboardCategory!
DashboardCategory to display in the controlp_parentWindow!
Parent window of the controlp_x
X location of the controlp_y
Y location of the controlp_width
Width of the controlp_height
Height of the controlp_flags$
Flags for the control that specify the behavior and the appearance of the controlp_titleBar
Indicates if the the control should include title bar, 0=No title bar, 1=Title bar BBjWindow::addChildWindow for the list of valid flag options
public void activateWidget(DashboardWidgetControl p_dashboardWidgetControl!, BBjNumber p_activate)
Sets the active dashboard widget control that is part of the dashboard category control
p_widgetName$
Name of the widget control to make active/deactivep_activate
Active status, 0=inactive, 1=activepublic void deselectWidgetControl()
Deselects the current widget control
public void destroy()
Destroys the dashboard category control
public BBjNumber getActiveDashboardWidgetControlPosition(BBjString p_widgetName$)
Returns the current position of an active dashboard widget control that is part of the dashboard category control
p_widgetName$
Name of the widget control to get obtain position forpublic BBjVector getActiveDashboardWidgetControls()
Returns the active dashboard widget controls in the dashboard category control
public BBjColor getBackColor()
Returns the background color of the dashboard category control
public BBjControl getBBjControl(BBjString p_controlName$)
Returns a BBj control give a name
p_controlName$
Name of the BBjControl to obtainpublic DashboardCategory getDashboardCategory()
Returns the encapuslated dashboard category used in the dashboard category control
public BBjChildWindow getDashboardCategoryWindow()
Returns the window of the dashboard category control
public DashboardControl getDashboardControl()
Returns the dashboard control that this dashboard category control is a part of
public DashboardWidgetControl getDashboardWidgetControl(BBjString p_widgetName$)
Returns a dashboard widget control
p_widgetName$
Name of the dashboard widget control to returnpublic BBjVector getDashboardWidgetControls()
Returns the dashboard widget controls in the dashboard category control
public BBjNumber getInactiveDashboardWidgetControlPosition(BBjString p_widgetName$)
Returns the current position of an inactive dashboard widget control that is part of the dashboard category control
p_widgetName$
Name of the widget control to get obtain position for BBj 16.20
public BBjVector getInactiveDashboardWidgetControls()
Returns the inactive dashboard widget controls in the dashboard category control
public BBjString getName()
Returns the name of the dashboard category control
public BBjNumber getNumActiveDashboardWidgetControls()
Returns the number of active dashboard widget controls in the dashboard category control
public BBjNumber getNumDashboardWidgetControls()
Returns the number of dashboard widget controls in the dashboard category control
public BBjNumber getNumInactiveDashboardWidgetControls()
Returns the number of inactive dashboard widget controls in the dashboard category control
public void layoutWidgets()
Laysout the widget contained in the dashboard category control
public void OnWidgetSelect(BBjCustomEvent p_event!)
Called when a widget is selected
p_event!
BBjCustomEvent which contains event informaitonpublic void refresh()
Refreshes the control
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
p_dashboardWidgetControl!
The dashboard widget control to remove BBj 18.20
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
p_widgetName$
The name of the widget control to removepublic 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.
p_dashboardWidgetControl!
The DashboardWidgetControl to reposition BBj 18.20
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
p_widgetName$
The name of the DashboardWidgetControl to repositionpublic 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
p_dashboardWidgetControl!
The DashboardWidgetControl to repositionp_destPosition
The destination position of the DashboardWidgetControl (a zero-based index) BBj 18.20
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
p_widgetName$
The name of the DashboardWidgetControl to repositionp_destPosition
The destination position of the DashboardWidgetControl (a zero-based index)public void resetContainerHeight()
Resets the container height based on widget height, number of rows, and row spacing
public void setBackColor(BBjColor p_backColor!)
Sets the background color of the dashboard category control
p_backColor!
BBjColor which specifies the background colorpublic void setSize(BBjNumber p_width, BBjNumber p_height)
Sets the size of the dashboard category control
p_width
Width for the dashboard category controlp_height
Height for the dashboard category controlpublic void setTitle(BBjString p_title$)
Sets the title of the dashboard category control
p_title$
Title of the dashboard category controlpublic void setVisible(BBjNumber p_visible)
Sets the control visibility
p_visible
Indicates the control's visibility. 0=invisible, 1=visible