Aggregation element for the Overlay Control
Experimental API:Since 1.32.0 This class is experimental and might be modified or removed in future versions.
Event Summary
click(oControlEvent)The event is raised when there is a click action on an OverlayArea. contextMenu(oControlEvent)The event is raised when there is a right click or a tap and hold action on an OverlayArea. edgeClick(oControlEvent)This event is raised when the edge of an OverlayArea is clicked. edgeContextMenu(oControlEvent)This event is raised when the edge of an OverlayArea is right clicked. handleClick(oControlEvent)This event is raised when the design handle of a changable OverlayArea is clicked. handleContextMenu(oControlEvent)This event is raised when the design handle of a changable OverlayArea is right clicked. handleMoved(oControlEvent)This event is raised when the design handle of a changable OverlayArea is moved. Method Summary
sap.ui.vk.OverlayArea.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vk.OverlayArea 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.vk.OverlayArea. attachContextMenu(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the contextMenu event of this sap.ui.vk.OverlayArea. attachEdgeClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the edgeClick event of this sap.ui.vk.OverlayArea. attachEdgeContextMenu(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the edgeContextMenu event of this sap.ui.vk.OverlayArea. attachHandleClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the handleClick event of this sap.ui.vk.OverlayArea. attachHandleContextMenu(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the handleContextMenu event of this sap.ui.vk.OverlayArea. attachHandleMoved(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the handleMoved event of this sap.ui.vk.OverlayArea. detachClick(fnFunction, oListener)Detaches event handler fnFunction from the click event of this sap.ui.vk.OverlayArea. detachContextMenu(fnFunction, oListener)Detaches event handler fnFunction from the contextMenu event of this sap.ui.vk.OverlayArea. detachEdgeClick(fnFunction, oListener)Detaches event handler fnFunction from the edgeClick event of this sap.ui.vk.OverlayArea. detachEdgeContextMenu(fnFunction, oListener)Detaches event handler fnFunction from the edgeContextMenu event of this sap.ui.vk.OverlayArea. detachHandleClick(fnFunction, oListener)Detaches event handler fnFunction from the handleClick event of this sap.ui.vk.OverlayArea. detachHandleContextMenu(fnFunction, oListener)Detaches event handler fnFunction from the handleContextMenu event of this sap.ui.vk.OverlayArea. detachHandleMoved(fnFunction, oListener)Detaches event handler fnFunction from the handleMoved event of this sap.ui.vk.OverlayArea. fireClick(mArguments?)Fires event click to attached listeners. fireEdgeClick(mArguments?)Fires event edgeClick to attached listeners. getColor()Gets current value of property color. getKey()Gets current value of property key. getSelect()Gets current value of property select. setChangeable(bChangeable)Sets a new value for property changeable. setColor(sColor)Sets a new value for property color. setColorBorder(sColorBorder)Sets a new value for property colorBorder. setColorSelect(sColorSelect)Sets a new value for property colorSelect. setKey(sKey)Sets a new value for property key. setPosition(sPosition)Sets a new value for property position. setSelect(bSelect)Sets a new value for property select. $,
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.vk.OverlayArea(sId?, mSettings?)
Constructor for a new OverlayArea.
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
- click : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- contextMenu : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- edgeClick : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- edgeContextMenu : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- 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]
In addition, all settings applicable to the base type sap.ui.core.Element 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 an OverlayArea.
Parameters:
contextMenu(oControlEvent)
The event is raised when there is a right click or a tap and hold action on an OverlayArea.
Parameters:
edgeClick(oControlEvent)
This event is raised when the edge of an OverlayArea is clicked.
Parameters:
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters | |
| {int} | oControlEvent.getParameters.index | Index of the clicked edge. The numbering is zero based and the first edge with index 0 starts at the first position in the position array and end at the second. |
edgeContextMenu(oControlEvent)
This event is raised when the edge of an OverlayArea is right clicked.
Parameters:
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters | |
| {int} | oControlEvent.getParameters.index | Index of the clicked edge. The numbering is zero based and the first edge with index 0 starts at the first position in the position array and end at the second. |
| {sap.ui.unified.Menu} | oControlEvent.getParameters.menu | Menu to open |
handleClick(oControlEvent)
This event is raised when the design handle of a changable OverlayArea is clicked.
Parameters:
handleContextMenu(oControlEvent)
This event is raised when the design handle of a changable OverlayArea is right clicked.
Parameters:
handleMoved(oControlEvent)
This event is raised when the design handle of a changable OverlayArea is moved.
Parameters:
Method Detail
sap.ui.vk.OverlayArea.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vk.OverlayArea 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.core.Element.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.vk.OverlayArea.
Returns:
Attaches event handler
fnFunction to the
click event of this
sap.ui.vk.OverlayArea.
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.vk.OverlayArea itself.
The event is raised when there is a click action on an OverlayArea.
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.vk.OverlayArea itself |
Returns:
Attaches event handler
fnFunction to the
contextMenu event of this
sap.ui.vk.OverlayArea.
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.vk.OverlayArea itself.
The event is raised when there is a right click or a tap and hold action on an OverlayArea.
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.vk.OverlayArea itself |
Returns:
Attaches event handler
fnFunction to the
edgeClick event of this
sap.ui.vk.OverlayArea.
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.vk.OverlayArea itself.
This event is raised when the edge of an OverlayArea 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.vk.OverlayArea itself |
Returns:
Attaches event handler
fnFunction to the
edgeContextMenu event of this
sap.ui.vk.OverlayArea.
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.vk.OverlayArea itself.
This event is raised when the edge of an OverlayArea 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.vk.OverlayArea itself |
Returns:
Attaches event handler
fnFunction to the
handleClick event of this
sap.ui.vk.OverlayArea.
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.vk.OverlayArea itself.
This event is raised when the design handle of a changable OverlayArea 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.vk.OverlayArea itself |
Returns:
Attaches event handler
fnFunction to the
handleContextMenu event of this
sap.ui.vk.OverlayArea.
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.vk.OverlayArea itself.
This event is raised when the design handle of a changable OverlayArea 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.vk.OverlayArea itself |
Returns:
Attaches event handler
fnFunction to the
handleMoved event of this
sap.ui.vk.OverlayArea.
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.vk.OverlayArea itself.
This event is raised when the design handle of a changable OverlayArea 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.vk.OverlayArea itself |
Returns:
Detaches event handler
fnFunction from the
click event of this
sap.ui.vk.OverlayArea.
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.vk.OverlayArea.
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
edgeClick event of this
sap.ui.vk.OverlayArea.
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
edgeContextMenu event of this
sap.ui.vk.OverlayArea.
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.vk.OverlayArea.
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.vk.OverlayArea.
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.vk.OverlayArea.
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.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
contextMenu to attached listeners.
Expects the following event parameters:
menu of type sap.ui.unified.MenuMenu to open
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
edgeClick to attached listeners.
Expects the following event parameters:
index of type intIndex of the clicked edge. The numbering is zero based and the first edge with index 0 starts at the first position in the position array and end at the second.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
edgeContextMenu to attached listeners.
Expects the following event parameters:
index of type intIndex of the clicked edge. The numbering is zero based and the first edge with index 0 starts at the first position in the position array and end at the second.menu of type sap.ui.unified.MenuMenu to open
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event handleClick to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
handleContextMenu to attached listeners.
Expects the following event parameters:
index of type intIndex of the clicked handle. The numbering is zero based.menu of type sap.ui.unified.MenuMenu to open
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event handleMoved to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
getChangeable(): boolean
Gets current value of property
changeable.
Set to true if OverlayArea is changeable.
Default value is false.
Returns:
| {boolean} | Value of property changeable |
Gets current value of property
color.
The fill color of the OverlayArea.
Default value is rgba(200, 50, 50, 0.3).
Returns:
Gets current value of property
colorBorder.
The border color of the OverlayArea.
Default value is rgba(200, 50, 50, 1.0).
Returns:
getColorNonSelect(): string
Gets current value of property
colorNonSelect.
The non-select color of the OverlayArea in case non-selection de-highligthing is desired.
Returns:
| {string} | Value of property colorNonSelect |
getColorSelect(): string
Gets current value of property
colorSelect.
The select color of the OverlayArea in case selection highligthing is desired.
Returns:
| {string} | Value of property colorSelect |
getDeltaColorHot(): string
Gets current value of property
deltaColorHot.
Color or color delta when object is hovered. Color deltas can be declared in the format RHLSA(;;;)
Default value is RHLSA(0;1.3;1.0;1.0).
Returns:
| {string} | Value of property deltaColorHot |
getKey(): string
Gets current value of property
key.
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 a unique and stable identifier.
Returns:
| {string} | Value of property key |
getPosition(): string
Gets current value of property
position.
The position array for the OverlayArea. The format is "x0;y0;0;...;xN,yN,0".
Returns:
| {string} | Value of property position |
getSelect(): boolean
Gets current value of property
select.
set to true if the element is selected
Default value is false.
Returns:
| {boolean} | Value of property select |
openContextMenu(oMenu): void
open the context menu
Parameters:
| {object} | oMenu | the context menu to be opened |
Sets a new value for property
changeable.
Set to true if OverlayArea is changeable.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is false.
Parameters:
| {boolean} | bChangeable | New value for property changeable |
Returns:
Sets a new value for property
color.
The fill color of the OverlayArea.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is rgba(200, 50, 50, 0.3).
Parameters:
Returns:
Sets a new value for property
colorBorder.
The border color of the OverlayArea.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is rgba(200, 50, 50, 1.0).
Parameters:
Returns:
Sets a new value for property
colorNonSelect.
The non-select color of the OverlayArea in case non-selection de-highligthing is desired.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sColorNonSelect | New value for property colorNonSelect |
Returns:
Sets a new value for property
colorSelect.
The select color of the OverlayArea in case selection highligthing is desired.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sColorSelect | New value for property colorSelect |
Returns:
Sets a new value for property
deltaColorHot.
Color or color delta when object is hovered. Color deltas can be declared in the format RHLSA(;;;)
When called with a value of null or undefined, the default value of the property will be restored.
Default value is RHLSA(0;1.3;1.0;1.0).
Parameters:
| {string} | sDeltaColorHot | New value for property deltaColorHot |
Returns:
Sets a new value for property
key.
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 a unique and stable identifier.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sKey | New value for property key |
Returns:
Sets a new value for property
position.
The position array for the OverlayArea. The format is "x0;y0;0;...;xN,yN,0".
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sPosition | New value for property position |
Returns:
Sets a new value for property
select.
set to true if the element is selected
When called with a value of null or undefined, the default value of the property will be restored.
Default value is false.
Parameters:
| {boolean} | bSelect | New value for property select |
Returns: