Class sap.ca.ui.OverflowContainerModule: sap/ca/ui/OverflowContainer

extends Control

The OverflowContainer allows the content of a control to be partially displayed before being fully expanded. It will cut its content to a fixed height that can be defined. It is fully suitable within an IconTabBar.

Deprecated API:Since version 1.24.1. OverflowContainer is deprecated as per central UX requirements. This control will not be supported anymore.

Constructor Summary
new sap.ca.ui.OverflowContainer(sId?, mSettings?)Constructor for a new OverflowContainer.
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.ca.ui.OverflowContainer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.OverflowContainer with name sClassName and enriches it with the information contained in oClassInfo.
sap.ca.ui.OverflowContainer.getMetadata()Returns a metadata object for class sap.ca.ui.OverflowContainer.
addContent(oContent)Adds some content oContent to the aggregation named content.
destroyContent()Destroys all the content in the aggregation named content.
getContent()Getter for aggregation content.
getExpanded()Getter for property expanded.
getOverflowHeight()Getter for property overflowHeight.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation named content and returns its index if found or -1 otherwise.
insertContent(oContent, iIndex)Inserts a content into the aggregation named content.
removeAllContent()Removes all the controls in the aggregation named content.
removeContent(vContent)Removes an content from the aggregation named content.
setExpanded(bExpanded)Setter for property expanded.
setOverflowHeight(sOverflowHeight)Setter for property overflowHeight.
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, init, 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.ca.ui.OverflowContainer(sId?, mSettings?)
Constructor for a new OverflowContainer.

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
      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.24.1. OverflowContainer is deprecated as per central UX requirements. This control will not be supported anymore.
      Method Detail
      sap.ca.ui.OverflowContainer.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.ca.ui.OverflowContainer 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.ca.ui.OverflowContainer.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.ca.ui.OverflowContainer.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      addContent(oContent): sap.ca.ui.OverflowContainer
      Adds some content oContent to the aggregation named content.
      Parameters:
      {sap.ui.core.Control}oContent the content to add; if empty, nothing is inserted
      Returns:
      {sap.ca.ui.OverflowContainer}this to allow method chaining
      destroyContent(): sap.ca.ui.OverflowContainer
      Destroys all the content in the aggregation named content.
      Returns:
      {sap.ca.ui.OverflowContainer}this to allow method chaining
      getContent(): sap.ui.core.Control[]
      Getter for aggregation content.
      Controls to be embedded.
      Returns:
      {sap.ui.core.Control[]}
      getExpanded(): boolean
      Getter for property expanded. This property allows to fully expand the container

      Default value is false

      Returns:
      {boolean} the value of property expanded
      getOverflowHeight(): sap.ui.core.CSSSize
      Getter for property overflowHeight.

      The height of the container when not expanded. It should be determined by the application. The default value is set to 200px.

      Default value is 200px

      Returns:
      {sap.ui.core.CSSSize} the value of property overflowHeight
      indexOfContent(oContent): int
      Checks for the provided sap.ui.core.Control in the aggregation named content and returns its index if found or -1 otherwise.
      Parameters:
      {sap.ui.core.Control}oContent the content whose index is looked for.
      Returns:
      {int} the index of the provided control in the aggregation if found, or -1 otherwise
      insertContent(oContent, iIndex): sap.ca.ui.OverflowContainer
      Inserts a content into the aggregation named content.
      Parameters:
      {sap.ui.core.Control}oContent the content to insert; if empty, nothing is inserted
      {int}iIndex the 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
      Returns:
      {sap.ca.ui.OverflowContainer}this to allow method chaining
      removeAllContent(): sap.ui.core.Control[]
      Removes all the controls in the aggregation named content.
      Additionally unregisters them from the hosting UIArea.
      Returns:
      {sap.ui.core.Control[]} an array of the removed elements (might be empty)
      removeContent(vContent): sap.ui.core.Control
      Removes an content from the aggregation named content.
      Parameters:
      {int|string|sap.ui.core.Control}vContent the content to remove or its index or id
      Returns:
      {sap.ui.core.Control} the removed content or null
      setExpanded(bExpanded): sap.ca.ui.OverflowContainer
      Setter for property expanded.

      Default value is false

      Parameters:
      {boolean}bExpanded new value for property expanded
      Returns:
      {sap.ca.ui.OverflowContainer}this to allow method chaining
      setOverflowHeight(sOverflowHeight): sap.ca.ui.OverflowContainer
      Setter for property overflowHeight.

      Default value is 200px

      Parameters:
      {sap.ui.core.CSSSize}sOverflowHeight new value for property overflowHeight
      Returns:
      {sap.ca.ui.OverflowContainer}this to allow method chaining