Type specific Visual Object aggregation for Area instances.
Constructor for a new Areas.
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.Areas(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 |
---|---|---|---|
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.Area |
Area object aggregation |
Event | Description |
---|---|
edgeClick |
This event is raised when the edge of an Area is clicked. |
edgeContextMenu |
This event is raised when the edge of an Area is right clicked. |
This event is raised when the edge of an Area is clicked.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
instance | sap.ui.vbm.Area |
Clicked instance |
edge | int |
The number of the edge where the click occured. Edges are numbered zero based: e.g. edge from point 1 to point 2 has number 0 |
This event is raised when the edge of an Area is right clicked.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
instance | sap.ui.vbm.Area |
Clicked instance |
edge | int |
The number of the edge where the click occured. Edges are numbered zero based: e.g. edge from point 1 to point 2 has number 0 |
Method | Description |
---|---|
addItem |
Adds some item to the aggregation items. |
attachEdgeClick |
Attaches event handler When called, the context of the event handler (its This event is raised when the edge of an Area is clicked. |
attachEdgeContextMenu |
Attaches event handler When called, the context of the event handler (its This event is raised when the edge of an Area is right clicked. |
destroyItems |
Destroys all the items in the aggregation items. |
detachEdgeClick |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachEdgeContextMenu |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.vbm.Areas.extend |
Creates a new subclass of class sap.ui.vbm.Areas with name
|
fireEdgeClick |
Fires event edgeClick to attached listeners. |
fireEdgeContextMenu |
Fires event edgeContextMenu to attached listeners. |
getItems |
Gets content of aggregation items. Area object aggregation |
sap.ui.vbm.Areas.getMetadata |
Returns a metadata object for class sap.ui.vbm.Areas. |
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 |
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 |
Adds some item to the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.vbm.Area |
The item to add; if empty, nothing is inserted |
Attaches event handler fnFunction
to the edgeClick event of this sap.ui.vbm.Areas
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vbm.Areas
itself.
This event is raised when the edge of an Area is clicked.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the edgeContextMenu event of this sap.ui.vbm.Areas
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vbm.Areas
itself.
This event is raised when the edge of an Area is right clicked.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Detaches event handler fnFunction
from the edgeClick event of this sap.ui.vbm.Areas
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the edgeContextMenu event of this sap.ui.vbm.Areas
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Creates a new subclass of class sap.ui.vbm.Areas 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 |
Fires event edgeClick to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
instance | sap.ui.vbm.Area |
Clicked instance |
|
edge | int |
The number of the edge where the click occured. Edges are numbered zero based: e.g. edge from point 1 to point 2 has number 0 |
Fires event edgeContextMenu to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
instance | sap.ui.vbm.Area |
Clicked instance |
|
edge | int |
The number of the edge where the click occured. Edges are numbered zero based: e.g. edge from point 1 to point 2 has number 0 |
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
.
Checks for the provided sap.ui.vbm.Area
in the aggregation items. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.vbm.Area |
The item whose index is looked for |
Inserts a item into the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.vbm.Area |
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.Area |
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 |