public class DashboardControl
DashboardControl UI class that displays a dashboard in a BBjChildWindow
Constructor and Description |
---|
DashboardControl(Dashboard p_dashboard!, DashboardWindow p_dashboardWindow!, BBjWindow p_parentWindow!, 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$) 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 |
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 |
public static BBjString CUSTOMIZE_CONTROL_BAR_BACKGROUND_NAME$="dashboardCustomizeControlBarBackground"
Customize control bar background name
public static BBjString CUSTOMIZE_DONE_BUTTON_NAME$="dashboardCustomizeWindowDoneButton"
Customize done button name
public static BBjString CUSTOMIZE_PREVIEW_ADD_BUTTON_1_NAME$="dashboardCustomizePreviewAddButton1"
Customize preview add button 1 name
public static BBjString CUSTOMIZE_PREVIEW_HTMLVIEW_1_NAME$="dashboardCustomizePreviewHtmlView1"
Customize preview html view 1 name
public static BBjString CUSTOMIZE_PREVIEW_IMAGE_1_NAME$="dashboardCustomizePreviewImage1"
Customize preview image 1 name
public static BBjString CUSTOMIZE_PREVIEW_NEXT_BUTTON_NAME$="dashboardCustomizeWindowNextButton"
Customize Next button name
public static BBjString CUSTOMIZE_PREVIEW_PREV_BUTTON_NAME$="dashboardCustomizeWindowPrevButton"
Customize Previous button name
public static BBjString CUSTOMIZE_PREVIEW_STATUS_TEXT$="dashboardCustomizeWindowStatus"
Customize status text
public static BBjString CUSTOMIZE_PREVIEW_WIDGET_FONT_SCALING_CHECKBOX_NAME$="dashboardCustomizePreviewWidgetFontScalingCheckBox"
Customize preview Fixed Widget Size Checkbox
public static BBjString CUSTOMIZE_PREVIEW_WIDGET_FONT_SCALING_SLIDER_NAME$="dashboardCustomizePreviewWidgetFontScalingSlider"
Customize preview widget window name
public static BBjString CUSTOMIZE_PREVIEW_WIDGET_SIZE_CHECKBOX_NAME$="dashboardCustomizePreviewWidgetSizeCheckBox"
Customize preview Fixed Widget Size Checkbox
public static BBjString CUSTOMIZE_PREVIEW_WIDGET_SIZE_SLIDER_NAME$="dashboardCustomizePreviewWidgetSizeSlider"
Customize preview widget window name
public static BBjString CUSTOMIZE_PREVIEW_WIDGET_TITLE_NAME$="dashboardCustomizePreviewWidgetTitle"
Customize preview widget title name
public static BBjString CUSTOMIZE_PREVIEW_WIDGET_WINDOW_NAME$="dashboardCustomizePreviewWidgetWindow"
Customize preview widget window name
public static BBjString CUSTOMIZE_WINDOW_NAME$="dashboardCustomizeWindow"
Customize window name
public static BBjString DASHBOARD_CONTROL_CUSTOMIZE_BUTTON_NAME$="dashboardControlCustomizeButton"
Dashboard control customize button name
public static BBjString DASHBOARD_CONTROL_REFRESH_BUTTON_NAME$="dashboardControlRefreshButton"
Dashboard control refresh button name
public static BBjString DASHBOARD_CONTROL_TAB_CTRL_NAME$="dashboardControlTabCtrl"
Dashboard control tab ctrl name
public static BBjString DASHBOARD_CONTROL_TITLE_BAR_NAME$="dashboardControlTitleBar"
Dashboard control title bar name
public static BBjString DASHBOARD_CONTROL_TITLE_TEXT_NAME$="dashboardControlTitleText"
Dashboard control title text name
public static BBjString DASHBOARD_CONTROL_TOOL_BAR_NAME$="dashboardControlToolBar"
Dashboard control tool bar name
public static BBjString DASHBOARD_CONTROL_WINDOW_NAME$="dashboardControlWindow"
Dashboard control window name
public static BBjString DASHBOARD_GLASS_PANE_NAME$="dashboardGlassPane"
Dashboard glass pane name
public BBjNumber ShowBuiBusyOnLoad=0
A number acting as a boolean that determines whether the DashboardControl should show the BUI BBjBusyIndicator when loading the widgets.
BBj 16.20
public BBjNumber TitleBarHeight
Height of the title bar
public BBjNumber ToolBarHeight
Height of the tool bar
public static bbjstring Widgets"
The text to display when initializing the categories and widgets.
BBj 17.11
public static bbjstring Widgets"
The text to display when displaying the BUI BBjBusyIndicator.
BBj 16.20
public DashboardControl(Dashboard p_dashboard!, DashboardWindow p_dashboardWindow!, BBjWindow p_parentWindow!, BBjString p_flags$)
Constructs a DashboardControl
p_dashboard!
Dashboard to display in the dashboard controlp_dashboardWindow!
Parent dashboard windowp_parentWindow!
Parent window of the controlp_flags$
Flags that affect behavior and appearance of the control BBjWindow::addChildWindow for the list of valid flag options
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
p_dashboard!
Dashboard to display in the dashboard 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 that affect behavior and appearance of the control BBjWindow::addChildWindow for the list of valid flag options
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
p_dashboard!
Dashboard to display in the dashboard 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 that affect behavior and appearance of the controlp_titleBar
Indicates if the the control should include title bar, 0=No title bar, 1=Title barp_toolBar
Indicates if the the control should include tool bar, 0=No tool bar, 1=Tool bar BBjWindow::addChildWindow for the list of valid flag options
public void destroy()
Destroys the dashboard control
public void enableRefreshButton()
Enables/Disables the refresh button
public BBjColor getBackColor()
Returns the background color of the dashboard control
public BBjControl getBBjControl(BBjString p_controlName$)
Returns a dashboard window BBj control
p_controlName$
Unique name of the control to retrievepublic Dashboard getDashboard()
Returns the encapsualted dashboard
public DashboardCategoryControl getDashboardCategoryControl(BBjString p_categoryName$)
Returns a dashboard category control given its unique name
p_categoryName$
Name of the category control to obtainpublic BBjChildWindow getDashboardControlWindow()
Returns the window of the dashboard control
public DashboardWindow getDashboardWindow()
Returns the dashboard window that houses the dashboard control
public BBjString getName()
Returns the name of the widget control
public BBjChildWindow getToolBar()
Returns the toolbar of the dashboard control
public HashMap getWidgetAttributesHashMap()
Returns the widget attributes
public void layout()
Lays out the widets in the currently selected category
public void layoutAll()
Lays out the widets in all categories
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
p_event!
BBjToolButtonPushEvent which contains event informationpublic void OnColorThemeSelect(BBjListChangeEvent p_event!)
Called when the user selects a color theme from the Customize window
p_event!
BBjListChangeEvent which contains event informationpublic void OnCustomize(BBjButtonPushEvent p_event!)
Called when the customize button is pressed
p_event!
BBjButtonPushEvent which contains event informationpublic void OnCustomizeDone(BBjSysGuiEvent p_event!)
Called when the Done tool button is pushed in the Customize window
p_event!
BBjToolButtonPushEvent which contains event informationpublic void OnCustomizeNext(BBjSysGuiEvent p_event!)
Called when the Next tool button is pushed in the Customize window
p_event!
BBjToolButtonPushEvent which contains event informationpublic void OnCustomizePrev(BBjSysGuiEvent p_event!)
Called when the Prev tool button is pushed in the Customize window
p_event!
BBjToolButtonPushEvent which contains event informationpublic void OnCustomizeResize(BBjResizeEvent p_event!)
Called when the Customize window is resized.
p_event!
BBjResizeEvent which contains event informationpublic void OnCustomizeResizeTimer(BBjTimerEvent p_event!)
Called when the resize timer is triggered
p_event!
BBjTimerEvent objectpublic void OnDoNotUseWidgetFontScaling(BBjCheckOffEvent p_event!)
Called when the user chooses to use a dynamic widget size
p_event!
BBjCheckOffEvent which contains event informationpublic void OnFontSelect(BBjListChangeEvent p_event!)
Called when the user selects a custom font from the Customize window
p_event!
BBjListChangeEvent which contains event informationpublic void OnPreviewScroll(BBjWindowScrollEvent p_event!)
Called when the preview window is scrolled in the Customize window
p_event!
BBjWindowScrollEvent which contains event informationpublic void OnRefresh(BBjButtonPushEvent p_event!)
Called when the Refresh tool button is pushed
p_event!
BBjToolButtonPushEvent which contains event informationpublic void OnTabSelect(BBjTabSelectedEvent p_event!)
Called when a tab is selected
p_event!
BBjTabSelectedEvent which contains event informationpublic void OnUseDynamicWidgetSize(BBjCheckOffEvent p_event!)
Called when the user chooses to use a dynamic widget size
p_event!
BBjCheckOffEvent which contains event informationpublic void OnUseFixedWidgetSize(BBjCheckOnEvent p_event!)
Called when the user chooses to use a fixed widget size
p_event!
BBjCheckOnEvent which contains event informationpublic void OnUseWidgetFontScaling(BBjCheckOnEvent p_event!)
Called when the user chooses to use a fixed widget size
p_event!
BBjCheckOnEvent which contains event informationpublic void OnWidgetFontScalingScroll(BBjControlScrollEvent p_event!)
Called when the user selects a custom font scaling factor from the Customize window
p_event!
BBjControlScrollEvent which contains event informationpublic void OnWidgetSizeScroll(BBjControlScrollEvent p_event!)
Called when the user selects a color theme from the Customize window
p_event!
BBjListChangeEvent which contains event informationpublic void refresh()
Refreshes the widgets in the currently selected category
public void refreshAll()
Refreshes the widgets in all categories
public void removeDashboardCategoryControl(BBjString p_categoryName$)
Remove a dashboard category control
p_categoryName$
Name of the category control to removepublic void setBackColor(BBjColor p_backColor!)
Sets the background color of the dashboard control
p_backColor!
BBjColor that specifies the desired background color for the dashboard controlpublic void setBusyText(BBjString p_busyText$)
Sets the specified text to be displayed when loading widgets into the DashboardCategory
p_busyText$
A string indicating why the dashboard is busy. The default is "Creating Widgets". BBj 17.11
public void setGlassPaneVisible(BBjNumber p_visible)
Called when the visibiliy of the glass pane
p_visible
Indicates the visibility of the glass pane. O=invisible, 1=visiblepublic void setSize(BBjNumber p_width, BBjNumber p_height)
Sets the control size
p_width
Width of the controlp_height
Height of the controlpublic void setTitle(BBjString p_title$)
Sets the title of the dashboard control
p_title$
Title of the dashboard controlpublic void setVisible(BBjNumber p_visible)
Sets the control visibility
p_visible
Indicates the conrol visibility. 0=invisible, 1=visiblepublic void storeWidgetProps()
Stores the properties of all DashboardCategories and Widgets in the current Dashboard