Class sap.suite.ui.commons.FacetOverviewModule: sap/suite/ui/commons/FacetOverview

extends Control

This control is used in UnifiedThingInspector to display the preview of the facet content.

Deprecated API:Since version 1.32. Deprecated. Object page should be used instead.

Constructor Summary
new sap.suite.ui.commons.FacetOverview(sId?, mSettings?)Constructor for a new FacetOverview.
Event Summary
heightChange(oControlEvent)This event is fired when a new value to the heightType or height property is set.
press(oControlEvent)The event is fired when the user chooses the control.
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.suite.ui.commons.FacetOverview.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.FacetOverview with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.FacetOverview.getMetadata()Returns a metadata object for class sap.suite.ui.commons.FacetOverview.
attachHeightChange(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'heightChange' event of this sap.suite.ui.commons.FacetOverview.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.FacetOverview.
destroyContent()Destroys the content in the aggregation named content.
detachHeightChange(fnFunction, oListener)Detach event handler fnFunction from the 'heightChange' event of this sap.suite.ui.commons.FacetOverview.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.FacetOverview.
fireHeightChange(mArguments?)Fire event heightChange to attached listeners.
firePress(mArguments?)Fire event press to attached listeners.
getContent()Getter for aggregation content.
getHeightType()Getter for property heightType.
getQuantity()Getter for property quantity.
getTitle()Getter for property title.
getWidth()Getter for property width.
setContent(oContent)Setter for the aggregated content.
setHeightType(oHeightType)Setter for property heightType.
setQuantity(iQuantity)Setter for property quantity.
setTitle(sTitle)Setter for property title.
setWidth(sWidth)Setter for property width.
getHeight()Getter for property height.
getRowSpan()Getter for property rowSpan.
setHeight(sHeight)Setter for property height.
setRowSpan(iRowSpan)Setter for property rowSpan.
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.suite.ui.commons.FacetOverview(sId?, mSettings?)
Constructor for a new FacetOverview.

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
    • title : string
    • quantity : int (default: -1)
    • width : sap.ui.core.CSSSize (default: 'auto')
    • height : sap.ui.core.CSSSize (default: '10rem')
    • rowSpan : int (default: 1)
    • heightType : sap.suite.ui.commons.FacetOverviewHeight (default: sap.suite.ui.commons.FacetOverviewHeight.None)
  • Aggregations
  • Associations
    • Events
      • press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
      • heightChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    Parameters:
    {string}sId? id for the new control, generated automatically if no id is given
    {object}mSettings? initial settings for the new control
    Deprecated:
    Since version 1.32. Deprecated. Object page should be used instead.
    Event Detail
    heightChange(oControlEvent)
    This event is fired when a new value to the heightType or height property is set.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    press(oControlEvent)
    The event is fired when the user chooses the control. Provides an event with parameter id, the ID of the chosen control.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    {string}oControlEvent.getParameters.id The control ID.
    Method Detail
    sap.suite.ui.commons.FacetOverview.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.suite.ui.commons.FacetOverview 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.FacetOverview.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.suite.ui.commons.FacetOverview.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    attachHeightChange(oData?, fnFunction, oListener?): sap.suite.ui.commons.FacetOverview
    Attach event handler fnFunction to the 'heightChange' event of this sap.suite.ui.commons.FacetOverview.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.FacetOverview.
    itself.

    This event is fired when a new value to the heightType or height property is set.

    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 call, when the event occurs.
    {object}oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.FacetOverview.
    itself.
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining
    attachPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.FacetOverview
    Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.FacetOverview.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.FacetOverview.
    itself.

    The event is fired when the user chooses the control. Provides an event with parameter id, the ID of the chosen control.

    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 call, when the event occurs.
    {object}oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.FacetOverview.
    itself.
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining
    destroyContent(): sap.suite.ui.commons.FacetOverview
    Destroys the content in the aggregation named content.
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining
    detachHeightChange(fnFunction, oListener): sap.suite.ui.commons.FacetOverview
    Detach event handler fnFunction from the 'heightChange' event of this sap.suite.ui.commons.FacetOverview.

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

    Parameters:
    {function}fnFunction The function to call, when the event occurs.
    {object}oListener Context object on which the given function had to be called.
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining
    detachPress(fnFunction, oListener): sap.suite.ui.commons.FacetOverview
    Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.FacetOverview.

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

    Parameters:
    {function}fnFunction The function to call, when the event occurs.
    {object}oListener Context object on which the given function had to be called.
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining
    fireHeightChange(mArguments?): sap.suite.ui.commons.FacetOverview
    Fire event heightChange to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining
    firePress(mArguments?): sap.suite.ui.commons.FacetOverview
    Fire event press to attached listeners.

    Expects following event parameters:

    • 'id' of type string The control ID.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining
    getContent(): sap.ui.core.Control
    Getter for aggregation content.
    The content that appears in the left part of the control.
    Returns:
    {sap.ui.core.Control}
    getHeightType(): sap.suite.ui.commons.FacetOverviewHeight
    Getter for property heightType. Indicates the height of the control in the predifened values. If set to None, then the height is defined by the depricated height property.

    Default value is None

    Returns:
    {sap.suite.ui.commons.FacetOverviewHeight} the value of property heightType
    getQuantity(): int
    Getter for property quantity. Displays a label with the number of items in the right part of the control.

    Default value is -1

    Returns:
    {int} the value of property quantity
    getTitle(): string
    Getter for property title. This property is shown in the upper left part of control.

    Default value is empty/undefined

    Returns:
    {string} the value of property title
    getWidth(): sap.ui.core.CSSSize
    Getter for property width. Defines the width of the control. By default, the value is empty and the control inhertis the size from its content.

    Default value is auto

    Returns:
    {sap.ui.core.CSSSize} the value of property width
    setContent(oContent): sap.suite.ui.commons.FacetOverview
    Setter for the aggregated content.
    Parameters:
    {sap.ui.core.Control}oContent
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining
    setHeightType(oHeightType): sap.suite.ui.commons.FacetOverview
    Setter for property heightType.

    Default value is None

    Parameters:
    {sap.suite.ui.commons.FacetOverviewHeight}oHeightType new value for property heightType
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining
    setQuantity(iQuantity): sap.suite.ui.commons.FacetOverview
    Setter for property quantity.

    Default value is -1

    Parameters:
    {int}iQuantity new value for property quantity
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining
    setTitle(sTitle): sap.suite.ui.commons.FacetOverview
    Setter for property title.

    Default value is empty/undefined

    Parameters:
    {string}sTitle new value for property title
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining
    setWidth(sWidth): sap.suite.ui.commons.FacetOverview
    Setter for property width.

    Default value is auto

    Parameters:
    {sap.ui.core.CSSSize}sWidth new value for property width
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining
    getHeight(): sap.ui.core.CSSSize
    Getter for property height. Defines the height of the control only if the heightType prperty is set to None. Must be set in rems for the correct work in the UnifiedThingInspector.

    Default value is 10rem

    Deprecated:
    Since version 1.17.1. This property was replaced by heightType property.
    Returns:
    {sap.ui.core.CSSSize} the value of property height
    getRowSpan(): int
    Getter for property rowSpan. Defines the number of rows that the control represents in an external layout.

    Default value is 1

    Deprecated:
    Since version 1.17.1. It is not used any more for the laoyut calculations in UnifiedThingInspector.
    Returns:
    {int} the value of property rowSpan
    setHeight(sHeight): sap.suite.ui.commons.FacetOverview
    Setter for property height.

    Default value is 10rem

    Parameters:
    {sap.ui.core.CSSSize}sHeight new value for property height
    Deprecated:
    Since version 1.17.1. This property was replaced by heightType property.
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining
    setRowSpan(iRowSpan): sap.suite.ui.commons.FacetOverview
    Setter for property rowSpan.

    Default value is 1

    Parameters:
    {int}iRowSpan new value for property rowSpan
    Deprecated:
    Since version 1.17.1. It is not used any more for the laoyut calculations in UnifiedThingInspector.
    Returns:
    {sap.suite.ui.commons.FacetOverview}this to allow method chaining