public class DashboardWidgetFilterSelectEvent extends DashboardWidgetEvent
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.
WidgetControl! | 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 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. |
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. |
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. |
| Modifier and Type | Method and Description |
|---|---|
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. |
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 |
getDashboardWidget 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.
p_dashboardWidget! The DashboardWidget that is associated with the eventp_filterName$ Unique name for the filterp_filterKey$ Key of the filterp_filterValue$ Value of the filterpublic 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.
p_dashboardWidget! The DashboardWidget that is associated with the eventp_filterName$ Unique name for the filterp_filterKey$ Key of the filterp_filterValue$ Value of the filterp_filterType Type of filter BBj 16.00public 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.
p_dashboardWidget! The DashboardWidget that is associated with the eventp_filterName$ Unique name for the filterp_filterKey$ Key of the filterp_filterValue$ Value of the filterp_filterType Type of filterp_filterControl! The DashboardWidgetFilter's underlying BBjControl, such as the BBjListButton, BBjListEdit, etc. BBj 17.00public 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.
BBj 17.00public BBjString getFilterKey()Returns the key of a dashboard widget filter select event
public BBjString getFilterName()Returns the name of a dashboard widget filter select event
public BBjNumber getFilterType()Returns the filter type of a dashboard widget filter select event
BBj 16.00public BBjString getFilterValue()Returns the value of a dashboard widget filter select event