| Class | Description |
|---|---|
| AlphaColor | |
| AreaChartWidget | AreaChartWidget A Dashboard Utility Widget that displays an area chart which is similar to a filled Line Chart |
| AutoRefreshUnit | AutoRefreshUnit Data class for an auto refresh unit The AutoRefreshUnit is used with DashboardWidgets that contain a refreshable widget. The DashboardWidget has a setAutoRefreshUnit() method that takes an AutoRefreshUnit as a parameter. |
| BBjWidget | BBjWidget Creates a widget that is implemented as a BBjControl |
| BarChartWidget | BarChartWidget A Dashboard Utility Widget that displays a bar chart that can display multiple groups of bars by providing a rowKey, colKey, and value for each dataset entry |
| BaseWidget | BaseWidget Creates a widget base class that implements the Widget interface |
| CallbackInfo | |
| CategoryDataItem | CategoryDataItem A CategoryDataItem extends the base DataItem class and is used for various charts including BarCharts, LineCharts, and AreaCharts. It is used as a return value from method calls that retrieve data from a chart given a location, which is what happens by default when the user left-clicks on a chart data entity.
A CategoryDataItem describes a dataset with one or more series and values associated with categories.
The data for these charts will be in the format of:
So if the dataset consists of 3 CategoryDataItems, all with unique row and column keys, there will be a total of 9 bars drawn on the chart. That is because there are 3 columns, and there will be 3 bars per column - one for each row. It is also possible to make all row keys the same in a dataset. In this case the sample dataset still consists of 3 CategoryDataItems, but only the column keys are unique. This results in a chart with only 3 bars instead of 9. In this case, since the row keys are all the same, there will be a single item in the chart's legend. Because of this, it is common to hide the legend since it does not provide any additional value. The domain axis will have 3 entries, one for each column key, containing a single bar. |
| ChartWidget | ChartWidget The base chart class that all the other charts extend. The ChartWidget allows you to set various properties that apply to all or most chart types. It also offers utility methods to set colors, pick color themes, and manipulate colors' saturation, lightness, opacity, and more. |
| ColorWithOpacity | |
| Dashboard | Dashboard Data class that encapsulates the entities that comprise a dashboard |
| DashboardCategory | DashboardCategory Data class that encapsulates the entities which comprise a dashboard category |
| DashboardCategoryAttribute | DashboardCategoryAttribute Data class for attributes of a dashboard category |
| DashboardCategoryControl | DashboardCategoryControl UI class that displays a dashboard category |
| DashboardControl | DashboardControl UI class that displays a dashboard in a BBjChildWindow |
| DashboardItem | DashboardItem The base dashboard class that all of the other dashboard data classes extend |
| DashboardWidget | DashboardWidget Data class that encapsulates the entities which comprise a dashboard widget |
| DashboardWidgetAttribute | DashboardWidgetAttribute Data class for attributes of a dashboard widget |
| DashboardWidgetClickEvent | DashboardWidgetClickEvent Class that contains mouse click event information for a DashboardWidget This data class will be made available to your custom callback routine after the user executes a click on the DashboardWidget if you have previously executed the DashboardWidget::setCallback() method to register for the ON_WIDGET_CLICK event. This event is independent of the mouse button (left, middle, right) and overrides any callbacks associated with the ON_WIDGET_LEFT_CLICK or ON_WIDGET_RIGHT_CLICK event types. |
| DashboardWidgetControl | DashboardWidgetControl UI class that displays a dashboard widget |
| DashboardWidgetEvent | DashboardWidgetEvent Class that contains event information for a DashboardWidget. This is the base class for all dashboard widget events. |
| DashboardWidgetFilter | DashboardWidgetFilter Data class for the filter of a dashboard widget The dashboard utility uses this method internally when you execute the DashboardWidget::addFilter() method to create a DashboardWidgetFilter and add it to an existing DashboardWidget |
| DashboardWidgetFilterSelectEvent | DashboardWidgetFilterSelectEvent Class that contains widget filter select event information for a DashboardWidget This data class will be made available to your custom callback routine after the user selects a filter item from a custom DashboardWidgetFilter if you have previously executed the DashboardWidget::setCallback() method to register for the ON_FILTER_SELECT event. |
| DashboardWidgetLeftClickEvent | DashboardWidgetLeftClickEvent Class that contains mouse click event information for a DashboardWidget This data class will be made available to your custom callback routine after the user executes a left click on the DashboardWidget if you have previously executed the DashboardWidget::setCallback() method to register for the ON_WIDGET_LEFT_CLICK event. |
| DashboardWidgetLink | DashboardWidgetLink Data class for a link of a dashboard widget The dashboard utility uses this method internally when you execute the DashboardWidget::addLink() method to create a DashboardWidgetLink and add it to an existing DashboardWidget |
| DashboardWidgetLinkSelectEvent | DashboardWidgetLinkSelectEvent Class that contains widget link select event information for a DashboardWidget This data class will be made available to your custom callback routine after the user selects a link item from a custom DashboardWidgetLink if you have previously executed the DashboardWidget::setCallback() method to register for the ON_LINK_SELECT event. |
| DashboardWidgetMenu | DashboardWidgetMenu Data class for a custom popup menu associated with a dashboard widget The dashboard utility uses this method internally when you execute the DashboardWidget::addMenu() method to create a DashboardWidgetMenu and add it to an existing DashboardWidget |
| DashboardWidgetMenuSelectEvent | DashboardWidgetMenuSelectEvent Class that contains the custom menu item selection event information for a DashboardWidget This data class will be made available to your custom callback routine after the user selects a menu item from a custom DashboardWidgetMenu if you have previously executed the DashboardWidgetMenu::setCallback() method to register for the ON_POPUP_ITEM_SELECT event. |
| DashboardWidgetRefreshEvent | DashboardWidgetRefreshEvent Class that contains refresh event information for a DashboardWidget This data class will be made available to your custom callback routine after a refresh has been triggered if you have previously executed the DashboardWidget::setCallback() method to register for the ON_WIDGET_REFRESH event. |
| DashboardWidgetRightClickEvent | DashboardWidgetRightClickEvent Class that contains mouse click event information for a DashboardWidget This data class will be made available to your custom callback routine after the user executes a right click on the DashboardWidget if you have previously executed the DashboardWidget::setCallback() method to register for the ON_WIDGET_RIGHT_CLICK event. |
| DashboardWidgetSelectEvent | DashboardWidgetSelectEvent Class that contains select event information for a DashboardWidget This data class will be made available to your custom callback routine after the user selects DashboardWidget if you have previously executed the DashboardWidget::setCallback() method to register for the ON_WIDGET_SELECT event. |
| DashboardWindow | DashboardWindow UI class that displays a dashboard in a BBjTopLevelWindow |
| DataItem | DataItem Base class for an item of data See the classes that extend this class for more details, such as the CategoryDataItem, KeyedValueDataItem, and XYSeriesDataItem |
| EmbeddedWidget | EmbeddedWidget Class that is used to embedded widget |
| EmbeddedWidgetControl | EmbeddedWidgetControl Class that is used to display a embedded widget in a control |
| EmbeddedWidgetFactory | EmbeddedWidgetFactory Factory class that is used to create embedded widgets |
| EmbeddedWidgetSet | EmbeddedWidgetSet Class that is used to embedded a widget set |
| EmbeddedWidgetSetControl | EmbeddedWidgetSetControl Class that is used to display a embedded widget set in a control |
| EmbeddedWidgetSetWindow | EmbeddedWidgetSetWindow Class that is used to display a embedded widget set in a window |
| EmbeddedWidgetWindow | EmbeddedWidgetWindow Class that is used to display a embedded widget in a window |
| ExportData | ExportData Exports data from record sets, grids, and data sets to an ASCII file that can use various field and record delimiters, as well as diffent string qualifiers. |
| ExportDataDialog | ExportDataDialog Provides a dialog which displays a UI to faciliate the exportation the data. |
| GridExWidget | GridExWidget A Dashboard Utility Widget that displays data in a BBjGridExWidget, a BBj plug-in available from the BBj Plugin Manager The GridExWidget is based on the BBjGridExWidget plug-in which is a fast, full-featured grid that offers filtering, grouping, pinning, pivoting, and rules-based styling. |
| GridWidget | GridWidget A Dashboard Utility Widget that displays data in a grid |
| GridWidgetEvent | GridWidgetEvent Class that contains event information for a GridWidget |
| GridWidgetRefreshEvent | GridWidgetRefreshEvent Class that contains event information for a GridWidget that has just refreshed |
| HtmlViewWidget | HtmlViewWidget A Dashboard Utility Widget that displays html text or the contents of a URL |
| HtmlViewWidgetEvent | HtmlViewWidgetEvent Contains information for an HtmlViewWidget event that can be registered using the setCallback() method on the HtmlViewWidget {@link Dashboard.HtmlViewWidget#setCallback()} has an example |
| ImageWidget | ImageWidget A Dashboard Utility Widget that displays an image retrieved from a file path or a URL |
| JasperViewerWidget | JasperViewerWidget A Dashboard Utility Widget that displays JasperReport where the user can view, perform drill downs, print and save reports to disk in various formats |
| JasperViewerWidgetControlEvent | JasperViewerWidgetControlEvent Contains information for a jasper viewer widget control event |
| KeyedValueDataItem | KeyedValueDataItem A KeyedValueDataItem extends the base DataItem class and is used for PieCharts and RingCharts. It is used as a return value from method calls that retrieve data from a chart given a location, which is what happens by default when the user left-clicks on a chart data entity.
A KeyedValueDataItem describes a dataset item comprising of a key and value.
The data for these charts will be in the format of:
|
| LineChartWidget | LineChartWidget A Dashboard Utility Widget that displays a line chart which can display multiple data series simultaneously |
| PieChartWidget | PieChartWidget A Dashboard Utility Widget that displays a pie chart where the data values all add up to 100% |
| RecordsetSeries | An BBjRecordset-based data class used with XYCharts. An XYChart's dataset is an XYSeriesCollection, which contains one ore more series of data. |
| RingChartWidget | RingChartWidget A Dashboard Utility Widget that displays a ring or doughnut chart, which is similar to a pie chart with the middle cut out |
| SQLSeries | An SQL-based data class used with XYCharts. An XYChart's dataset is an XYSeriesCollection, which contains one ore more series of data. |
| Series | A data class used with XYCharts. An XYChart's dataset is an XYSeriesCollection, which contains one ore more series of data. |
| ShadowColor | |
| StackedAreaChartWidget | AreaChartWidget A Dashboard Utility Widget that displays a stacked area chart which is similar to an area chart except that each series is drawn directly above the previous series |
| StackedBarChartWidget | StackedBarChartWidget A Dashboard Utility Widget that displays a stacked bar chart where the bars for each column key are stacked upon one another |
| StackedPercentageBarChartWidget | StackedPercentageBarChartWidget A Dashboard Utility Widget that displays a stacked percentage-based bar chart where you provide a data value and the remainder of the bar will be filled in up to 100% with a translucent version of the bar |
| WidgetControl | WidgetControl UI class that displays a widget |
| XYChartWidget | XYChartWidget A Dashboard Utility Widget that displays an XY line chart that can display multiple data series simultaneously |
| XYSeriesDataItem | XYSeriesDataItem An XYSeriesDataItem extends the base DataItem class and is used for XYCharts. It is used as a return value from method calls that retrieve data from a chart given a location, which is what happens by default when the user left-clicks on a chart data entity. A XYSeriesDataItem describes a dataset item comprising of one or more series (with a series number and associated key), the item in the series, and the X and Y values for the item. |
| Interface | Description |
|---|---|
| DataFillableWidget | DataFillableWidget Interface that facilitates the filling of the underlying dataset of the widget |
| EmailableWidget | EmailableWidget Interface that facilitates emailing of the widget |
| RefreshableWidget | RefreshableWidget Interface that facilitates refreshing the widget |
| SaveableWidget | SaveableWidget Interface that facilitates saving of the widget |
| Widget | Widget Interface that comprises all the functionality required to be a widget |