Class sap.suite.ui.commons.TargetFilterColumnModule: sap/suite/ui/commons/TargetFilterColumn

extends Element

The configuration element for the column in the TargetFilter control.

Constructor Summary
new sap.suite.ui.commons.TargetFilterColumn(sId?, mSettings?)Constructor for a new TargetFilterColumn.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.suite.ui.commons.TargetFilterColumn.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.TargetFilterColumn with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.TargetFilterColumn.getMetadata()Returns a metadata object for class sap.suite.ui.commons.TargetFilterColumn.
getLength()Getter for property length.
getPath()Getter for property path.
getTitle()Getter for property title.
getType()Getter for property type.
setLength(iLength)Setter for property length.
setPath(sPath)Setter for property path.
setTitle(sTitle)Setter for property title.
setType(oType)Setter for property type.
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.suite.ui.commons.TargetFilterColumn(sId?, mSettings?)
Constructor for a new TargetFilterColumn.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

  • Properties
  • Aggregations
    • Associations
      • Events

        In addition, all settings applicable to the base type sap.ui.core.Element 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.suite.ui.commons.TargetFilterColumn.extend(sClassName, oClassInfo?, FNMetaImpl?): function
        Creates a new subclass of class sap.suite.ui.commons.TargetFilterColumn with name sClassName and enriches it with the information contained in oClassInfo.

        oClassInfo might contain the same kind of informations as described in Element.extend.

        Parameters:
        {string}sClassName name of the class to be created
        {object}oClassInfo? object literal with informations about the class
        {function}FNMetaImpl? constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
        Returns:
        {function} the created class / constructor function
        sap.suite.ui.commons.TargetFilterColumn.getMetadata(): sap.ui.base.Metadata
        Returns a metadata object for class sap.suite.ui.commons.TargetFilterColumn.
        Returns:
        {sap.ui.base.Metadata} Metadata object describing this class
        getLength(): int
        Getter for property length. The number of the retrieved entries for the cloud of the links in the quadrant. The quadrant can display fewer links than retrieved. The font size of the links in the quadrant depends on the measure number. The font size of the links is relative in the retrieved group.

        Default value is 10

        Returns:
        {int} the value of property length
        getPath(): string
        Getter for property path. The binding path.

        Default value is empty/undefined

        Returns:
        {string} the value of property path
        getTitle(): string
        Getter for property title. The column title.

        Default value is empty/undefined

        Returns:
        {string} the value of property title
        getType(): any
        Getter for property type. The type of the displayed data. The type of the property must be sap.ui.model.SimpleType or its descedants. By default, sap.ui.model.type.String. This property is used for formatting the displayed values. If sap.ui.model.type.String, the filter operator in the Search field of the column selection dialog is 'Contains'. In other cases, the filter operator is 'EQ'.

        Default value is empty/undefined

        Returns:
        {any} the value of property type
        setLength(iLength): sap.suite.ui.commons.TargetFilterColumn
        Setter for property length.

        Default value is 10

        Parameters:
        {int}iLength new value for property length
        Returns:
        {sap.suite.ui.commons.TargetFilterColumn}this to allow method chaining
        setPath(sPath): sap.suite.ui.commons.TargetFilterColumn
        Setter for property path.

        Default value is empty/undefined

        Parameters:
        {string}sPath new value for property path
        Returns:
        {sap.suite.ui.commons.TargetFilterColumn}this to allow method chaining
        setTitle(sTitle): sap.suite.ui.commons.TargetFilterColumn
        Setter for property title.

        Default value is empty/undefined

        Parameters:
        {string}sTitle new value for property title
        Returns:
        {sap.suite.ui.commons.TargetFilterColumn}this to allow method chaining
        setType(oType): sap.suite.ui.commons.TargetFilterColumn
        Setter for property type.

        Default value is empty/undefined

        Parameters:
        {any}oType new value for property type
        Returns:
        {sap.suite.ui.commons.TargetFilterColumn}this to allow method chaining