Class sap.m.ViewSettingsCustomItemModule: sap/m/ViewSettingsCustomItem

extends ViewSettingsItem

The ViewSettingsCustomItem control is used for modelling custom filters in the ViewSettingsDialog.


Since: 1.16.
Constructor Summary
new sap.m.ViewSettingsCustomItem(sId?, mSettings?)Constructor for a new ViewSettingsCustomItem.
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.ViewSettingsCustomItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.ViewSettingsCustomItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.ViewSettingsCustomItem.getMetadata()Returns a metadata object for class sap.m.ViewSettingsCustomItem.
destroyCustomControl()Destroys the customControl in the aggregation customControl.
getCustomControl()Internally the control is handled as a managed object instead of an aggregation because this control is sometimes aggregated in other controls like a popover or a dialog.
getFilterCount()Gets current value of property filterCount.
setCustomControl(oControl)Internally the control is handled as a managed object instead of an aggregation as this control is sometimes aggregated in other controls like a popover or a dialog.
setFilterCount(iValue)Sets the filterCount without invalidating the control as it is never rendered directly.
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, 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.ViewSettingsCustomItem(sId?, mSettings?)
Constructor for a new ViewSettingsCustomItem.

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
Method Detail
sap.m.ViewSettingsCustomItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.ViewSettingsCustomItem 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.ViewSettingsCustomItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.ViewSettingsCustomItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
destroyCustomControl(): sap.m.ViewSettingsCustomItem
Destroys the customControl in the aggregation customControl.
Returns:
{sap.m.ViewSettingsCustomItem} Reference to this in order to allow method chaining
getCustomControl(): sap.ui.core.Control
Internally the control is handled as a managed object instead of an aggregation because this control is sometimes aggregated in other controls like a popover or a dialog.
Returns:
{sap.ui.core.Control} oControl a control used for filtering purposes
getFilterCount(): int
Gets current value of property filterCount.

The number of currently active filters for this custom filter item. It will be displayed in the filter list of the ViewSettingsDialog to represent the filter state of the custom control.

Default value is 0.

Returns:
{int} Value of property filterCount
setCustomControl(oControl): sap.m.ViewSettingsCustomItem
Internally the control is handled as a managed object instead of an aggregation as this control is sometimes aggregated in other controls like a popover or a dialog.
Parameters:
{sap.ui.core.Control}oControl A control used for filtering purposes
Returns:
{sap.m.ViewSettingsCustomItem} this pointer for chaining
setFilterCount(iValue): sap.m.ViewSettingsItem
Sets the filterCount without invalidating the control as it is never rendered directly.
Parameters:
{int}iValue The new value for property filterCount
Returns:
{sap.m.ViewSettingsItem} this pointer for chaining