Dashboard

Class DashboardCategory

java.lang.Object

Dashboard.DashboardItem

Dashboard.DashboardCategory

Direct Known Subclasses:

EmbeddedWidgetSet

public class DashboardCategory
extends DashboardItem

Data class that encapsulates the entities which comprise a dashboard category

Field Summary

Fields

Modifier and Type	Field and Description
BBjNumber	ColSpacing Space in pixels between columns of widgets
BBjNumber	FillErrorAction Determines how the dashboard should react after encountering an error filling a widget.
BBjNumber	FixedWidgetWidth The fixed width in pixels in of widgets.
BBjNumber	MaxWidgetWidth Maximum width in pixels of widgets
BBjNumber	MinWidgetWidth Minimum width in pixels of widgets
static BBjNumber	ON_FILL_ERROR_IGNORE A constant to define how the dashboard handles widget fill errors - This value indicates it should ignore the error and proceed as normal (note that all errors are logged to the BBjServices debug log file).
static BBjNumber	ON_FILL_ERROR_STOP A constant to define how the dashboard handles widget fill errors - This value indicates it should THROW the error which usually results in the program stopping (note that all errors are logged to the BBjServices debug log file).
static BBjNumber	ON_FILL_ERROR_WARN A constant to define how the dashboard handles widget fill errors - This value indicates it should warn the user then proceed as normal (note that all errors are logged to the BBjServices debug log file.
BBjNumber	RowSpacing Space in pixels between rows of widgets
static BBjNumber	WIDGET_SIZING_DYNAMIC_SIZE A constant used with WidgetSizingModel to define dynamic widget sizing
static BBjNumber	WIDGET_SIZING_FIXED_SIZE A constant used with WidgetSizingModel to define fixed widget sizing
BBjNumber	WidgetSizingModel Determines how the dashboard will size the widgets in a category.

Constructor Summary

Constructors

Constructor and Description
DashboardCategory(BBjString p_name$, BBjString p_title$) Constructs a DashboardCategory

Method Summary

Modifier and Type	Method and Description
DashboardWidget	addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns a area chart dashboard widget
DashboardWidget	addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a area chart dashboard widget
DashboardWidget	addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a area chart dashboard widget
DashboardWidget	addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a area chart dashboard widget
DashboardWidget	addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns a xy chart dashboard widget
DashboardWidget	addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a xy chart dashboard widget
DashboardWidget	addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a xy chart dashboard widget
DashboardWidget	addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a xy chart dashboard widget
void	addDashboardWidget(DashboardWidget p_dashboardWidget!) Adds a dashboard widget to the end of the dashboard category
DashboardWidget	addDashboardWidget(Widget p_widget!) Creates an active DashboardWidget based on the provided widget and adds it to the current category
DashboardWidget	addDashboardWidget(Widget p_widget!, BBjNumber p_active) Creates an active or inactive DashboardWidget based on the provided widget and adds it to the current category
DashboardWidget	addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) Creates and returns a grid dashboard widget
DashboardWidget	addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a grid dashboard widget
DashboardWidget	addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$) Creates and returns a grid dashboard widget
DashboardWidget	addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a grid dashboard widget
DashboardWidget	addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjVector p_colHeaderData!, BBjVector p_rowData!) Creates and returns a grid dashboard widget
DashboardWidget	addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) Creates and returns an empty GridEx dashboard widget
DashboardWidget	addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a GridEx dashboard widget using a BBjRecordSet for the row data and an (optionally null()) BBjVector for the column header data
DashboardWidget	addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$) Creates and returns a GridEx dashboard widget using a connection string and SQL query
DashboardWidget	addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a GridEx dashboard widget using a connection string, SQL query, and mode
DashboardWidget	addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_file$, BBjString p_template$, DataRow p_filter!) Creates and returns a GridEx dashboard widget using the BASIS Components to build a ResultSet based off of a data file, string template, and filter
DashboardWidget	addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjVector p_colHeaderData!, BBjVector p_rowData!) Creates and returns a GridEx dashboard widget using BBjVectors for the column header data and row data
DashboardWidget	addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, ResultSet p_resultSet!) Creates and returns a GridEx dashboard widget based on a BASIS Components ResultSet that contains the data for the widget
DashboardWidget	addHtmlViewDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) Creates and returns a html view dashboard widget
DashboardWidget	addHtmlViewDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_text$) Creates and returns a html view dashboard widget
DashboardWidget	addImageDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) Creates and returns a image dashboard widget
DashboardWidget	addImageDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_imageName$) Creates and returns a image dashboard widget
DashboardWidget	addImageDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, URL p_imageURL!) Creates and returns a image dashboard widget
DashboardWidget	addJasperViewerDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBJasperReport p_report!) Creates and returns a jasper viewer dashboard widget based the provided BBJasperReport
DashboardWidget	addJasperViewerDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_reportFile$, BBjString p_connectString$, HashMap p_params!) Creates and returns a jasper viewer dashboard widget with parameters so that the Dashboard Utility can create and fill the report before it displays the widget
DashboardWidget	addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns a line dashboard widget
DashboardWidget	addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a line dashboard widget
DashboardWidget	addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a line dashboard widget
DashboardWidget	addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a line dashboard widget
DashboardWidget	addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend) Creates and returns a pie chart dashboard widget with an empty dataset
DashboardWidget	addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices) Creates and returns a pie chart dashboard widget
DashboardWidget	addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a pie chart dashboard widget
DashboardWidget	addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a pie chart dashboard widget
DashboardWidget	addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a pie chart dashboard widget
DashboardWidget	addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend) Creates and returns a ring chart dashboard widget with an empty dataset
DashboardWidget	addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices) Creates and returns a ring chart dashboard widget
DashboardWidget	addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a ring chart dashboard widget
DashboardWidget	addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a ring chart dashboard widget
DashboardWidget	addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a ring chart dashboard widget
DashboardWidget	addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns a stacked area chart dashboard widget
DashboardWidget	addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a staked area chart dashboard widget
DashboardWidget	addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a stacked area chart dashboard widget
DashboardWidget	addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a stacked area chart dashboard widget
DashboardWidget	addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns a stacked bar chart dashboard widget
DashboardWidget	addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a stacked bar chart dashboard widget
DashboardWidget	addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a stacked bar chart dashboard widget
DashboardWidget	addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a stacked bar chart dashboard widget
DashboardWidget	addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns a stacked percentage bar chart dashboard widget
DashboardWidget	addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a stacked percentage bar chart dashboard widget
DashboardWidget	addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a stacked percentage bar chart dashboard widget
DashboardWidget	addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a stacked percentage bar chart dashboard widget
DashboardWidget	addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns a xy chart dashboard widget
DashboardWidget	addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns an xy chart dashboard widget
DashboardWidget	addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns an xy chart dashboard widget
DashboardWidget	addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns an xy chart dashboard widget
BBjNumber	dashboardWidgetExists(BBjString p_widgetName$) Determines if a dashboard widget exists given its name
void	destroy() Destroys the dashboard category and destroys all dashboardWidgets contained in the category
DashboardWidget	getDashboardWidget(BBjString p_widgetName$) Returns a dashboard widget given its name
BBjNumber	getDashboardWidgetPosition(DashboardWidget p_dashboardWidget!) Returns the position of a dashboard widget
BBjVector	getDashboardWidgets() Returns the dashboard widgets in a BBjVector
BBjNumber	getDefaultColSpacing() Returns the default col spacing between widgets
BBjNumber	getDefaultMaxWidgetWidth() Returns the default maximum widget width
BBjNumber	getDefaultMinWidgetWidth() Returns the default minimum widget width
BBjNumber	getDefaultRowSpacing() Returns the default row spacing between widgets
BBjNumber	getNumDashboardWidgets() Returns the number of dashboard widgets
void	removeDashboardWidget(BBjString p_widgetName$) Removes a dashboard widget, causing all widgets with a higher position to be shifted down by one
void	repositionDashboardWidget(DashboardWidget p_dashboardWidget!, BBjNumber p_destPosition) Repositions a dashboard widget by inserting it at the specified destination position, shifting all remaining widgets one position higher
void	setWidgetBorderColor(BBjColor p_color!) Sets the border color of the widgets
void	setWidgetBorderSelectedColor(BBjColor p_color!) Sets the border selected color of the widgets
void	setWidgetTitlebarDecorationBackColor(BBjColor p_color!) Sets the title bar decoration background color of the widgets
void	setWidgetTitlebarDecorationSelectedBackColor(BBjColor p_color!) Sets the title bar decoration selected background color of the widgets
void	setWidgetTitlebarNameBackColor(BBjColor p_color!) Sets the title bar name background color of the widgets
void	setWidgetTitlebarNameFont(BBjString p_fontFile$, BBjNumber p_style, BBjNumber p_fontSize) Sets the title bar font of the widgets
void	setWidgetTitlebarNameFont(Font p_font!) Sets the title bar font of the widgets
void	setWidgetTitlebarNameForeColor(BBjColor p_color!) Sets the title bar name foreground color of the widgets
void	setWidgetTitlebarNameSelectedBackColor(BBjColor p_color!) Sets the title bar name selected background color of the widgets
void	setWidgetTitlebarSeparatorColor(BBjColor p_color!) Sets the title bar separator background color of the widgets
void	setWidgetTitlebarSeparatorSelectedColor(BBjColor p_color!) Sets the title bar separator selected background color of the widgets
DashboardWidget	updateDashboardWidget(BBjString p_widgetName$, Widget p_widget!) Updates a dashboard widget in the dashboard category

Methods inherited from class Dashboard.DashboardItem

getBackColor, getName, getTitle, getUserData, setBackColor, setName, setTitle, setUserData

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MinWidgetWidth

public BBjNumber MinWidgetWidth

Minimum width in pixels of widgets

MaxWidgetWidth

public BBjNumber MaxWidgetWidth

Maximum width in pixels of widgets

ColSpacing

public BBjNumber ColSpacing

Space in pixels between columns of widgets

RowSpacing

public BBjNumber RowSpacing

Space in pixels between rows of widgets

FixedWidgetWidth

public BBjNumber FixedWidgetWidth

The fixed width in pixels in of widgets. This value is used in combination with setWidgetSizingModel(DashboardCategory.getWIDGET_SIZING_FIXED_SIZE()), which determines how the widgets are sized and positioned in the DashboardCategory

WidgetSizingModel

public BBjNumber WidgetSizingModel

Determines how the dashboard will size the widgets in a category. The WIDGIT_SIZING constants define the options, which include fixed sizing and dynamic sizing.

WIDGET_SIZING_DYNAMIC_SIZE

public static BBjNumber WIDGET_SIZING_DYNAMIC_SIZE

A constant used with WidgetSizingModel to define dynamic widget sizing

WIDGET_SIZING_FIXED_SIZE

public static BBjNumber WIDGET_SIZING_FIXED_SIZE

A constant used with WidgetSizingModel to define fixed widget sizing

FillErrorAction

public BBjNumber FillErrorAction

Determines how the dashboard should react after encountering an error filling a widget.

This numeric field variable defaults to DashboardCategory.getON_FILL_ERROR_IGNORE() (0), meaning that if an error occurs when filling the widget with data the program will silently log the error then continue to run normally. This prevents an entire dashboard application from failing when there is a problem with one widget. The behavior can be set using static field variables like DashboardCategory.getON_FILL_ERROR_IGNORE(), DashboardCategory.getON_FILL_ERROR_WARN(), or DashboardCategory.getON_FILL_ERROR_STOP().

The FillErrorAction can be set programmatically on a Widget, Dashboard Category, or Dashboard object. If you set the FillErrorAction on a Dashboard object, all added DashboardCategories and their Widgets will inherit the setting. If you set the FillErrorAction on a DashboardCategory object, all added Widgets will inherit the setting.

Here is an example showing how to set the behavior in code via a dashboard:

category!.setFillErrorAction(DashboardCategory.getON_FILL_ERROR_WARN())

Note that you may also set the "BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION" global string entry either via code or in a configuration file to control the behavior. If the FillErrorAction is set via a global string it will override all default and programmatically set values for all widgets.

Here are two examples showing how to set the FillErrorAction via a global string:

1) Setting the global string entry in code, before creating any dashboards or widgets:
temp$ = STBL("BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION", "1")

2) Setting the global string entry in the config file, without changing any code:
SET BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION = 1

Since:

BBj 18.20

ON_FILL_ERROR_IGNORE

public static BBjNumber ON_FILL_ERROR_IGNORE

A constant to define how the dashboard handles widget fill errors - This value indicates it should ignore the error and proceed as normal (note that all errors are logged to the BBjServices debug log file). @since BBj 18.20

ON_FILL_ERROR_WARN

public static BBjNumber ON_FILL_ERROR_WARN

A constant to define how the dashboard handles widget fill errors - This value indicates it should warn the user then proceed as normal (note that all errors are logged to the BBjServices debug log file. @since BBj 18.20

ON_FILL_ERROR_STOP

public static BBjNumber ON_FILL_ERROR_STOP

A constant to define how the dashboard handles widget fill errors - This value indicates it should THROW the error which usually results in the program stopping (note that all errors are logged to the BBjServices debug log file). @since BBj 18.20

Constructor Detail

DashboardCategory

public DashboardCategory(BBjString p_name$,
BBjString p_title$)

Constructs a DashboardCategory

Parameters:

p_name$ - Name of the category

p_title$ - Title of the category

Method Detail

addImageDashboardWidget

public DashboardWidget addImageDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$)

Creates and returns a image dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

Returns:

The created DashboardWidget

addImageDashboardWidget

public DashboardWidget addImageDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_imageName$)

Creates and returns a image dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_imageName$ - Location of a image for the dashboard image widget

Returns:

The created DashboardWidget

addImageDashboardWidget

public DashboardWidget addImageDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
URL p_imageURL!)

Creates and returns a image dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_imageURL! - URL of a image for the dashboard image widget

Returns:

The created DashboardWidget

addHtmlViewDashboardWidget

public DashboardWidget addHtmlViewDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$)

Creates and returns a html view dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

Returns:

The created DashboardWidget

addHtmlViewDashboardWidget

public DashboardWidget addHtmlViewDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_text$)

Creates and returns a html view dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_text$ - HTML that will be displayed in the html view dashboard widget

Returns:

The created DashboardWidget

addGridDashboardWidget

public DashboardWidget addGridDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$)

Creates and returns a grid dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

Returns:

The created DashboardWidget

addGridDashboardWidget

public DashboardWidget addGridDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_connectString$,
BBjString p_sql$)

Creates and returns a grid dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

Returns:

The created DashboardWidget

addGridDashboardWidget

public DashboardWidget addGridDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_connectString$,
BBjString p_sql$,
BBjString p_mode$)

Creates and returns a grid dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

p_mode$ - A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER = myusername, PWD = mypass, AUTOCOMMIT = N"

Returns:

The created DashboardWidget

Since:

BBj 16.00

addGridDashboardWidget

public DashboardWidget addGridDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjRecordSet p_rs!,
BBjVector p_columns!)

Creates and returns a grid dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_rs! - BBjRecordSet which contains data for the dashboard widget

p_columns! - BBjVector which contains the column names for the data for the dashboard widget

Returns:

The created DashboardWidget

addGridDashboardWidget

public DashboardWidget addGridDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjVector p_colHeaderData!,
BBjVector p_rowData!)

Creates and returns a grid dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_colHeaderData! - BBjVector which contains the column header data

p_rowData! - BBjVector which contains the row data

Returns:

The created DashboardWidget

addGridExDashboardWidget

public DashboardWidget addGridExDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$)

Creates and returns an empty GridEx dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

Returns:

The created DashboardWidget

Since:

BBj 19.10

addGridExDashboardWidget

public DashboardWidget addGridExDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
ResultSet p_resultSet!)

Creates and returns a GridEx dashboard widget based on a BASIS Components ResultSet that contains the data for the widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_resultSet! - BASIS Components ResultSet that contains the data for the widget

Returns:

The created DashboardWidget

Since:

BBj 19.12

See Also:

ResultSet

addGridExDashboardWidget

public DashboardWidget addGridExDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_file$,
BBjString p_template$,
DataRow p_filter!)

Creates and returns a GridEx dashboard widget using the BASIS Components to build a ResultSet based off of a data file, string template, and filter

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_file$ - The the name of the MKEYED, XKEYED, or VKEYED file that contains the data for the widget

p_template$ - The string template describing the records in the file

p_filter! - The DataRow that acts as a filter when retrieving data

Returns:

The created DashboardWidget

Since:

BBj 19.12

See Also:

DataRow

addGridExDashboardWidget

public DashboardWidget addGridExDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_connectString$,
BBjString p_sql$)

Creates and returns a GridEx dashboard widget using a connection string and SQL query

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

Returns:

The created DashboardWidget

Since:

BBj 19.10

addGridExDashboardWidget

public DashboardWidget addGridExDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_connectString$,
BBjString p_sql$,
BBjString p_mode$)

Creates and returns a GridEx dashboard widget using a connection string, SQL query, and mode

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

p_mode$ - A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER = myusername, PWD = mypass, AUTOCOMMIT = N"

Returns:

The created DashboardWidget

Since:

BBj 19.10

addGridExDashboardWidget

public DashboardWidget addGridExDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjRecordSet p_rs!,
BBjVector p_columns!)

Creates and returns a GridEx dashboard widget using a BBjRecordSet for the row data and an (optionally null()) BBjVector for the column header data

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for preview

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_rs! - BBjRecordSet which contains data for the dashboard widget

p_columns! - BBjVector that contains an ordered list of the columns to be used for the grid's data. The entries may be a string corresponding to a field name, or a 0-based index of the column number. If null() is passed in for the p_columns! vector then all columns of the BBjRecordSet will be used.

Returns:

The created DashboardWidget

Since:

BBj 19.10

addGridExDashboardWidget

public DashboardWidget addGridExDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjVector p_colHeaderData!,
BBjVector p_rowData!)

Creates and returns a GridEx dashboard widget using BBjVectors for the column header data and row data

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_colHeaderData! - BBjVector which contains the column header data

p_rowData! - BBjVector which contains the row data

Returns:

The created DashboardWidget

Since:

BBj 19.10

addLineChartDashboardWidget

public DashboardWidget addLineChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$)

Creates and returns a line dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

Returns:

The created DashboardWidget

addLineChartDashboardWidget

public DashboardWidget addLineChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$,
BBjString p_mode$)

Creates and returns a line dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

p_mode$ - A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER = myusername, PWD = mypass, AUTOCOMMIT = N"

Returns:

The created DashboardWidget

Since:

BBj 16.00

addLineChartDashboardWidget

public DashboardWidget addLineChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjRecordSet p_rs!,
BBjVector p_columns!)

Creates and returns a line dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_rs! - BBjRecordSet which contains data for the embedded widget

p_columns! - BBjVector which contains the column names for the data for the embedded widget

Returns:

The created DashboardWidget

addLineChartDashboardWidget

public DashboardWidget addLineChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend)

Creates and returns a line dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

Returns:

The created DashboardWidget

addAreaChartDashboardWidget

public DashboardWidget addAreaChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$)

Creates and returns a area chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

Returns:

The created DashboardWidget

addAreaChartDashboardWidget

public DashboardWidget addAreaChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$,
BBjString p_mode$)

Creates and returns a area chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

p_mode$ - A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER = myusername, PWD = mypass, AUTOCOMMIT = N"

Returns:

The created DashboardWidget

Since:

BBj 16.00

addAreaChartDashboardWidget

public DashboardWidget addAreaChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjRecordSet p_rs!,
BBjVector p_columns!)

Creates and returns a area chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_rs! - BBjRecordSet which contains data for the embedded widget

p_columns! - BBjVector which contains the column names for the data for the embedded widget

Returns:

The created DashboardWidget

addAreaChartDashboardWidget

public DashboardWidget addAreaChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_orientation,
BBjNumber p_legend)

Creates and returns a area chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

Returns:

The created DashboardWidget

addStackedAreaChartDashboardWidget

public DashboardWidget addStackedAreaChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$)

Creates and returns a stacked area chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

Returns:

The created DashboardWidget

addStackedAreaChartDashboardWidget

public DashboardWidget addStackedAreaChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$,
BBjString p_mode$)

Creates and returns a stacked area chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

p_mode$ - A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER = myusername, PWD = mypass, AUTOCOMMIT = N"

Returns:

The created DashboardWidget

Since:

BBj 16.00

addStackedAreaChartDashboardWidget

public DashboardWidget addStackedAreaChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjRecordSet p_rs!,
BBjVector p_columns!)

Creates and returns a staked area chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_rs! - BBjRecordSet which contains data for the embedded widget

p_columns! - BBjVector which contains the column names for the data for the embedded widget

Returns:

The created DashboardWidget

addStackedAreaChartDashboardWidget

public DashboardWidget addStackedAreaChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_orientation,
BBjNumber p_legend)

Creates and returns a stacked area chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

Returns:

The created DashboardWidget

addXYChartDashboardWidget

public DashboardWidget addXYChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$)

Creates and returns an xy chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

Returns:

The created DashboardWidget

addXYChartDashboardWidget

public DashboardWidget addXYChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$,
BBjString p_mode$)

Creates and returns an xy chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

p_mode$ - A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER = myusername, PWD = mypass, AUTOCOMMIT = N"

Returns:

The created DashboardWidget

Since:

BBj 16.00

addXYChartDashboardWidget

public DashboardWidget addXYChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjRecordSet p_rs!,
BBjVector p_columns!)

Creates and returns an xy chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_rs! - BBjRecordSet which contains data for the embedded widget

p_columns! - BBjVector which contains the column names for the data for the embedded widget

Returns:

The created DashboardWidget

addXYChartDashboardWidget

public DashboardWidget addXYChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_orientation,
BBjNumber p_legend)

Creates and returns a xy chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

Returns:

The created DashboardWidget

addBarChartDashboardWidget

public DashboardWidget addBarChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$)

Creates and returns a xy chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

Returns:

The created DashboardWidget

addBarChartDashboardWidget

public DashboardWidget addBarChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$,
BBjString p_mode$)

Creates and returns a xy chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

p_mode$ - A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER = myusername, PWD = mypass, AUTOCOMMIT = N"

Returns:

The created DashboardWidget

Since:

BBj 16.00

addBarChartDashboardWidget

public DashboardWidget addBarChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjRecordSet p_rs!,
BBjVector p_columns!)

Creates and returns a xy chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_rs! - BBjRecordSet which contains data for the embedded widget

p_columns! - BBjVector which contains the column names for the data for the embedded widget

Returns:

The created DashboardWidget

addBarChartDashboardWidget

public DashboardWidget addBarChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend)

Creates and returns a xy chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

Returns:

The created DashboardWidget

addStackedBarChartDashboardWidget

public DashboardWidget addStackedBarChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$)

Creates and returns a stacked bar chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

Returns:

The created DashboardWidget

addStackedBarChartDashboardWidget

public DashboardWidget addStackedBarChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$,
BBjString p_mode$)

Creates and returns a stacked bar chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

p_mode$ - A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER = myusername, PWD = mypass, AUTOCOMMIT = N"

Returns:

The created DashboardWidget

Since:

BBj 16.00

addStackedBarChartDashboardWidget

public DashboardWidget addStackedBarChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjRecordSet p_rs!,
BBjVector p_columns!)

Creates and returns a stacked bar chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_rs! - BBjRecordSet which contains data for the embedded widget

p_columns! - BBjVector which contains the column names for the data for the embedded widget

Returns:

The created DashboardWidget

addStackedBarChartDashboardWidget

public DashboardWidget addStackedBarChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend)

Creates and returns a stacked bar chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

Returns:

The created DashboardWidget

addStackedPercentageBarChartDashboardWidget

public DashboardWidget addStackedPercentageBarChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$)

Creates and returns a stacked percentage bar chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

Returns:

The created DashboardWidget

addStackedPercentageBarChartDashboardWidget

public DashboardWidget addStackedPercentageBarChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$,
BBjString p_mode$)

Creates and returns a stacked percentage bar chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

p_mode$ - A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER = myusername, PWD = mypass, AUTOCOMMIT = N"

Returns:

The created DashboardWidget

Since:

BBj 16.00

addStackedPercentageBarChartDashboardWidget

public DashboardWidget addStackedPercentageBarChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend,
BBjRecordSet p_rs!,
BBjVector p_columns!)

Creates and returns a stacked percentage bar chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_rs! - BBjRecordSet which contains data for the embedded widget

p_columns! - BBjVector which contains the column names for the data for the embedded widget

Returns:

The created DashboardWidget

addStackedPercentageBarChartDashboardWidget

public DashboardWidget addStackedPercentageBarChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjString p_domainTitle$,
BBjString p_rangeTitle$,
BBjNumber p_flat,
BBjNumber p_orientation,
BBjNumber p_legend)

Creates and returns a stacked percentage bar chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

Returns:

The created DashboardWidget

addPieChartDashboardWidget

public DashboardWidget addPieChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjNumber p_flat,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$)

Creates and returns a pie chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

Returns:

The created DashboardWidget

addPieChartDashboardWidget

public DashboardWidget addPieChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjNumber p_flat,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$,
BBjString p_mode$)

Creates and returns a pie chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

p_mode$ - A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER = myusername, PWD = mypass, AUTOCOMMIT = N"

Returns:

The created DashboardWidget

Since:

BBj 16.00

addPieChartDashboardWidget

public DashboardWidget addPieChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjNumber p_flat,
BBjNumber p_legend,
BBjRecordSet p_rs!,
BBjVector p_columns!)

Creates and returns a pie chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_rs! - BBjRecordSet which contains data for the embedded widget

p_columns! - BBjVector which contains the column names for the data for the embedded widget

Returns:

The created DashboardWidget

addPieChartDashboardWidget

public DashboardWidget addPieChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjNumber p_flat,
BBjNumber p_legend,
BBjNumber p_numSlices)

Creates and returns a pie chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_numSlices - Number of slices that will be in the pie chart

Returns:

The created DashboardWidget

addPieChartDashboardWidget

public DashboardWidget addPieChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjNumber p_flat,
BBjNumber p_legend)

Creates and returns a pie chart dashboard widget with an empty dataset

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

Returns:

The created DashboardWidget

addRingChartDashboardWidget

public DashboardWidget addRingChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjNumber p_flat,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$)

Creates and returns a ring chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

Returns:

The created DashboardWidget

addRingChartDashboardWidget

public DashboardWidget addRingChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjNumber p_flat,
BBjNumber p_legend,
BBjString p_connectString$,
BBjString p_sql$,
BBjString p_mode$)

Creates and returns a ring chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_connectString$ - JDBC connect string used to connect to the database

p_sql$ - SQL query used to provide data for the widget

p_mode$ - A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER = myusername, PWD = mypass, AUTOCOMMIT = N"

Returns:

The created DashboardWidget

Since:

BBj 16.00

addRingChartDashboardWidget

public DashboardWidget addRingChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjNumber p_flat,
BBjNumber p_legend,
BBjRecordSet p_rs!,
BBjVector p_columns!)

Creates and returns a ring chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_rs! - BBjRecordSet which contains data for the embedded widget

p_columns! - BBjVector which contains the column names for the data for the embedded widget

Returns:

The created DashboardWidget

addRingChartDashboardWidget

public DashboardWidget addRingChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjNumber p_flat,
BBjNumber p_legend,
BBjNumber p_numSlices)

Creates and returns a ring chart dashboard widget

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

p_numSlices - Number of slices that will be in the ring chart

Returns:

The created DashboardWidget

addRingChartDashboardWidget

public DashboardWidget addRingChartDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_chartTitle$,
BBjNumber p_flat,
BBjNumber p_legend)

Creates and returns a ring chart dashboard widget with an empty dataset

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_chartTitle$ - Title to be displayed above the chart (may be empty)

p_domainTitle$ - Title for the domain axis (may be empty)

p_rangeTitle$ - Title for the range axis (may be empty)

p_flat - Indicates whether the chart should be flat. 0 = 3D, 1 = Flat

p_orientation - Indicates whether the chart will be in portrait or landscape orientation. Example: orientation = LineChartWidget.getORIENTATION_VERTICAL()

p_legend - Indicates whether to show a legend for the chart. 0 = Do not show legend, 1 = Show legend

Returns:

The created DashboardWidget

addJasperViewerDashboardWidget

public DashboardWidget addJasperViewerDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBJasperReport p_report!)

Creates and returns a jasper viewer dashboard widget based the provided BBJasperReport

This method of creating a JasperViewerWidget is less efficient than the version that takes a report file, connection string, and parameter list as your code must create and fill the report before displaying the dashboard. Creating the widget with this method also requires that you register for the refresh callback event and refill the report yourself if you want the report to be updated when the widget is refreshed.

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_report! - BBJasperReport to show in the jasper viewer widget

Returns:

The created DashboardWidget

addJasperViewerDashboardWidget

public DashboardWidget addJasperViewerDashboardWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_reportFile$,
BBjString p_connectString$,
HashMap p_params!)

Creates and returns a jasper viewer dashboard widget with parameters so that the Dashboard Utility can create and fill the report before it displays the widget

This method is more efficient than the version that take a BBJasperReport object as the Dashboard Utility will create and fill the report just before displaying the widget. The other method requires that you create and fill the report before the dashboard is displayed, even if the widget is not on the first tab and will never be displayed. Additionally, creating the widget with this method will refill the report automatically whenever the widget is refreshed. Constructing the widget with the BBJasperReport object requires that you register for the refresh callback event and refill the report yourself if you want the report to be updated when the widget is refreshed.

Parameters:

p_name$ - Unique name of the widget

p_title$ - Title which will display in the title bar

p_previewText$ - Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title

p_previewImage$ - Location of a image used for preview, if empty then a dynamic image will be created

p_reportFile$ - The path to a jrxml or jasper report file

p_connectString$ - JDBC connect string used to connect to the database

p_params! - A HashMap containing parameters for the report which may be set to null() if the report doesn't require parameters

Returns:

The created DashboardWidget

Since:

BBj 18.20

addDashboardWidget

public DashboardWidget addDashboardWidget(Widget p_widget!)

Creates an active DashboardWidget based on the provided widget and adds it to the current category

Parameters:

p_widget! - Widget that will be used to create the dashboard widget

Returns:

The created DashboardWidget

addDashboardWidget

public DashboardWidget addDashboardWidget(Widget p_widget!,
BBjNumber p_active)

Creates an active or inactive DashboardWidget based on the provided widget and adds it to the current category

Parameters:

p_widget! - Widget that will be used to create the dashboard widget

p_active - Indicates if the dashboard widget should be active when added. 0 = inactive, 1 = active

Returns:

The created DashboardWidget

addDashboardWidget

public void addDashboardWidget(DashboardWidget p_dashboardWidget!)

Adds a dashboard widget to the end of the dashboard category

Parameters:

p_dashboardWidget! - DashboardWidget to add

getDashboardWidget

public DashboardWidget getDashboardWidget(BBjString p_widgetName$)

Returns a dashboard widget given its name

Parameters:

p_widgetName$ - Name of the dashboard wiget to obtain

Returns:

The found DashboardWidget or null()

dashboardWidgetExists

public BBjNumber dashboardWidgetExists(BBjString p_widgetName$)

Determines if a dashboard widget exists given its name

Parameters:

p_widgetName$ - Name of the dashboard wiget to test for existance

Returns:

Returns 1 if the dashboard widget exists, otherwise 0

removeDashboardWidget

public void removeDashboardWidget(BBjString p_widgetName$)

Removes a dashboard widget, causing all widgets with a higher position to be shifted down by one

Parameters:

p_widgetName$ - Name of the dashboard wiget to remove

updateDashboardWidget

public DashboardWidget updateDashboardWidget(BBjString p_widgetName$,
Widget p_widget!)

Updates a dashboard widget in the dashboard category

Parameters:

p_widgetName$ - Existing name of the dashboard widget to update

p_widget! - New widget

Returns:

Returns the updated dashboard widget

repositionDashboardWidget

public void repositionDashboardWidget(DashboardWidget p_dashboardWidget!,
BBjNumber p_destPosition)

Repositions a dashboard widget by inserting it at the specified destination position, shifting all remaining widgets one position higher

Parameters:

p_dashboardWidget! - DashboardWidget to resposition

p_destPosition - Destination position

getDashboardWidgetPosition

public BBjNumber getDashboardWidgetPosition(DashboardWidget p_dashboardWidget!)

Returns the position of a dashboard widget

Parameters:

p_dashboardWidget! - DashboardWidget to get the position for

Returns:

The position of the dashboard widget

getNumDashboardWidgets

public BBjNumber getNumDashboardWidgets()

Returns the number of dashboard widgets

Returns:

The number of dashboard widgets

getDashboardWidgets

public BBjVector getDashboardWidgets()

Returns the dashboard widgets in a BBjVector

Returns:

BBjVector containing the dashboard widgets

getDefaultMinWidgetWidth

public BBjNumber getDefaultMinWidgetWidth()

Returns the default minimum widget width

Returns:

BBjNumber containing the default minimum widget width

getDefaultMaxWidgetWidth

public BBjNumber getDefaultMaxWidgetWidth()

Returns the default maximum widget width

Returns:

BBjNumber containing the default maximum widget width

getDefaultColSpacing

public BBjNumber getDefaultColSpacing()

Returns the default col spacing between widgets

Returns:

BBjNumber containing the default col spacing between widgets

getDefaultRowSpacing

public BBjNumber getDefaultRowSpacing()

Returns the default row spacing between widgets

Returns:

BBjNumber containing the default row spacing between widgets

destroy

public void destroy()

Destroys the dashboard category and destroys all dashboardWidgets contained in the category

setWidgetTitlebarNameBackColor

public void setWidgetTitlebarNameBackColor(BBjColor p_color!)

Sets the title bar name background color of the widgets

Parameters:

p_color! - BBjColor that specifies the color

setWidgetTitlebarNameForeColor

public void setWidgetTitlebarNameForeColor(BBjColor p_color!)

Sets the title bar name foreground color of the widgets

Parameters:

p_color! - BBjColor that specifies the color

setWidgetTitlebarNameFont

public void setWidgetTitlebarNameFont(Font p_font!)

Sets the title bar font of the widgets

Parameters:

p_font! - A Font to be used for the title bar of the widgets

setWidgetTitlebarNameFont

public void setWidgetTitlebarNameFont(BBjString p_fontFile$,
BBjNumber p_style,
BBjNumber p_fontSize)

Sets the title bar font of the widgets

You may specify any font given a fully qualified path, a font name or path that can be found via the current PREFIX setting, or any font located in the /utils/dashboard/fonts directory.

Parameters:

p_fontFile$ - A string that contains the path to the font file.

setWidgetTitlebarNameSelectedBackColor

public void setWidgetTitlebarNameSelectedBackColor(BBjColor p_color!)

Sets the title bar name selected background color of the widgets

Parameters:

p_color! - BBjColor that specifies the color

setWidgetTitlebarDecorationBackColor

public void setWidgetTitlebarDecorationBackColor(BBjColor p_color!)

Sets the title bar decoration background color of the widgets

Parameters:

p_color! - BBjColor that specifies the color

setWidgetTitlebarDecorationSelectedBackColor

public void setWidgetTitlebarDecorationSelectedBackColor(BBjColor p_color!)

Sets the title bar decoration selected background color of the widgets

Parameters:

p_color! - BBjColor that specifies the color

setWidgetTitlebarSeparatorColor

public void setWidgetTitlebarSeparatorColor(BBjColor p_color!)

Sets the title bar separator background color of the widgets

Parameters:

p_color! - BBjColor that specifies the color

setWidgetTitlebarSeparatorSelectedColor

public void setWidgetTitlebarSeparatorSelectedColor(BBjColor p_color!)

Sets the title bar separator selected background color of the widgets

Parameters:

p_color! - BBjColor that specifies the color

setWidgetBorderColor

public void setWidgetBorderColor(BBjColor p_color!)

Sets the border color of the widgets

Parameters:

p_color! - BBjColor that specifies the color

setWidgetBorderSelectedColor

public void setWidgetBorderSelectedColor(BBjColor p_color!)

Sets the border selected color of the widgets

Parameters:

p_color! - BBjColor that specifies the color