public class DashboardWidgetRefreshEvent extends DashboardWidgetEvent
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.
| Modifier and Type | Field and Description |
|---|---|
static BBjNumber | REFRESH_TYPE_AUTO=2A constant for a refresh initiated by the widget's AutoRefresh timer, used in conjunction with the getRefreshType() method. |
static BBjNumber | REFRESH_TYPE_CATEGORY=1A constant for a refresh initiated by the category's Refresh button, used in conjunction with the getRefreshType() method. |
static BBjNumber | REFRESH_TYPE_WIDGET=0A constant for a refresh initiated by the widget's Refresh menu or toolbutton, used in conjunction with the getRefreshType() method. |
WidgetControl! | Constructor and Description |
|---|
DashboardWidgetRefreshEvent(DashboardWidget p_dashboardWidget!)Contructs a DashboardWidgetRefreshEvent The dashboard utility uses this method internally to create a DashboardWidgetRefreshEvent. After a widget's refresh event has been triggered the WidgetControl uses this method to create a DashboardWidgetRefreshEvent that is then passed to your callback routine. |
DashboardWidgetRefreshEvent(DashboardWidget p_dashboardWidget!, BBjNumber p_refreshType)Contructs a DashboardWidgetRefreshEvent specifying the refresh type The dashboard utility uses this method internally to create a DashboardWidgetRefreshEvent. After a widget's refresh event has been triggered the WidgetControl uses this method to create a DashboardWidgetRefreshEvent that is then passed to your callback routine. |
| Modifier and Type | Method and Description |
|---|---|
BBjNumber | getRefreshType()Returns the type of refresh (a constant defined in the ChartWidget class) based on what initiated the event. |
getDashboardWidget public static BBjNumber REFRESH_TYPE_AUTO=2A constant for a refresh initiated by the widget's AutoRefresh timer, used in conjunction with the getRefreshType() method.
BBj 17.00public static BBjNumber REFRESH_TYPE_CATEGORY=1A constant for a refresh initiated by the category's Refresh button, used in conjunction with the getRefreshType() method.
BBj 17.00public static BBjNumber REFRESH_TYPE_WIDGET=0A constant for a refresh initiated by the widget's Refresh menu or toolbutton, used in conjunction with the getRefreshType() method.
BBj 17.00public DashboardWidgetRefreshEvent(DashboardWidget p_dashboardWidget!)Contructs a DashboardWidgetRefreshEvent
The dashboard utility uses this method internally to create a DashboardWidgetRefreshEvent. After a widget's refresh event has been triggered the WidgetControl uses this method to create a DashboardWidgetRefreshEvent that is then passed to your callback routine.
p_dashboardWidget! The DashboardWidget that is associated with the eventpublic DashboardWidgetRefreshEvent(DashboardWidget p_dashboardWidget!, BBjNumber p_refreshType)Contructs a DashboardWidgetRefreshEvent specifying the refresh type
The dashboard utility uses this method internally to create a DashboardWidgetRefreshEvent. After a widget's refresh event has been triggered the WidgetControl uses this method to create a DashboardWidgetRefreshEvent that is then passed to your callback routine.
p_dashboardWidget! The DashboardWidget that is associated with the event BBj 17.00public BBjNumber getRefreshType()Returns the type of refresh (a constant defined in the ChartWidget class) based on what initiated the event.
BBj 17.00