class sap.ui.vk.OverlayArea

Control sample: sap.ui.vk.OverlayArea
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vk/OverlayArea
Application Component: CA-UI5-VTK

Aggregation element for the Overlay Control


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.ui.vk.OverlayArea(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


Properties

Name Type Default Value Description
changeable boolean false

Set to true if OverlayArea is changeable.

Visibility: public
color sap.ui.core.CSSColor rgba(200, 50, 50, 0.3)

The fill color of the OverlayArea.

Visibility: public
colorBorder sap.ui.core.CSSColor rgba(200, 50, 50, 1.0)

The border color of the OverlayArea.

Visibility: public
colorNonSelect string

The non-select color of the OverlayArea in case non-selection de-highlighting is desired.

Visibility: public
colorSelect string

The select color of the OverlayArea in case selection highlighting is desired.

Visibility: public
deltaColorHot string RHLSA(0;1.3;1.0;1.0)

Color or color delta when object is hovered. Color deltas can be declared in the format RHLSA(;;;)

Visibility: public
key string

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.

Visibility: public
position string

The position array for the OverlayArea. The format is "x0;y0;0;...;xN,yN,0".

Visibility: public
select boolean false

set to true if the element is selected

Visibility: public

Events Overview

Event Description
click

The event is raised when there is a click action on an OverlayArea.

contextMenu

The event is raised when there is a right click or a tap and hold action on an OverlayArea.

edgeClick

This event is raised when the edge of an OverlayArea is clicked.

edgeContextMenu

This event is raised when the edge of an OverlayArea is right clicked.

handleClick

This event is raised when the design handle of a changeable OverlayArea is clicked.

handleContextMenu

This event is raised when the design handle of a changeable OverlayArea is right clicked.

handleMoved

This event is raised when the design handle of a changeable OverlayArea is moved.

click

The event is raised when there is a click action on an OverlayArea.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

contextMenu

The event is raised when there is a right click or a tap and hold action on an OverlayArea.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
menu sap.ui.unified.Menu

Menu to open

edgeClick

This event is raised when the edge of an OverlayArea is clicked.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
index int

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

This event is raised when the edge of an OverlayArea is right clicked.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
index int

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.

menu sap.ui.unified.Menu

Menu to open

handleClick

This event is raised when the design handle of a changeable OverlayArea is clicked.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

handleContextMenu

This event is raised when the design handle of a changeable OverlayArea is right clicked.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
index int

Index of the clicked handle. The numbering is zero based.

menu sap.ui.unified.Menu

Menu to open

handleMoved

This event is raised when the design handle of a changeable OverlayArea is moved.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

Methods Overview

Method Description
attachClick

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.

attachContextMenu

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.

attachEdgeClick

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.

attachEdgeContextMenu

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.

attachHandleClick

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 changeable OverlayArea is clicked.

attachHandleContextMenu

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 changeable OverlayArea is right clicked.

attachHandleMoved

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 changeable OverlayArea is moved.

detachClick

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.

detachContextMenu

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.

detachEdgeClick

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.

detachEdgeContextMenu

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.

detachHandleClick

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.

detachHandleContextMenu

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.

detachHandleMoved

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.

sap.ui.vk.OverlayArea.extend

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.

fireClick

Fires event click to attached listeners.

fireContextMenu

Fires event contextMenu to attached listeners.

fireEdgeClick

Fires event edgeClick to attached listeners.

fireEdgeContextMenu

Fires event edgeContextMenu to attached listeners.

fireHandleClick

Fires event handleClick to attached listeners.

fireHandleContextMenu

Fires event handleContextMenu to attached listeners.

fireHandleMoved

Fires event handleMoved to attached listeners.

getChangeable

Gets current value of property changeable.

Set to true if OverlayArea is changeable.

Default value is false.

getColor

Gets current value of property color.

The fill color of the OverlayArea.

Default value is "rgba(200, 50, 50, 0.3)".

getColorBorder

Gets current value of property colorBorder.

The border color of the OverlayArea.

Default value is "rgba(200, 50, 50, 1.0)".

getColorNonSelect

Gets current value of property colorNonSelect.

The non-select color of the OverlayArea in case non-selection de-highlighting is desired.

getColorSelect

Gets current value of property colorSelect.

The select color of the OverlayArea in case selection highlighting is desired.

getDeltaColorHot

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)".

getKey

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.

sap.ui.vk.OverlayArea.getMetadata

Returns a metadata object for class sap.ui.vk.OverlayArea.

getPosition

Gets current value of property position.

The position array for the OverlayArea. The format is "x0;y0;0;...;xN,yN,0".

getSelect

Gets current value of property select.

set to true if the element is selected

Default value is false.

openContextMenu

open the context menu

setChangeable

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.

setColor

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)".

setColorBorder

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)".

setColorNonSelect

Sets a new value for property colorNonSelect.

The non-select color of the OverlayArea in case non-selection de-highlighting is desired.

When called with a value of null or undefined, the default value of the property will be restored.

setColorSelect

Sets a new value for property colorSelect.

The select color of the OverlayArea in case selection highlighting is desired.

When called with a value of null or undefined, the default value of the property will be restored.

setDeltaColorHot

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)".

setKey

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.

setPosition

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.

setSelect

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.

attachClick

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.

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 sap.ui.vk.OverlayArea itself

attachContextMenu

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.

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 sap.ui.vk.OverlayArea itself

attachEdgeClick

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.

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 sap.ui.vk.OverlayArea itself

attachEdgeContextMenu

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.

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 sap.ui.vk.OverlayArea itself

attachHandleClick

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 changeable OverlayArea 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 sap.ui.vk.OverlayArea itself

attachHandleContextMenu

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 changeable OverlayArea 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 sap.ui.vk.OverlayArea itself

attachHandleMoved

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 changeable OverlayArea 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 sap.ui.vk.OverlayArea itself

detachClick

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.

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

detachContextMenu

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.

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

detachEdgeClick

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.

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

detachEdgeContextMenu

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.

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

detachHandleClick

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.

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

detachHandleContextMenu

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.

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

detachHandleMoved

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.

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

sap.ui.vk.OverlayArea.extend

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.

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

fireClick

Fires event click to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireContextMenu

Fires event contextMenu to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

menu sap.ui.unified.Menu

Menu to open

fireEdgeClick

Fires event edgeClick to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

index int

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.

fireEdgeContextMenu

Fires event edgeContextMenu to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

index int

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.

menu sap.ui.unified.Menu

Menu to open

fireHandleClick

Fires event handleClick to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireHandleContextMenu

Fires event handleContextMenu to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

index int

Index of the clicked handle. The numbering is zero based.

menu sap.ui.unified.Menu

Menu to open

fireHandleMoved

Fires event handleMoved to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getChangeable

Gets current value of property changeable.

Set to true if OverlayArea is changeable.

Default value is false.

getColor

Gets current value of property color.

The fill color of the OverlayArea.

Default value is "rgba(200, 50, 50, 0.3)".

getColorBorder

Gets current value of property colorBorder.

The border color of the OverlayArea.

Default value is "rgba(200, 50, 50, 1.0)".

getColorNonSelect

Gets current value of property colorNonSelect.

The non-select color of the OverlayArea in case non-selection de-highlighting is desired.

getColorSelect

Gets current value of property colorSelect.

The select color of the OverlayArea in case selection highlighting is desired.

getDeltaColorHot

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)".

getKey

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.

sap.ui.vk.OverlayArea.getMetadata

Returns a metadata object for class sap.ui.vk.OverlayArea.

getPosition

Gets current value of property position.

The position array for the OverlayArea. The format is "x0;y0;0;...;xN,yN,0".

getSelect

Gets current value of property select.

set to true if the element is selected

Default value is false.

openContextMenu

open the context menu

Param Type DefaultValue Description
oMenu object

the context menu to be opened

setChangeable

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.

Param Type DefaultValue Description
bChangeable boolean false

New value for property changeable

setColor

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)".

Param Type DefaultValue Description
sColor sap.ui.core.CSSColor "rgba(200, 50, 50, 0.3)"

New value for property color

setColorBorder

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)".

Param Type DefaultValue Description
sColorBorder sap.ui.core.CSSColor "rgba(200, 50, 50, 1.0)"

New value for property colorBorder

setColorNonSelect

Sets a new value for property colorNonSelect.

The non-select color of the OverlayArea in case non-selection de-highlighting is desired.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sColorNonSelect string

New value for property colorNonSelect

setColorSelect

Sets a new value for property colorSelect.

The select color of the OverlayArea in case selection highlighting is desired.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sColorSelect string

New value for property colorSelect

setDeltaColorHot

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)".

Param Type DefaultValue Description
sDeltaColorHot string "RHLSA(0;1.3;1.0;1.0)"

New value for property deltaColorHot

setKey

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.

Param Type DefaultValue Description
sKey string

New value for property key

setPosition

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.

Param Type DefaultValue Description
sPosition string

New value for property position

setSelect

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.

Param Type DefaultValue Description
bSelect boolean false

New value for property select