Type specific Visual Object aggregation for Box instances.
Constructor for a new Boxes.
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.Boxes(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 |
---|---|---|---|
posChangeable | boolean | true | Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable. Visibility: public |
scaleChangeable | boolean | true | Set to true if scale may be changed at runtime. The actual changeability is control on each aggregated element with property changeable. Visibility: public |
Name | Type | Default Value | Description |
---|---|---|---|
customProperties | string[] | If you want to add custom data to VO instances and make the GeoMap control aware of it, e.g. for basing clustering rules on it, you can provide an array of property names specifying the keys to consider. Visibility: public |
|
maxSel | string | n | Selection cardinality: maximum selectable elements ( valid values are "0", "1", and "n" ) Visibility: public |
minSel | string | 0 | Selection cardinality: minimum selected elements ("0" or "1" ) Visibility: public |
Default Aggregation: items
Name | Cardinality | Type | Description |
---|---|---|---|
items (default) | 0..n | sap.ui.vbm.Box |
Box object aggregation |
Method | Description |
---|---|
addItem |
Adds some item to the aggregation items. |
destroyItems |
Destroys all the items in the aggregation items. |
sap.ui.vbm.Boxes.extend |
Creates a new subclass of class sap.ui.vbm.Boxes with name
|
getItems |
Gets content of aggregation items. Box object aggregation |
sap.ui.vbm.Boxes.getMetadata |
Returns a metadata object for class sap.ui.vbm.Boxes. |
getPosChangeable |
Gets current value of property posChangeable. Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable. Default value is |
getScaleChangeable |
Gets current value of property scaleChangeable. Set to true if scale may be changed at runtime. The actual changeability is control on each aggregated element with property changeable. Default value is |
indexOfItem |
Checks for the provided |
insertItem |
Inserts a item into the aggregation items. |
removeAllItems |
Removes all the controls from the aggregation items. Additionally, it unregisters them from the hosting UIArea. |
removeItem |
Removes a item from the aggregation items. |
setPosChangeable |
Sets a new value for property posChangeable. Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable. When called with a value of Default value is |
setScaleChangeable |
Sets a new value for property scaleChangeable. Set to true if scale may be changed at runtime. The actual changeability is control on each aggregated element with property changeable. When called with a value of Default value is |
Adds some item to the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.vbm.Box |
The item to add; if empty, nothing is inserted |
Creates a new subclass of class sap.ui.vbm.Boxes 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.VoAggregation.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 posChangeable.
Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.
Default value is true
.
Gets current value of property scaleChangeable.
Set to true if scale may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.
Default value is true
.
Checks for the provided sap.ui.vbm.Box
in the aggregation items. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.vbm.Box |
The item whose index is looked for |
Inserts a item into the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.vbm.Box |
The item to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation items.
Additionally, it unregisters them from the hosting UIArea.
Removes a item from the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
vItem | int string sap.ui.vbm.Box |
The item to remove or its index or id |
Sets a new value for property posChangeable.
Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bPosChangeable | boolean | true |
New value for property |
Sets a new value for property scaleChangeable.
Set to true if scale may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bScaleChangeable | boolean | true |
New value for property |