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.
Event Summary
click(oControlEvent)The event is raised when there is a click action on a VO. contextMenu(oControlEvent)The event is raised when there is a right click or a tap and hold action on a VO. deselect(oControlEvent)This event is raised when aggregated elements get deselected drop(oControlEvent)The event is raised when something is dropped on a VO. handleClick(oControlEvent)This event is raised when a Design handle is clicked. handleContextMenu(oControlEvent)This event is raised when a Design handle is right clicked. handleMoved(oControlEvent)This event is raised when a Design handle is moved. select(oControlEvent)This event is raised when aggregated elements get selected Method Summary
sap.ui.vbm.VoAggregation.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.VoAggregation with name sClassName
and enriches it with the information contained in oClassInfo
. attachClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction
to the click
event of this sap.ui.vbm.VoAggregation
. attachContextMenu(oData?, fnFunction, oListener?)Attaches event handler fnFunction
to the contextMenu
event of this sap.ui.vbm.VoAggregation
. attachDeselect(oData?, fnFunction, oListener?)Attaches event handler fnFunction
to the deselect
event of this sap.ui.vbm.VoAggregation
. attachDrop(oData?, fnFunction, oListener?)Attaches event handler fnFunction
to the drop
event of this sap.ui.vbm.VoAggregation
. attachHandleClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction
to the handleClick
event of this sap.ui.vbm.VoAggregation
. attachHandleContextMenu(oData?, fnFunction, oListener?)Attaches event handler fnFunction
to the handleContextMenu
event of this sap.ui.vbm.VoAggregation
. attachHandleMoved(oData?, fnFunction, oListener?)Attaches event handler fnFunction
to the handleMoved
event of this sap.ui.vbm.VoAggregation
. attachSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction
to the select
event of this sap.ui.vbm.VoAggregation
. detachClick(fnFunction, oListener)Detaches event handler fnFunction
from the click
event of this sap.ui.vbm.VoAggregation
. detachContextMenu(fnFunction, oListener)Detaches event handler fnFunction
from the contextMenu
event of this sap.ui.vbm.VoAggregation
. detachDeselect(fnFunction, oListener)Detaches event handler fnFunction
from the deselect
event of this sap.ui.vbm.VoAggregation
. detachDrop(fnFunction, oListener)Detaches event handler fnFunction
from the drop
event of this sap.ui.vbm.VoAggregation
. detachHandleClick(fnFunction, oListener)Detaches event handler fnFunction
from the handleClick
event of this sap.ui.vbm.VoAggregation
. detachHandleContextMenu(fnFunction, oListener)Detaches event handler fnFunction
from the handleContextMenu
event of this sap.ui.vbm.VoAggregation
. detachHandleMoved(fnFunction, oListener)Detaches event handler fnFunction
from the handleMoved
event of this sap.ui.vbm.VoAggregation
. detachSelect(fnFunction, oListener)Detaches event handler fnFunction
from the select
event of this sap.ui.vbm.VoAggregation
. fireClick(mArguments?)Fires event click
to attached listeners. fireDeselect(mArguments?)Fires event deselect
to attached listeners. fireDrop(mArguments?)Fires event drop
to attached listeners. fireSelect(mArguments?)Fires event select
to attached listeners. getMaxSel()Gets current value of property maxSel
. getMinSel()Gets current value of property minSel
. setMaxSel(sMaxSel)Sets a new value for property maxSel
. setMinSel(sMinSel)Sets a new value for property minSel
. $,
addCustomData,
addDependent,
addEventDelegate,
applyFocusInfo,
bindElement,
clone,
data,
destroy,
destroyCustomData,
destroyDependents,
destroyLayoutData,
destroyTooltip,
enhanceAccessibilityState,
exit,
findElements,
fireEvent,
focus,
getCustomData,
getDependents,
getDomRef,
getElementBinding,
getFocusDomRef,
getFocusInfo,
getInterface,
getLayoutData,
getMetadata,
getTooltip,
getTooltip_AsString,
getTooltip_Text,
indexOfCustomData,
indexOfDependent,
init,
insertCustomData,
insertDependent,
prop,
removeAllCustomData,
removeAllDependents,
removeCustomData,
removeDependent,
removeEventDelegate,
rerender,
setLayoutData,
setTooltip,
toString,
unbindElement addAggregation,
addAssociation,
applySettings,
attachFormatError,
attachModelContextChange,
attachParseError,
attachValidationError,
attachValidationSuccess,
bindAggregation,
bindContext,
bindObject,
bindProperty,
destroyAggregation,
detachFormatError,
detachModelContextChange,
detachParseError,
detachValidationError,
detachValidationSuccess,
findAggregatedObjects,
fireFormatError,
fireModelContextChange,
fireParseError,
fireValidationError,
fireValidationSuccess,
getAggregation,
getAssociation,
getBinding,
getBindingContext,
getBindingInfo,
getBindingPath,
getEventingParent,
getId,
getModel,
getObjectBinding,
getOriginInfo,
getParent,
getProperty,
hasModel,
indexOfAggregation,
insertAggregation,
invalidate,
isBound,
isInvalidateSuppressed,
isTreeBinding,
propagateMessages,
removeAggregation,
removeAllAggregation,
removeAllAssociation,
removeAssociation,
setAggregation,
setAssociation,
setBindingContext,
setModel,
setProperty,
unbindAggregation,
unbindContext,
unbindObject,
unbindProperty,
validateAggregation,
validateProperty Constructor Detail
new sap.ui.vbm.VoAggregation(sId?, mSettings?)
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 for a general description of the syntax of the settings object.
The supported settings are:
- Properties
- Events
- handleMoved : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- handleContextMenu : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- handleClick : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- select : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- deselect : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- click : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- contextMenu : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- drop : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
In addition, all settings applicable to the base type sap.ui.vbm.VoAbstract 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 |
Event Detail
click(oControlEvent)
The event is raised when there is a click action on a VO.
Parameters:
contextMenu(oControlEvent)
The event is raised when there is a right click or a tap and hold action on a VO.
Parameters:
deselect(oControlEvent)
This event is raised when aggregated elements get deselected
Parameters:
drop(oControlEvent)
The event is raised when something is dropped on a VO.
Parameters:
handleClick(oControlEvent)
This event is raised when a Design handle is clicked.
Parameters:
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters | |
{sap.ui.vbm.VoBase} | oControlEvent.getParameters.instance | Clicked instance |
{int} | oControlEvent.getParameters.handle | The number of the handle where the click occured. Handles are numbered zero based. |
handleContextMenu(oControlEvent)
This event is raised when a Design handle is right clicked.
Parameters:
handleMoved(oControlEvent)
This event is raised when a Design handle is moved.
Parameters:
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters | |
{sap.ui.vbm.VoBase} | oControlEvent.getParameters.instance | Clicked instance |
{int} | oControlEvent.getParameters.handle | The number of the handle where the click occured. Handles are numbered zero based. |
select(oControlEvent)
This event is raised when aggregated elements get selected
Parameters:
Method Detail
sap.ui.vbm.VoAggregation.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.
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 |
Returns a metadata object for class sap.ui.vbm.VoAggregation.
Returns:
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.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.vbm.VoAggregation itself |
Returns:
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.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.vbm.VoAggregation itself |
Returns:
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
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.vbm.VoAggregation itself |
Returns:
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.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.vbm.VoAggregation itself |
Returns:
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.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.vbm.VoAggregation itself |
Returns:
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.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.vbm.VoAggregation itself |
Returns:
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.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.vbm.VoAggregation itself |
Returns:
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
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.vbm.VoAggregation itself |
Returns:
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.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
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.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
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.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
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.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
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.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
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.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
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.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
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.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
Fires event
click
to attached listeners.
Expects the following event parameters:
instance
of type sap.ui.vbm.VoBase
Clicked instance
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
contextMenu
to attached listeners.
Expects the following event parameters:
instance
of type sap.ui.vbm.VoBase
Clicked instancemenu
of type sap.ui.unified.Menu
Menu to open
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
deselect
to attached listeners.
Expects the following event parameters:
deselected
of type array
Array of deselected VOs
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
drop
to attached listeners.
Expects the following event parameters:
instance
of type sap.ui.vbm.Spot
Drop target instancedragSource
of type sap.ui.vbm.VoBase
Dragged instance
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
handleClick
to attached listeners.
Expects the following event parameters:
instance
of type sap.ui.vbm.VoBase
Clicked instancehandle
of type int
The number of the handle where the click occured. Handles are numbered zero based.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
handleContextMenu
to attached listeners.
Expects the following event parameters:
instance
of type sap.ui.vbm.VoBase
Clicked instancemenu
of type sap.ui.unified.Menu
Menu to openhandle
of type int
The number of the handle where the click occured. Handles are numbered zero based.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
handleMoved
to attached listeners.
Expects the following event parameters:
instance
of type sap.ui.vbm.VoBase
Clicked instancehandle
of type int
The number of the handle where the click occured. Handles are numbered zero based.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
select
to attached listeners.
Expects the following event parameters:
selected
of type array
Array of selected VOs
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
getCustomProperties(): string[]
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.
Returns:
{string[]} | Value of property customProperties |
getMaxSel(): string
Gets current value of property
maxSel
.
Selection cardinality: maximum selectable elements ( valid values are "0", "1", and "n" )
Default value is n
.
Returns:
{string} | Value of property maxSel |
getMinSel(): string
Gets current value of property
minSel
.
Selection cardinality: minimum selected elements ("0" or "1" )
Default value is 0
.
Returns:
{string} | Value of property minSel |
openDetailWindow(oVoInst, oParams, bUseClickPos): void
Open a Detail Window
Parameters:
{sap.ui.vbm.VoBase} | oVoInst | VO instance for which the Detail Window should be opened |
{object} | oParams | Parameter object |
{string} | oParams.caption | Text for Detail Window caption |
{string} | oParams.offsetX | position offset in x-direction from the anchor point |
{string} | oParams.offsetY | position offset in y-direction from the anchor point |
{boolean} | bUseClickPos | 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.
Parameters:
{string[]} | sCustomProperties | New value for property customProperties |
Returns:
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
.
Parameters:
{string} | sMaxSel | New value for property maxSel |
Returns:
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
.
Parameters:
{string} | sMinSel | New value for property minSel |
Returns: