Class sap.ui.vbm.ContainerModule: sap/ui/vbm/Container

extends VoBase
known direct subclasses: ClusterContainer

Specific Visual Object element acting as a container for other controls. A Container is positioned at the given position on the map. It can aggregate other controls, which will then move with the map.
Since a Container is not a real visual object most features borrowed from VoBase will not work. There is no label, no edit mode, and no drop support. Events like click will only be fired if the aggregated control is not handling them.

Constructor Summary
new sap.ui.vbm.Container(sId?, mSettings?)Constructor for a new Container.
Method Summary
sap.ui.vbm.Container.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.Container with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.Container.getMetadata()Returns a metadata object for class sap.ui.vbm.Container.
destroyItem()Destroys the item in the aggregation item.
getAlignment()Gets current value of property alignment.
getItem()Gets content of aggregation item.
getPosition()Gets current value of property position.
setAlignment(sAlignment)Sets a new value for property alignment.
setItem(oItem)Sets the aggregated item.
setPosition(sPosition)Sets a new value for property position.
Constructor Detail
new sap.ui.vbm.Container(sId?, mSettings?)
Constructor for a new Container.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

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

oClassInfo might contain the same kind of information as described in sap.ui.vbm.VoBase.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.vbm.Container.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.Container.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
destroyItem(): sap.ui.vbm.Container
Destroys the item in the aggregation item.
Returns:
{sap.ui.vbm.Container} Reference to this in order to allow method chaining
getAlignment(): string
Gets current value of property alignment.

Alignment of the container to its position:

  • 0: center
  • 1: top center
  • 2: top right
  • 3: center right
  • 4: bottom right
  • 5: bottom center
  • 6: bottom left
  • 7: center left
  • 8: top left

Default value is 0.

Returns:
{string} Value of property alignment
Gets content of aggregation item.

The control that should be placed in the container.

Returns:
{sap.ui.core.Control}
getPosition(): string
Gets current value of property position.

The position for the Container. The format is "lon;lat;0".

Returns:
{string} Value of property position
setAlignment(sAlignment): sap.ui.vbm.Container
Sets a new value for property alignment.

Alignment of the container to its position:

  • 0: center
  • 1: top center
  • 2: top right
  • 3: center right
  • 4: bottom right
  • 5: bottom center
  • 6: bottom left
  • 7: center left
  • 8: top left

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 0.

Parameters:
{string}sAlignment New value for property alignment
Returns:
{sap.ui.vbm.Container} Reference to this in order to allow method chaining
setItem(oItem): sap.ui.vbm.Container
Sets the aggregated item.
Parameters:
{sap.ui.core.Control}oItem The item to set
Returns:
{sap.ui.vbm.Container} Reference to this in order to allow method chaining
setPosition(sPosition): sap.ui.vbm.Container
Sets a new value for property position.

The position for the Container. The format is "lon;lat;0".

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{string}sPosition New value for property position
Returns:
{sap.ui.vbm.Container} Reference to this in order to allow method chaining