Class sap.suite.ui.commons.DynamicContainerModule: sap/suite/ui/commons/DynamicContainer

extends Control

The control that displays multiple GenericTile controls as changing slides.

Deprecated API:Since version 1.34. Deprecated. Moved to openui5.

Constructor Summary
new sap.suite.ui.commons.DynamicContainer(sId?, mSettings?)Constructor for a new DynamicContainer.
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.DynamicContainer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.DynamicContainer with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.DynamicContainer.getMetadata()Returns a metadata object for class sap.suite.ui.commons.DynamicContainer.
addTile(oTile)Adds some tile oTile to the aggregation named tiles.
destroyTiles()Destroys all the tiles in the aggregation named tiles.
getDisplayTime()Getter for property displayTime.
getTiles()Getter for aggregation tiles.
getTransitionTime()Getter for property transitionTime.
indexOfTile(oTile)Checks for the provided sap.suite.ui.commons.GenericTile in the aggregation named tiles and returns its index if found or -1 otherwise.
insertTile(oTile, iIndex)Inserts a tile into the aggregation named tiles.
removeAllTiles()Removes all the controls in the aggregation named tiles.
removeTile(vTile)Removes an tile from the aggregation named tiles.
setDisplayTime(iDisplayTime)Setter for property displayTime.
setTransitionTime(iTransitionTime)Setter for property transitionTime.
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.DynamicContainer(sId?, mSettings?)
Constructor for a new DynamicContainer.

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
    • tiles : sap.suite.ui.commons.GenericTile[]
  • 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.34. Deprecated. Moved to openui5.
      Method Detail
      sap.suite.ui.commons.DynamicContainer.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.suite.ui.commons.DynamicContainer 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.DynamicContainer.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.suite.ui.commons.DynamicContainer.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      addTile(oTile): sap.suite.ui.commons.DynamicContainer
      Adds some tile oTile to the aggregation named tiles.
      Parameters:
      {sap.suite.ui.commons.GenericTile}oTile the tile to add; if empty, nothing is inserted
      Returns:
      {sap.suite.ui.commons.DynamicContainer}this to allow method chaining
      destroyTiles(): sap.suite.ui.commons.DynamicContainer
      Destroys all the tiles in the aggregation named tiles.
      Returns:
      {sap.suite.ui.commons.DynamicContainer}this to allow method chaining
      getDisplayTime(): int
      Getter for property displayTime. The time of the slide display in milliseconds.

      Default value is 5000

      Returns:
      {int} the value of property displayTime
      getTiles(): sap.suite.ui.commons.GenericTile[]
      Getter for aggregation tiles.
      The set of Generic Tiles to be shown in the control.
      Returns:
      {sap.suite.ui.commons.GenericTile[]}
      getTransitionTime(): int
      Getter for property transitionTime. The time of the slide changing in milliseconds.

      Default value is 500

      Returns:
      {int} the value of property transitionTime
      indexOfTile(oTile): int
      Checks for the provided sap.suite.ui.commons.GenericTile in the aggregation named tiles and returns its index if found or -1 otherwise.
      Parameters:
      {sap.suite.ui.commons.GenericTile}oTile the tile whose index is looked for.
      Returns:
      {int} the index of the provided control in the aggregation if found, or -1 otherwise
      insertTile(oTile, iIndex): sap.suite.ui.commons.DynamicContainer
      Inserts a tile into the aggregation named tiles.
      Parameters:
      {sap.suite.ui.commons.GenericTile}oTile the tile to insert; if empty, nothing is inserted
      {int}iIndex the 0-based index the tile should be inserted at; for a negative value of iIndex, the tile is inserted at position 0; for a value greater than the current size of the aggregation, the tile is inserted at the last position
      Returns:
      {sap.suite.ui.commons.DynamicContainer}this to allow method chaining
      removeAllTiles(): sap.suite.ui.commons.GenericTile[]
      Removes all the controls in the aggregation named tiles.
      Additionally unregisters them from the hosting UIArea.
      Returns:
      {sap.suite.ui.commons.GenericTile[]} an array of the removed elements (might be empty)
      removeTile(vTile): sap.suite.ui.commons.GenericTile
      Removes an tile from the aggregation named tiles.
      Parameters:
      {int|string|sap.suite.ui.commons.GenericTile}vTile the tile to remove or its index or id
      Returns:
      {sap.suite.ui.commons.GenericTile} the removed tile or null
      setDisplayTime(iDisplayTime): sap.suite.ui.commons.DynamicContainer
      Setter for property displayTime.

      Default value is 5000

      Parameters:
      {int}iDisplayTime new value for property displayTime
      Returns:
      {sap.suite.ui.commons.DynamicContainer}this to allow method chaining
      setTransitionTime(iTransitionTime): sap.suite.ui.commons.DynamicContainer
      Setter for property transitionTime.

      Default value is 500

      Parameters:
      {int}iTransitionTime new value for property transitionTime
      Returns:
      {sap.suite.ui.commons.DynamicContainer}this to allow method chaining