public class 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
Modifier and Type | Field and Description |
---|---|
BBjNumber | DockLocation Dock location of the filter |
Map | Entries! LinkedHashMap that contains filter key/value pairs |
static BBjNumber | FILTER_TYPE_EDITBOX=2 Constant for Editbox-based filter, optionally used when constructing a DashboardWidgetFilter. |
static BBjNumber | FILTER_TYPE_LISTBUTTON=0 Constant for a BBjListButton-based filter, optionally used when constructing a DashboardWidgetFilter. |
static BBjNumber | FILTER_TYPE_LISTEDIT=1 Constant for BBjListEdit-based filter, optionally used when constructing a DashboardWidgetFilter. |
CustomObject | FilterSelectCallbackObject! CustomObject that constains the callback routine to handle a filter select event |
BBjString | FilterSelectCallbackRoutine! Callback routine to handle a filter select event |
BBjString | FilterSelectEventName! Name of the filter select event |
BBjNumber | FilterType Type of filter |
BBjString | Key$ Filter key |
BBjString | Name$ Filter name |
static BBjNumber | ON_FILTER_SELECT=1 Constant for a filter select event, used in the setCallback() method |
BBjString | Placeholder! Placeholder text to be shown when the filter is of type FILTER_TYPE_LISTEDIT or FILTER_TYPE_EDITBOX and the control is empty |
BBjString | ToolTip$ Tooltip to be displayed when the mouse is hovered over the filter |
BBjString | Value$ Filter value |
Constructor and Description |
---|
DashboardWidgetFilter(BBjString p_name$, LinkedHashMap p_entries!, BBjString p_toolTip$, BBjNumber p_dockLocation) Constructs a DashboardWidgetFilter using default filter type of FILTER_TYPE_LISTBUTTON 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 |
DashboardWidgetFilter(BBjString p_name$, LinkedHashMap p_entries!, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_filterType) Constructs a DashboardWidgetFilter specifying default filter type 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 |
Modifier and Type | Method and Description |
---|---|
DashboardWidgetFilter | clone() Creates and returns a clone of the DashboardWidgetFilter |
void | destroy() Destroys the filter |
BBjString | getFilterKey(BBjString p_filterValue$) Returns the filter key for a specified filter value |
BBjString | getFilterValue(BBjString p_filterKey$) Returns the filter value for a specified filter key |
void | selectFilter(BBjString p_filterKey$) Select an item in the filter's Entries! LinkedHashMap by providing the item's key. If the key exists in the LinkedHashMap then the filter's Key$ and Value$ variables will be set to this item. |
void | setCallback(BBjNumber p_event, BBjString p_callbackRoutine!) Sets a callback for a dashboard widget filter event After you create a DashboardWidgetFilter object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to a menu selection event. The WidgetControl automatically responds to the user selecting an item from the filter, creates the relevant DashboardWidgetFilterSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event. |
void | setCallback(BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) Sets a callback for a dashboard widget filter event After you create a DashboardWidgetFilter object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to a menu selection event. The WidgetControl automatically responds to the user selecting an item from the filter, creates the relevant DashboardWidgetFilterSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event. |
public BBjNumber DockLocation
Dock location of the filter
public Map Entries!
LinkedHashMap that contains filter key/value pairs
public static BBjNumber FILTER_TYPE_EDITBOX=2
Constant for Editbox-based filter, optionally used when constructing a DashboardWidgetFilter.
BBj 16.10
public static BBjNumber FILTER_TYPE_LISTBUTTON=0
Constant for a BBjListButton-based filter, optionally used when constructing a DashboardWidgetFilter.
BBj 16.10
public static BBjNumber FILTER_TYPE_LISTEDIT=1
Constant for BBjListEdit-based filter, optionally used when constructing a DashboardWidgetFilter.
BBj 16.10
public CustomObject FilterSelectCallbackObject!
CustomObject that constains the callback routine to handle a filter select event
public BBjString FilterSelectCallbackRoutine!
Callback routine to handle a filter select event
public BBjString FilterSelectEventName!
Name of the filter select event
public BBjNumber FilterType
Type of filter
public BBjString Key$
Filter key
public BBjString Name$
Filter name
public static BBjNumber ON_FILTER_SELECT=1
Constant for a filter select event, used in the setCallback() method
public BBjString Placeholder!
Placeholder text to be shown when the filter is of type FILTER_TYPE_LISTEDIT or FILTER_TYPE_EDITBOX and the control is empty
public BBjString ToolTip$
Tooltip to be displayed when the mouse is hovered over the filter
public BBjString Value$
Filter value
public DashboardWidgetFilter(BBjString p_name$, LinkedHashMap p_entries!, BBjString p_toolTip$, BBjNumber p_dockLocation)
Constructs a DashboardWidgetFilter using default filter type of FILTER_TYPE_LISTBUTTON
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
p_name$
Unique name of the filterp_entries!
LinkedHashMap of filter keys/valuesp_toolTip$
Tool tip the filterp_dockLocation
Dock location of the filter. Values can be DashboardWidget.getDOCK_LEFT() or DashboardWidget.getDOCK_RIGHT()public DashboardWidgetFilter(BBjString p_name$, LinkedHashMap p_entries!, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_filterType)
Constructs a DashboardWidgetFilter specifying default filter type
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
p_name$
Unique name of the filterp_entries!
LinkedHashMap of filter keys/valuesp_toolTip$
Tool tip the filterp_dockLocation
Dock location of the filter. Values can be DashboardWidget.getDOCK_LEFT() or DashboardWidget.getDOCK_RIGHT()p_filterType
Type of filter control. Values can be DashboardWidget.getFILTER_TYPE_LISTBUTTON(), DashboardWidget.getFILTER_TYPE_LISTEDIT(), DashboardWidget.getFILTER_TYPE_EDITBOX() BBj 16.00
public DashboardWidgetFilter clone()
Creates and returns a clone of the DashboardWidgetFilter
public void destroy()
Destroys the filter
public BBjString getFilterKey(BBjString p_filterValue$)
Returns the filter key for a specified filter value
p_filterValue$
Filter value to obtain the key forpublic BBjString getFilterValue(BBjString p_filterKey$)
Returns the filter value for a specified filter key
p_filterKey$
Filter key to obtain the value forpublic void selectFilter(BBjString p_filterKey$)
Select an item in the filter's Entries! LinkedHashMap by providing the item's key. If the key exists in the LinkedHashMap then the filter's Key$ and Value$ variables will be set to this item.
p_filterKey$
Filter key to selectpublic void setCallback(BBjNumber p_event, BBjString p_callbackRoutine!)
Sets a callback for a dashboard widget filter event
After you create a DashboardWidgetFilter object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to a menu selection event. The WidgetControl automatically responds to the user selecting an item from the filter, creates the relevant DashboardWidgetFilterSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.
p_event
Indicates the event registering for. Value is always DashboardWidgetFilter.getON_FILTER_SELECT().p_callbackRoutine!
Routine to call when the event is triggeredpublic void setCallback(BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine!)
Sets a callback for a dashboard widget filter event
After you create a DashboardWidgetFilter object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to a menu selection event. The WidgetControl automatically responds to the user selecting an item from the filter, creates the relevant DashboardWidgetFilterSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.
p_event
Indicates the event registering for. Value is always DashboardWidgetFilter.getON_FILTER_SELECT().p_callbackObject!
CustomObject that contains the routine to call when the event is triggeredp_callbackRoutine!
Routine to call when the event is triggered