Class sap.m.P13nFilterPanelModule: sap/m/P13nFilterPanel

extends P13nPanel

The P13nFilterPanel control is used to define filter-specific settings for table personalization.

Constructor Summary
new sap.m.P13nFilterPanel(sId?, mSettings?)Constructor for a new P13nFilterPanel.
Event Summary
addFilterItem(oControlEvent)Event raised if a filter item has been added.
removeFilterItem(oControlEvent)Removes a filter item.
updateFilterItem(oControlEvent)Updates a filter item.
Events borrowed from class sap.m.P13nPanel
beforeNavigationTo
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.P13nFilterPanel.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.P13nFilterPanel with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.P13nFilterPanel.getMetadata()Returns a metadata object for class sap.m.P13nFilterPanel.
addFilterItem(oFilterItem)Adds some filterItem to the aggregation filterItems.
attachAddFilterItem(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the addFilterItem event of this sap.m.P13nFilterPanel.
attachRemoveFilterItem(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the removeFilterItem event of this sap.m.P13nFilterPanel.
attachUpdateFilterItem(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the updateFilterItem event of this sap.m.P13nFilterPanel.
bindFilterItems(oBindingInfo)Binds aggregation filterItems to model data.
destroyFilterItems()Destroys all the filterItems in the aggregation filterItems.
detachAddFilterItem(fnFunction, oListener)Detaches event handler fnFunction from the addFilterItem event of this sap.m.P13nFilterPanel.
detachRemoveFilterItem(fnFunction, oListener)Detaches event handler fnFunction from the removeFilterItem event of this sap.m.P13nFilterPanel.
detachUpdateFilterItem(fnFunction, oListener)Detaches event handler fnFunction from the updateFilterItem event of this sap.m.P13nFilterPanel.
fireAddFilterItem(mArguments?)Fires event addFilterItem to attached listeners.
fireRemoveFilterItem(mArguments?)Fires event removeFilterItem to attached listeners.
fireUpdateFilterItem(mArguments?)Fires event updateFilterItem to attached listeners.
getConditions()Returns the array of conditions.
getContainerQuery()Gets current value of property containerQuery.
getExcludeOperations(the)Getter for the exclude operations.
getFilterItems()Gets content of aggregation filterItems.
getIncludeOperations(the)Getter for the include operations.
getLayoutMode()Gets current value of property layoutMode.
getMaxExcludes()Gets current value of property maxExcludes.
getMaxIncludes()Gets current value of property maxIncludes.
indexOfFilterItem(oFilterItem)Checks for the provided sap.m.P13nFilterItem in the aggregation filterItems.
insertFilterItem(oFilterItem, iIndex)Inserts a filterItem into the aggregation filterItems.
removeAllFilterItems()Removes all the controls from the aggregation filterItems.
removeFilterItem(vFilterItem)Removes a filterItem from the aggregation filterItems.
removeInvalidConditions()Removes all invalid conditions.
removeValidationErrors()Removes all errors and warnings states from of all filter conditions.
setConditions(aConditions)Sets the array of conditions.
setContainerQuery(bContainerQuery)Sets a new value for property containerQuery.
setExcludeOperations(array, the)Setter for the supported exclude operations array.
setIncludeOperations(array, the)Setter for the supported Include operations array.
setLayoutMode(sLayoutMode)Sets a new value for property layoutMode.
setMaxExcludes(sMaxExcludes)Sets a new value for property maxExcludes.
setMaxIncludes(sMaxIncludes)Sets a new value for property maxIncludes.
unbindFilterItems()Unbinds aggregation filterItems from model data.
validateConditions()Checks if the entered and modified conditions are correct, marks invalid fields in yellow (warning).
Methods borrowed from class sap.m.P13nPanel
addItem, attachBeforeNavigationTo, beforeNavigationTo, bindItems, destroyItems, detachBeforeNavigationTo, fireBeforeNavigationTo, getChangeNotifier, getItems, getOkPayload, getResetPayload, getTitle, getTitleLarge, getType, getValidationExecutor, getValidationListener, getVerticalScrolling, indexOfItem, insertItem, onAfterNavigationFrom, onBeforeNavigationFrom, removeAllItems, removeItem, setChangeNotifier, setTitle, setTitleLarge, setType, setValidationExecutor, setValidationListener, setVerticalScrolling, unbindItems
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, 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, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, 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, 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.P13nFilterPanel(sId?, mSettings?)
Constructor for a new P13nFilterPanel.

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:

  • Properties
  • Aggregations
  • Events
    • addFilterItem : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • removeFilterItem : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • updateFilterItem : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.m.P13nPanel 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
addFilterItem(oControlEvent)
Event raised if a filter item has been added.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.26
removeFilterItem(oControlEvent)
Removes a filter item.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.26
updateFilterItem(oControlEvent)
Updates a filter item.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.26
Method Detail
sap.m.P13nFilterPanel.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.P13nFilterPanel 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.P13nPanel.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.P13nFilterPanel.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.P13nFilterPanel.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addFilterItem(oFilterItem): sap.m.P13nFilterPanel
Adds some filterItem to the aggregation filterItems.
Parameters:
{sap.m.P13nFilterItem}oFilterItem the filterItem to add; if empty, nothing is inserted
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
attachAddFilterItem(oData?, fnFunction, oListener?): sap.m.P13nFilterPanel
Attaches event handler fnFunction to the addFilterItem event of this sap.m.P13nFilterPanel.

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.P13nFilterPanel itself.

Event raised if a filter item has been added.

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.P13nFilterPanel itself
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
attachRemoveFilterItem(oData?, fnFunction, oListener?): sap.m.P13nFilterPanel
Attaches event handler fnFunction to the removeFilterItem event of this sap.m.P13nFilterPanel.

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.P13nFilterPanel itself.

Removes a filter item.

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.P13nFilterPanel itself
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
attachUpdateFilterItem(oData?, fnFunction, oListener?): sap.m.P13nFilterPanel
Attaches event handler fnFunction to the updateFilterItem event of this sap.m.P13nFilterPanel.

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.P13nFilterPanel itself.

Updates a filter item.

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.P13nFilterPanel itself
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
bindFilterItems(oBindingInfo): sap.m.P13nFilterPanel
Binds aggregation filterItems to model data.

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

Parameters:
{object}oBindingInfo The binding information
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
destroyFilterItems(): sap.m.P13nFilterPanel
Destroys all the filterItems in the aggregation filterItems.
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
detachAddFilterItem(fnFunction, oListener): sap.m.P13nFilterPanel
Detaches event handler fnFunction from the addFilterItem event of this sap.m.P13nFilterPanel.

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
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
detachRemoveFilterItem(fnFunction, oListener): sap.m.P13nFilterPanel
Detaches event handler fnFunction from the removeFilterItem event of this sap.m.P13nFilterPanel.

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
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
detachUpdateFilterItem(fnFunction, oListener): sap.m.P13nFilterPanel
Detaches event handler fnFunction from the updateFilterItem event of this sap.m.P13nFilterPanel.

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
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
fireAddFilterItem(mArguments?): sap.m.P13nFilterPanel
Fires event addFilterItem to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
fireRemoveFilterItem(mArguments?): sap.m.P13nFilterPanel
Fires event removeFilterItem to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
fireUpdateFilterItem(mArguments?): sap.m.P13nFilterPanel
Fires event updateFilterItem to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
getConditions()
Returns the array of conditions.
Since:
1.26
getContainerQuery(): boolean
Gets current value of property containerQuery.

Defines if the mediaQuery or a ContainerResize is used for layout update. If the ConditionPanel is used in a dialog, the property must be set to true.

Default value is false.

Since:
1.26
Returns:
{boolean} Value of property containerQuery
getExcludeOperations(the): sap.m.P13nConditionOperation[]
Getter for the exclude operations.
Parameters:
{string}the type for which the operations are defined
Since:
1.26
Returns:
{sap.m.P13nConditionOperation[]} array of operations [sap.m.P13nConditionOperation.BT, sap.m.P13nConditionOperation.EQ]
getFilterItems(): sap.m.P13nFilterItem[]
Gets content of aggregation filterItems.

Defines filter items.

Since:
1.26
Returns:
{sap.m.P13nFilterItem[]}
getIncludeOperations(the): sap.m.P13nConditionOperation
Getter for the include operations.
Parameters:
{string}the type for which the operations are defined
Since:
1.26
Returns:
{sap.m.P13nConditionOperation} array of operations [sap.m.P13nConditionOperation.BT, sap.m.P13nConditionOperation.EQ]
getLayoutMode(): string
Gets current value of property layoutMode.

Can be used to control the layout behavior. Default is "" which will automatically change the layout. With "Desktop", "Table" or"Phone" you can set a fixed layout.

Since:
1.26
Returns:
{string} Value of property layoutMode
getMaxExcludes(): string
Gets current value of property maxExcludes.

Defines the maximum number of exclude filters.

Default value is -1.

Since:
1.26
Returns:
{string} Value of property maxExcludes
getMaxIncludes(): string
Gets current value of property maxIncludes.

Defines the maximum number of include filters.

Default value is -1.

Since:
1.26
Returns:
{string} Value of property maxIncludes
indexOfFilterItem(oFilterItem): int
Checks for the provided sap.m.P13nFilterItem in the aggregation filterItems. and returns its index if found or -1 otherwise.
Parameters:
{sap.m.P13nFilterItem}oFilterItem The filterItem whose index is looked for
Since:
1.26
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertFilterItem(oFilterItem, iIndex): sap.m.P13nFilterPanel
Inserts a filterItem into the aggregation filterItems.
Parameters:
{sap.m.P13nFilterItem}oFilterItem the filterItem to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the filterItem should be inserted at; for a negative value of iIndex, the filterItem is inserted at position 0; for a value greater than the current size of the aggregation, the filterItem is inserted at the last position
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
removeAllFilterItems(): sap.m.P13nFilterItem[]
Removes all the controls from the aggregation filterItems.

Additionally, it unregisters them from the hosting UIArea.

Since:
1.26
Returns:
{sap.m.P13nFilterItem[]} An array of the removed elements (might be empty)
removeFilterItem(vFilterItem): sap.m.P13nFilterItem
Removes a filterItem from the aggregation filterItems.
Parameters:
{int|string|sap.m.P13nFilterItem}vFilterItem The filterItemto remove or its index or id
Since:
1.26
Returns:
{sap.m.P13nFilterItem} The removed filterItem or null
removeInvalidConditions()
Removes all invalid conditions.
Since:
1.28
removeValidationErrors()
Removes all errors and warnings states from of all filter conditions.
Since:
1.28
setConditions(aConditions)
Sets the array of conditions.
Parameters:
{object[]}aConditions the complete list of conditions
Since:
1.26
setContainerQuery(bContainerQuery): sap.m.P13nFilterPanel
Sets a new value for property containerQuery.

Defines if the mediaQuery or a ContainerResize is used for layout update. If the ConditionPanel is used in a dialog, the property must be set to true.

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

Default value is false.

Parameters:
{boolean}bContainerQuery New value for property containerQuery
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
setExcludeOperations(array, the)
Setter for the supported exclude operations array.
Parameters:
{sap.m.P13nConditionOperation[]}array of operations [sap.m.P13nConditionOperation.BT, sap.m.P13nConditionOperation.EQ]
{string}the type for which the operations are defined
Since:
1.26
setIncludeOperations(array, the)
Setter for the supported Include operations array.
Parameters:
{sap.m.P13nConditionOperation[]}array of operations [sap.m.P13nConditionOperation.BT, sap.m.P13nConditionOperation.EQ]
{string}the type for which the operations are defined
Since:
1.26
setLayoutMode(sLayoutMode): sap.m.P13nFilterPanel
Sets a new value for property layoutMode.

Can be used to control the layout behavior. Default is "" which will automatically change the layout. With "Desktop", "Table" or"Phone" you can set a fixed layout.

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

Parameters:
{string}sLayoutMode New value for property layoutMode
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
setMaxExcludes(sMaxExcludes): sap.m.P13nFilterPanel
Sets a new value for property maxExcludes.

Defines the maximum number of exclude filters.

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

Default value is -1.

Parameters:
{string}sMaxExcludes New value for property maxExcludes
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
setMaxIncludes(sMaxIncludes): sap.m.P13nFilterPanel
Sets a new value for property maxIncludes.

Defines the maximum number of include filters.

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

Default value is -1.

Parameters:
{string}sMaxIncludes New value for property maxIncludes
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
unbindFilterItems(): sap.m.P13nFilterPanel
Unbinds aggregation filterItems from model data.
Since:
1.26
Returns:
{sap.m.P13nFilterPanel} Reference to this in order to allow method chaining
validateConditions(): boolean
Checks if the entered and modified conditions are correct, marks invalid fields in yellow (warning).
Since:
1.26
Returns:
{boolean}false, if there is an invalid condition