Class sap.suite.ui.commons.ThingCollectionModule: sap/suite/ui/commons/ThingCollection

extends Control

This control contains a collection of the sap.ui.ux3.ThingViewer controls or descendants of sap.ui.ux3.ThingViewer. It allows you to navigate through them as well as delete them from the collection.

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

Constructor Summary
new sap.suite.ui.commons.ThingCollection(sId?, mSettings?)Constructor for a new ThingCollection.
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.ThingCollection.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.ThingCollection with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.ThingCollection.getMetadata()Returns a metadata object for class sap.suite.ui.commons.ThingCollection.
addContent(oContent)Adds some content oContent to the aggregation named content.
addNextContent(oOContent)Inserts an element into the next display position.
destroyContent()Destroys all the content in the aggregation named content.
getContent()Getter for aggregation content.
getHeight()Getter for property height.
getMinHeight()Getter for property minHeight.
getMinWidth()Getter for property minWidth.
getWidth()Getter for property width.
indexOfContent(oContent)Checks for the provided sap.ui.ux3.ThingViewer 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.
setHeight(sHeight)Setter for property height.
setMinHeight(sMinHeight)Setter for property minHeight.
setMinWidth(sMinWidth)Setter for property minWidth.
setWidth(sWidth)Setter for property width.
shiftNext()Displays the next item in the collection.
shiftPrev()Displays a previous item in the collection.
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.suite.ui.commons.ThingCollection(sId?, mSettings?)
Constructor for a new ThingCollection.

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
    • width : sap.ui.core.CSSSize (default: '100%')
    • height : sap.ui.core.CSSSize (default: '100%')
    • minWidth : sap.ui.core.CSSSize
    • minHeight : sap.ui.core.CSSSize
  • 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.32. Deprecated. Object page should be used instead.
      Method Detail
      sap.suite.ui.commons.ThingCollection.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.suite.ui.commons.ThingCollection 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.ThingCollection.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.suite.ui.commons.ThingCollection.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      addContent(oContent): sap.suite.ui.commons.ThingCollection
      Adds some content oContent to the aggregation named content.
      Parameters:
      {sap.ui.ux3.ThingViewer}oContent the content to add; if empty, nothing is inserted
      Returns:
      {sap.suite.ui.commons.ThingCollection}this to allow method chaining
      addNextContent(oOContent): sap.suite.ui.commons.ThingCollection
      Inserts an element into the next display position.
      Parameters:
      {sap.ui.ux3.ThingViewer}oOContent An instance of ThingViewer or an instance of its descendant.
      Returns:
      {sap.suite.ui.commons.ThingCollection}
      destroyContent(): sap.suite.ui.commons.ThingCollection
      Destroys all the content in the aggregation named content.
      Returns:
      {sap.suite.ui.commons.ThingCollection}this to allow method chaining
      getContent(): sap.ui.ux3.ThingViewer[]
      Getter for aggregation content.
      Contains a collection of sap.ui.ux3.ThingViewer controls or descendants of sap.ui.ux3.ThingViewer.
      Returns:
      {sap.ui.ux3.ThingViewer[]}
      getHeight(): sap.ui.core.CSSSize
      Getter for property height. The height of the control.

      Default value is 100%

      Returns:
      {sap.ui.core.CSSSize} the value of property height
      getMinHeight(): sap.ui.core.CSSSize
      Getter for property minHeight. The minimal height of the control.

      Default value is empty/undefined

      Returns:
      {sap.ui.core.CSSSize} the value of property minHeight
      getMinWidth(): sap.ui.core.CSSSize
      Getter for property minWidth. The minimal width of the control.

      Default value is empty/undefined

      Returns:
      {sap.ui.core.CSSSize} the value of property minWidth
      getWidth(): sap.ui.core.CSSSize
      Getter for property width. The width of the control.

      Default value is 100%

      Returns:
      {sap.ui.core.CSSSize} the value of property width
      indexOfContent(oContent): int
      Checks for the provided sap.ui.ux3.ThingViewer in the aggregation named content and returns its index if found or -1 otherwise.
      Parameters:
      {sap.ui.ux3.ThingViewer}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.suite.ui.commons.ThingCollection
      Inserts a content into the aggregation named content.
      Parameters:
      {sap.ui.ux3.ThingViewer}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.suite.ui.commons.ThingCollection}this to allow method chaining
      removeAllContent(): sap.ui.ux3.ThingViewer[]
      Removes all the controls in the aggregation named content.
      Additionally unregisters them from the hosting UIArea.
      Returns:
      {sap.ui.ux3.ThingViewer[]} an array of the removed elements (might be empty)
      removeContent(vContent): sap.ui.ux3.ThingViewer
      Removes an content from the aggregation named content.
      Parameters:
      {int|string|sap.ui.ux3.ThingViewer}vContent the content to remove or its index or id
      Returns:
      {sap.ui.ux3.ThingViewer} the removed content or null
      setHeight(sHeight): sap.suite.ui.commons.ThingCollection
      Setter for property height.

      Default value is 100%

      Parameters:
      {sap.ui.core.CSSSize}sHeight new value for property height
      Returns:
      {sap.suite.ui.commons.ThingCollection}this to allow method chaining
      setMinHeight(sMinHeight): sap.suite.ui.commons.ThingCollection
      Setter for property minHeight.

      Default value is empty/undefined

      Parameters:
      {sap.ui.core.CSSSize}sMinHeight new value for property minHeight
      Returns:
      {sap.suite.ui.commons.ThingCollection}this to allow method chaining
      setMinWidth(sMinWidth): sap.suite.ui.commons.ThingCollection
      Setter for property minWidth.

      Default value is empty/undefined

      Parameters:
      {sap.ui.core.CSSSize}sMinWidth new value for property minWidth
      Returns:
      {sap.suite.ui.commons.ThingCollection}this to allow method chaining
      setWidth(sWidth): sap.suite.ui.commons.ThingCollection
      Setter for property width.

      Default value is 100%

      Parameters:
      {sap.ui.core.CSSSize}sWidth new value for property width
      Returns:
      {sap.suite.ui.commons.ThingCollection}this to allow method chaining
      shiftNext(): void
      Displays the next item in the collection.
      shiftPrev(): void
      Displays a previous item in the collection.