Class sap.m.ViewSettingsFilterItemModule: sap/m/ViewSettingsFilterItem

extends ViewSettingsItem

A ViewSettingsFilterItem control is used for modelling filter behaviour in the ViewSettingsDialog. It is derived from a core Item, but does not support the base class properties like textDirection and enabled. Setting these properties will not have any effects.


Since: 1.16.
Constructor Summary
new sap.m.ViewSettingsFilterItem(sId?, mSettings?)Constructor for a new ViewSettingsFilterItem.
Event Summary
filterDetailItemsAggregationChange(oControlEvent)Let the outside world know that the filter detail aggregation was changed.
Events borrowed from class sap.m.ViewSettingsItem
itemPropertyChanged
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.ViewSettingsFilterItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.ViewSettingsFilterItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.ViewSettingsFilterItem.getMetadata()Returns a metadata object for class sap.m.ViewSettingsFilterItem.
addItem(oItem)Adds some item to the aggregation items.
attachFilterDetailItemsAggregationChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the filterDetailItemsAggregationChange event of this sap.m.ViewSettingsFilterItem.
bindItems(oBindingInfo)Binds aggregation items to model data.
destroyItems()Destroys all the items in the aggregation items.
detachFilterDetailItemsAggregationChange(fnFunction, oListener)Detaches event handler fnFunction from the filterDetailItemsAggregationChange event of this sap.m.ViewSettingsFilterItem.
fireFilterDetailItemsAggregationChange(mArguments?)Fires event filterDetailItemsAggregationChange to attached listeners.
getItems()Gets content of aggregation items.
getMultiSelect()Gets current value of property multiSelect.
indexOfItem(oItem)Checks for the provided sap.m.ViewSettingsItem in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setMultiSelect(bMultiSelect)Sets a new value for property multiSelect.
unbindItems()Unbinds aggregation items from model data.
Methods borrowed from class sap.m.ViewSettingsItem
attachItemPropertyChanged, detachItemPropertyChanged, fireItemPropertyChanged, getSelected, setSelected
Methods borrowed from class sap.ui.core.Item
getEnabled, getKey, getText, getTextDirection, setEnabled, setKey, setText, setTextDirection
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.m.ViewSettingsFilterItem(sId?, mSettings?)
Constructor for a new ViewSettingsFilterItem.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.m.ViewSettingsItem can be used as well.

Parameters:
{string}sId? ID for the new control, generated automatically if no ID is given
{object}mSettings? Initial settings for the new control
Event Detail
filterDetailItemsAggregationChange(oControlEvent)
Let the outside world know that the filter detail aggregation was changed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.m.ViewSettingsFilterItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.ViewSettingsFilterItem with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.ViewSettingsItem.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.m.ViewSettingsFilterItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.ViewSettingsFilterItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addItem(oItem): sap.m.ViewSettingsFilterItem
Adds some item to the aggregation items.
Parameters:
{sap.m.ViewSettingsItem}oItem the item to add; if empty, nothing is inserted
Returns:
{sap.m.ViewSettingsFilterItem} Reference to this in order to allow method chaining
attachFilterDetailItemsAggregationChange(oData?, fnFunction, oListener?): sap.m.ViewSettingsFilterItem
Attaches event handler fnFunction to the filterDetailItemsAggregationChange event of this sap.m.ViewSettingsFilterItem.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.ViewSettingsFilterItem itself.

Let the outside world know that the filter detail aggregation was changed.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.m.ViewSettingsFilterItem itself
Returns:
{sap.m.ViewSettingsFilterItem} Reference to this in order to allow method chaining
bindItems(oBindingInfo): sap.m.ViewSettingsFilterItem
Binds aggregation items to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Parameters:
{object}oBindingInfo The binding information
Returns:
{sap.m.ViewSettingsFilterItem} Reference to this in order to allow method chaining
destroyItems(): sap.m.ViewSettingsFilterItem
Destroys all the items in the aggregation items.
Returns:
{sap.m.ViewSettingsFilterItem} Reference to this in order to allow method chaining
detachFilterDetailItemsAggregationChange(fnFunction, oListener): sap.m.ViewSettingsFilterItem
Detaches event handler fnFunction from the filterDetailItemsAggregationChange event of this sap.m.ViewSettingsFilterItem.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.m.ViewSettingsFilterItem} Reference to this in order to allow method chaining
fireFilterDetailItemsAggregationChange(mArguments?): sap.m.ViewSettingsFilterItem
Fires event filterDetailItemsAggregationChange to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.m.ViewSettingsFilterItem} Reference to this in order to allow method chaining
getItems(): sap.m.ViewSettingsItem[]
Gets content of aggregation items.

Items with key and value that are logically grouped under this filter item. They are used to display filter details in the ViewSettingsDialog.

Returns:
{sap.m.ViewSettingsItem[]}
getMultiSelect(): boolean
Gets current value of property multiSelect.

If set to (true), multi selection will be allowed for the items aggregation.

Default value is true.

Returns:
{boolean} Value of property multiSelect
indexOfItem(oItem): int
Checks for the provided sap.m.ViewSettingsItem in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
{sap.m.ViewSettingsItem}oItem The item whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.m.ViewSettingsFilterItem
Inserts a item into the aggregation items.
Parameters:
{sap.m.ViewSettingsItem}oItem the item to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
Returns:
{sap.m.ViewSettingsFilterItem} Reference to this in order to allow method chaining
removeAllItems(): sap.m.ViewSettingsItem[]
Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.m.ViewSettingsItem[]} An array of the removed elements (might be empty)
removeItem(vItem): sap.m.ViewSettingsItem
Removes a item from the aggregation items.
Parameters:
{int|string|sap.m.ViewSettingsItem}vItem The itemto remove or its index or id
Returns:
{sap.m.ViewSettingsItem} The removed item or null
setMultiSelect(bMultiSelect): sap.m.ViewSettingsFilterItem
Sets a new value for property multiSelect.

If set to (true), multi selection will be allowed for the items aggregation.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bMultiSelect New value for property multiSelect
Returns:
{sap.m.ViewSettingsFilterItem} Reference to this in order to allow method chaining
unbindItems(): sap.m.ViewSettingsFilterItem
Unbinds aggregation items from model data.
Returns:
{sap.m.ViewSettingsFilterItem} Reference to this in order to allow method chaining