Dashboard

Class DashboardWidgetRefreshEvent

java.lang.Object

Dashboard.DashboardWidgetEvent

Dashboard.DashboardWidgetRefreshEvent

public class DashboardWidgetRefreshEvent
extends DashboardWidgetEvent

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.

Field Summary

Fields

Modifier and Type	Field and Description
static BBjNumber	REFRESH_TYPE_AUTO
static BBjNumber	REFRESH_TYPE_CATEGORY
static BBjNumber	REFRESH_TYPE_WIDGET

Fields inherited from class Dashboard.DashboardWidgetEvent

WidgetControl!

Constructor Summary

Constructors

Constructor and Description
DashboardWidgetRefreshEvent(DashboardWidget p_dashboardWidget!) Contructs a DashboardWidgetRefreshEvent
DashboardWidgetRefreshEvent(DashboardWidget p_dashboardWidget!, BBjNumber p_refreshType) Contructs a DashboardWidgetRefreshEvent specifying the refresh type

Method Summary

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.

Methods inherited from class Dashboard.DashboardWidgetEvent

getDashboardWidget

Methods inherited from class java.lang.Object

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

Field Detail

REFRESH_TYPE_WIDGET

public static BBjNumber REFRESH_TYPE_WIDGET

REFRESH_TYPE_CATEGORY

public static BBjNumber REFRESH_TYPE_CATEGORY

REFRESH_TYPE_AUTO

public static BBjNumber REFRESH_TYPE_AUTO

Constructor Detail

DashboardWidgetRefreshEvent

public 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.

Parameters:

p_dashboardWidget! - The DashboardWidget that is associated with the event

DashboardWidgetRefreshEvent

public 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.

Parameters:

p_dashboardWidget! - The DashboardWidget that is associated with the event

Since:

BBj 17.00

Method Detail

getRefreshType

public BBjNumber getRefreshType()

Returns the type of refresh (a constant defined in the ChartWidget class) based on what initiated the event.

Returns:

BBjNumber The refresh type based on a constant defined in the DashboardWidgetRefreshEvent class. This can be compared to the available constants, such as DashboardWidgetRefreshEvent.getREFRESH_TYPE_WIDGET().

Since:

BBj 17.00