Dashboard

Class DashboardWidgetFilterSelectEvent

java.lang.Object

Dashboard.DashboardWidgetEvent

Dashboard.DashboardWidgetFilterSelectEvent

public class DashboardWidgetFilterSelectEvent
extends DashboardWidgetEvent

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.

Field Summary

Fields inherited from class Dashboard.DashboardWidgetEvent

WidgetControl!

Constructor Summary

Constructors

Constructor and Description
DashboardWidgetFilterSelectEvent(DashboardWidget p_dashboardWidget!, BBjString p_filterName$, BBjString p_filterKey$, BBjString p_filterValue$) Contructs a DashboardWidgetFilterSelectEvent with the default filter type of FILTER_TYPE_LISTBUTTON
DashboardWidgetFilterSelectEvent(DashboardWidget p_dashboardWidget!, BBjString p_filterName$, BBjString p_filterKey$, BBjString p_filterValue$, BBjNumber p_filterType) Contructs a DashboardWidgetFilterSelectEvent specifying the type of filter
DashboardWidgetFilterSelectEvent(DashboardWidget p_dashboardWidget!, BBjString p_filterName$, BBjString p_filterKey$, BBjString p_filterValue$, BBjNumber p_filterType, BBjControl p_filterControl!) Contructs a DashboardWidgetFilterSelectEvent specifying the type of filter

Method Summary

Modifier and Type	Method and Description
BBjControl	getFilterControl() Returns the filter's underlying BBjControl, such as a BBjListButton, BBjEditBox, etc.
BBjString	getFilterKey() Returns the key of a dashboard widget filter select event
BBjString	getFilterName() Returns the name of a dashboard widget filter select event
BBjNumber	getFilterType() Returns the filter type of a dashboard widget filter select event
BBjString	getFilterValue() Returns the value of a dashboard widget filter select event

Methods inherited from class Dashboard.DashboardWidgetEvent

getDashboardWidget

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardWidgetFilterSelectEvent

public DashboardWidgetFilterSelectEvent(DashboardWidget p_dashboardWidget!,
BBjString p_filterName$,
BBjString p_filterKey$,
BBjString p_filterValue$)

Contructs a DashboardWidgetFilterSelectEvent with the default filter type of FILTER_TYPE_LISTBUTTON

The dashboard utility uses this method internally to create a DashboardWidgetFilterSelectEvent. After the user selects a DashboardWidgetFilter item the WidgetControl uses this method to create a DashboardWidgetFilterSelectEvent that is then passed to your callback routine.

Parameters:

p_dashboardWidget! - The DashboardWidget that is associated with the event

p_filterName$ - Unique name for the filter

p_filterKey$ - Key of the filter

p_filterValue$ - Value of the filter

DashboardWidgetFilterSelectEvent

public DashboardWidgetFilterSelectEvent(DashboardWidget p_dashboardWidget!,
BBjString p_filterName$,
BBjString p_filterKey$,
BBjString p_filterValue$,
BBjNumber p_filterType)

Contructs a DashboardWidgetFilterSelectEvent specifying the type of filter

The dashboard utility uses this method internally to create a DashboardWidgetFilterSelectEvent. After the user selects a DashboardWidgetFilter item the WidgetControl uses this method to create a DashboardWidgetFilterSelectEvent that is then passed to your callback routine.

Parameters:

p_dashboardWidget! - The DashboardWidget that is associated with the event

p_filterName$ - Unique name for the filter

p_filterKey$ - Key of the filter

p_filterValue$ - Value of the filter

p_filterType - Type of filter

Since:

BBj 16.00

DashboardWidgetFilterSelectEvent

public DashboardWidgetFilterSelectEvent(DashboardWidget p_dashboardWidget!,
BBjString p_filterName$,
BBjString p_filterKey$,
BBjString p_filterValue$,
BBjNumber p_filterType,
BBjControl p_filterControl!)

Contructs a DashboardWidgetFilterSelectEvent specifying the type of filter

The dashboard utility uses this method internally to create a DashboardWidgetFilterSelectEvent. After the user selects a DashboardWidgetFilter item the WidgetControl uses this method to create a DashboardWidgetFilterSelectEvent that is then passed to your callback routine.

Parameters:

p_dashboardWidget! - The DashboardWidget that is associated with the event

p_filterName$ - Unique name for the filter

p_filterKey$ - Key of the filter

p_filterValue$ - Value of the filter

p_filterType - Type of filter

p_filterControl! - The DashboardWidgetFilter's underlying BBjControl, such as the BBjListButton, BBjListEdit, etc.

Since:

BBj 17.00

Method Detail

getFilterName

public BBjString getFilterName()

Returns the name of a dashboard widget filter select event

Returns:

Filter name of the dashboard filter select event

getFilterKey

public BBjString getFilterKey()

Returns the key of a dashboard widget filter select event

Returns:

Filter key of the dashboard filter select event

getFilterValue

public BBjString getFilterValue()

Returns the value of a dashboard widget filter select event

Returns:

Filter value of the dashboard filter select event

getFilterType

public BBjNumber getFilterType()

Returns the filter type of a dashboard widget filter select event

Returns:

Filter type. Values can be DashboardWidget.getFILTER_TYPE_LISTBUTTON(), DashboardWidget.getFILTER_TYPE_LISTEDIT(), DashboardWidget.getFILTER_TYPE_EDITBOX()

Since:

BBj 16.00

getFilterControl

public BBjControl getFilterControl()

Returns the filter's underlying BBjControl, such as a BBjListButton, BBjEditBox, etc.

This means that you can then modify the filter control directly, such as using the BBjListButton::selectIndex method to select the desired index in a BBjListButton-based filter. If you choose to programmatically modify the selected value from the underlying BBjControl, you should also execute the setKey() and setValue() methods on the DashboardWidgetFilter object to ensure that the model and the view are in sync.

Returns:

The BBjControl on which the filter is based

Since:

BBj 17.00