Abstract VO aggregation container. This element implements the common part for all specific VO aggregations with selection cardinatities. It must not be used directly, but is the base for further extension.
Constructor for a new VoAggregation.
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.VoAggregation(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 |
Event | Description |
---|---|
click |
The event is raised when there is a click action on a VO. |
contextMenu |
The event is raised when there is a right click or a tap and hold action on a VO. |
deselect |
This event is raised when aggregated elements get deselected |
drop |
The event is raised when something is dropped on a VO. |
handleClick |
This event is raised when a Design handle is clicked. |
handleContextMenu |
This event is raised when a Design handle is right clicked. |
handleMoved |
This event is raised when a Design handle is moved. |
select |
This event is raised when aggregated elements get selected |
The event is raised when there is a click action on a VO.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
instance | sap.ui.vbm.VoBase |
Clicked instance |
The event is raised when there is a right click or a tap and hold action on a VO.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
instance | sap.ui.vbm.VoBase |
Clicked instance |
menu | sap.ui.unified.Menu |
Menu to open |
This event is raised when aggregated elements get deselected
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
deselected | array |
Array of deselected VOs |
The event is raised when something is dropped on a VO.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
instance | sap.ui.vbm.Spot |
Drop target instance |
dragSource | sap.ui.vbm.VoBase |
Dragged instance |
This event is raised when a Design handle is clicked.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
instance | sap.ui.vbm.VoBase |
Clicked instance |
handle | int |
The number of the handle where the click occured. Handles are numbered zero based. |
This event is raised when a Design handle is right clicked.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
instance | sap.ui.vbm.VoBase |
Clicked instance |
menu | sap.ui.unified.Menu |
Menu to open |
handle | int |
The number of the handle where the click occured. Handles are numbered zero based. |
This event is raised when a Design handle is moved.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
instance | sap.ui.vbm.VoBase |
Clicked instance |
handle | int |
The number of the handle where the click occured. Handles are numbered zero based. |
Method | Description |
---|---|
attachClick |
Attaches event handler When called, the context of the event handler (its The event is raised when there is a click action on a VO. |
attachContextMenu |
Attaches event handler When called, the context of the event handler (its The event is raised when there is a right click or a tap and hold action on a VO. |
attachDeselect |
Attaches event handler When called, the context of the event handler (its This event is raised when aggregated elements get deselected |
attachDrop |
Attaches event handler When called, the context of the event handler (its The event is raised when something is dropped on a VO. |
attachHandleClick |
Attaches event handler When called, the context of the event handler (its This event is raised when a Design handle is clicked. |
attachHandleContextMenu |
Attaches event handler When called, the context of the event handler (its This event is raised when a Design handle is right clicked. |
attachHandleMoved |
Attaches event handler When called, the context of the event handler (its This event is raised when a Design handle is moved. |
attachSelect |
Attaches event handler When called, the context of the event handler (its This event is raised when aggregated elements get selected |
detachClick |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachContextMenu |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachDeselect |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachDrop |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachHandleClick |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachHandleContextMenu |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachHandleMoved |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachSelect |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.vbm.VoAggregation.extend |
Creates a new subclass of class sap.ui.vbm.VoAggregation with name
|
fireClick |
Fires event click to attached listeners. |
fireContextMenu |
Fires event contextMenu to attached listeners. |
fireDeselect |
Fires event deselect to attached listeners. |
fireDrop |
Fires event drop to attached listeners. |
fireHandleClick |
Fires event handleClick to attached listeners. |
fireHandleContextMenu |
Fires event handleContextMenu to attached listeners. |
fireHandleMoved |
Fires event handleMoved to attached listeners. |
fireSelect |
Fires event select to attached listeners. |
getCustomProperties |
Gets current value of property customProperties. 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. |
getMaxSel |
Gets current value of property maxSel. Selection cardinality: maximum selectable elements ( valid values are "0", "1", and "n" ) Default value is |
sap.ui.vbm.VoAggregation.getMetadata |
Returns a metadata object for class sap.ui.vbm.VoAggregation. |
getMinSel |
Gets current value of property minSel. Selection cardinality: minimum selected elements ("0" or "1" ) Default value is |
openDetailWindow |
Open a Detail Window |
setCustomProperties |
Sets a new value for property customProperties. 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. When called with a value of |
setMaxSel |
Sets a new value for property maxSel. Selection cardinality: maximum selectable elements ( valid values are "0", "1", and "n" ) When called with a value of Default value is |
setMinSel |
Sets a new value for property minSel. Selection cardinality: minimum selected elements ("0" or "1" ) When called with a value of Default value is |
Attaches event handler fnFunction
to the click event of this sap.ui.vbm.VoAggregation
.
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.VoAggregation
itself.
The event is raised when there is a click action on a VO.
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 contextMenu event of this sap.ui.vbm.VoAggregation
.
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.VoAggregation
itself.
The event is raised when there is a right click or a tap and hold action on a VO.
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 deselect event of this sap.ui.vbm.VoAggregation
.
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.VoAggregation
itself.
This event is raised when aggregated elements get deselected
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 drop event of this sap.ui.vbm.VoAggregation
.
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.VoAggregation
itself.
The event is raised when something is dropped on a VO.
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 handleClick event of this sap.ui.vbm.VoAggregation
.
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.VoAggregation
itself.
This event is raised when a Design handle 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 handleContextMenu event of this sap.ui.vbm.VoAggregation
.
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.VoAggregation
itself.
This event is raised when a Design handle 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 |
Attaches event handler fnFunction
to the handleMoved event of this sap.ui.vbm.VoAggregation
.
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.VoAggregation
itself.
This event is raised when a Design handle is moved.
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 select event of this sap.ui.vbm.VoAggregation
.
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.VoAggregation
itself.
This event is raised when aggregated elements get selected
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 click event of this sap.ui.vbm.VoAggregation
.
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 contextMenu event of this sap.ui.vbm.VoAggregation
.
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 deselect event of this sap.ui.vbm.VoAggregation
.
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 drop event of this sap.ui.vbm.VoAggregation
.
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 handleClick event of this sap.ui.vbm.VoAggregation
.
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 handleContextMenu event of this sap.ui.vbm.VoAggregation
.
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 handleMoved event of this sap.ui.vbm.VoAggregation
.
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 select event of this sap.ui.vbm.VoAggregation
.
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.VoAggregation 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.VoAbstract.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 click to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
instance | sap.ui.vbm.VoBase |
Clicked instance |
Fires event contextMenu to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
instance | sap.ui.vbm.VoBase |
Clicked instance |
|
menu | sap.ui.unified.Menu |
Menu to open |
Fires event deselect to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
deselected | array |
Array of deselected VOs |
Fires event drop to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
instance | sap.ui.vbm.Spot |
Drop target instance |
|
dragSource | sap.ui.vbm.VoBase |
Dragged instance |
Fires event handleClick to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
instance | sap.ui.vbm.VoBase |
Clicked instance |
|
handle | int |
The number of the handle where the click occured. Handles are numbered zero based. |
Fires event handleContextMenu to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
instance | sap.ui.vbm.VoBase |
Clicked instance |
|
menu | sap.ui.unified.Menu |
Menu to open |
|
handle | int |
The number of the handle where the click occured. Handles are numbered zero based. |
Fires event handleMoved to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
instance | sap.ui.vbm.VoBase |
Clicked instance |
|
handle | int |
The number of the handle where the click occured. Handles are numbered zero based. |
Fires event select to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
selected | array |
Array of selected VOs |
Gets current value of property customProperties.
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.
Gets current value of property maxSel.
Selection cardinality: maximum selectable elements ( valid values are "0", "1", and "n" )
Default value is "n"
.
Gets current value of property minSel.
Selection cardinality: minimum selected elements ("0" or "1" )
Default value is "0"
.
Open a Detail Window
Param | Type | DefaultValue | Description |
---|---|---|---|
oVoInst | sap.ui.vbm.VoBase |
VO instance for which the Detail Window should be opened |
|
oParams | object |
Parameter object |
|
caption | string |
Text for Detail Window caption |
|
offsetX | string |
position offset in x-direction from the anchor point |
|
offsetY | string |
position offset in y-direction from the anchor point |
|
bUseClickPos | boolean |
Indicates whether the Detail Window should be located at the click position or object position |
Sets a new value for property customProperties.
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.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sCustomProperties | string[] |
New value for property |
Sets a new value for property maxSel.
Selection cardinality: maximum selectable elements ( valid values are "0", "1", and "n" )
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is "n"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sMaxSel | string | "n" |
New value for property |
Sets a new value for property minSel.
Selection cardinality: minimum selected elements ("0" or "1" )
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 |
---|---|---|---|
sMinSel | string | "0" |
New value for property |