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 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#constructor for a general description of the syntax of the settings object.
new sap.ui.vbm.Container(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | id for the new control, generated automatically if no id is given |
|
mSettings? | object | initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
alignment | string | 0 | Alignment of the container to its position:
|
position | string | The position for the Container. The format is "lon;lat;0". Visibility: public |
Name | Type | Default Value | Description |
---|---|---|---|
changeable | boolean | false | Set to true if VO is changeable. Which properties are actually changeable can be controlled on the related VO aggregation. Visibility: public |
dragData | string | Data to be dragged. This property allows you to provide an arbitrary data string, which is transfered to the target in a drag'n drop operation Visibility: public |
|
entity | string | The visual object builds an entity/group with other VO elements when it is hovered. The property is not supported when the PlugIn is used. Visibility: public |
|
fxdir | string | true | The visual object is not rotated when the map is rotated. The property is only required when the PlugIn is used and only meaningful for some VOs. Visibility: public |
fxsize | string | true | The visual object should keep its size when the map is zoomed. Default value is 'true'. Only meaningful for some VOs. Visibility: public |
hotDeltaColor | string | RHLSA(0;1.3;1.0;1.0) | Color change applied when visual object is hovered. The format is RHLSA(<hue>;<lightness>;<saturation>;<opacity>). The hue shift is given in degree (0 to 360). The other parameters are given as multipliers, where 1 means the component remains unchanged. |
hotScale | string | 1.0;1.0;1.0 | Scaling factor applied when visual object is hovered. This is only supported on selected VOs, which do not present a defined geo area. Visibility: public |
key | string | Unique identifier for the object. This is optional. If not provided the default identifier sId is used. However, sId is generated if template binding is used and thus it is not stable. Provide the key if the object really needs to have a unique and stable identifier. Visibility: public |
|
labelArrow | boolean | false | The visual objects label arrow. For left/right/top/bottom aligned labels an additional arrow points to the label's object. Visibility: public |
labelBgColor | string | RGB(255;255;255) | The visual objects label background color. The default value is white. Visibility: public |
labelBorderColor | string | The visual objects label border color. The default is no border. Visibility: public |
|
labelPos | string | The visual objects label position. This property determines the positioning of the label relative to the VO it belongs to. Possible values are:
For multiple position based VOs, like Route, or Area the label is dynamically positioned. If the current display of a VO consists of multiple disconnected parts, each part gets an own label.Visibility: public |
|
labelText | string | The visual objects label text. Providing a label text required, but also sufficient the get a label displayed. Visibility: public |
|
labelType | sap.ui.vbm.SemanticType | None | Type for semantic labels. A given semantic type will overrule color settings and add an icon. Visibility: public |
select | boolean | false | Set to true if the element is selected Visibility: public |
selectColor | string | RHLSA(0.0;1.0;1.0;1.0) | Color change applied when visual object is selected. This can be explicit or a relative one. See above. Visibility: public |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
item | 0..1 | sap.ui.core.Control |
The control that should be placed in the container. |
Method | Description |
---|---|
destroyItem |
Destroys the item in the aggregation item. |
sap.ui.vbm.Container.extend |
Creates a new subclass of class sap.ui.vbm.Container with name
|
getAlignment |
Gets current value of property alignment. Alignment of the container to its position:
Default value is |
getItem |
Gets content of aggregation item. The control that should be placed in the container. |
sap.ui.vbm.Container.getMetadata |
Returns a metadata object for class sap.ui.vbm.Container. |
getPosition |
Gets current value of property position. The position for the Container. The format is "lon;lat;0". |
setAlignment |
Sets a new value for property alignment. Alignment of the container to its position:
When called with a value of Default value is |
setItem |
Sets the aggregated item. |
setPosition |
Sets a new value for property position. The position for the Container. The format is "lon;lat;0". When called with a value of |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Gets current value of property alignment.
Alignment of the container to its position:
Default value is '0'
.
Gets current value of property position.
The position for the Container. The format is "lon;lat;0".
Sets a new value for property alignment.
Alignment of the container to its position:
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is '0'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sAlignment | string | '0' |
New value for property |
Sets the aggregated item.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.core.Control |
The item to set |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sPosition | string |
New value for property |