class sap.ui.vbm.Region

Control sample: sap.ui.vbm.Region
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vbm/Region
Application Component: CA-GTF-VBZ

Region properties.


Constructor

Constructor for a new Region.

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.Region(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
code string

The region code.

Visibility: public
color sap.ui.core.CSSColor

The color, this must be provided in the rgba(r,g,b,a) format.

Visibility: public
labelArrow boolean false

The visual objects label arrow. For left/right/top/bottom aligned labels an additional arrow points to the label's object.

Visibility: public
labelBgColor string RGB(255;255;255) Visibility: public
labelBorderColor string Visibility: public
labelText string Visibility: public
labelType sap.ui.vbm.SemanticType None

Type for semantic labels. A given semantic type will overrule color settings and add an icon.

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 a region.

contextMenu

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

click

The event is raised when there is a click action on a region.

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

The region code.

contextMenu

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

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

The region code.


Methods Overview

Method Description
attachClick

Attaches event handler fnFunction to the click event of this sap.ui.vbm.Region.

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.Region itself.

The event is raised when there is a click action on a region.

attachContextMenu

Attaches event handler fnFunction to the contextMenu event of this sap.ui.vbm.Region.

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.Region itself.

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

detachClick

Detaches event handler fnFunction from the click event of this sap.ui.vbm.Region.

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.vbm.Region.

The passed function and listener object must match the ones used for event registration.

sap.ui.vbm.Region.extend

Creates a new subclass of class sap.ui.vbm.Region 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.

getCode

Gets current value of property code.

The region code.

getColor

Gets current value of property color.

The color, this must be provided in the rgba(r,g,b,a) format.

getInfo

Returns Infos for the Region like name, bounding box and midpoint

getLabelArrow

Gets current value of property labelArrow.

The visual objects label arrow. For left/right/top/bottom aligned labels an additional arrow points to the label's object.

Default value is false.

getLabelBgColor

Gets current value of property labelBgColor.

Default value is 'RGB(255;255;255)'.

getLabelBorderColor

Gets current value of property labelBorderColor.

getLabelText

Gets current value of property labelText.

getLabelType

Gets current value of property labelType.

Type for semantic labels. A given semantic type will overrule color settings and add an icon.

Default value is None.

sap.ui.vbm.Region.getMetadata

Returns a metadata object for class sap.ui.vbm.Region.

getSelect

Gets current value of property select.

set to true if the element is selected

Default value is false.

setCode

Sets a new value for property code.

The region code.

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

setColor

Sets a new value for property color.

The color, this must be provided in the rgba(r,g,b,a) format.

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

setLabelArrow

Sets a new value for property labelArrow.

The visual objects label arrow. For left/right/top/bottom aligned labels an additional arrow points to the label's object.

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

Default value is false.

setLabelBgColor

Sets a new value for property labelBgColor.

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

Default value is 'RGB(255;255;255)'.

setLabelBorderColor

Sets a new value for property labelBorderColor.

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

setLabelText

Sets a new value for property labelText.

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

setLabelType

Sets a new value for property labelType.

Type for semantic labels. A given semantic type will overrule color settings and add an icon.

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

Default value is None.

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.vbm.Region.

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.Region itself.

The event is raised when there is a click action on a region.

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.vbm.Region itself

attachContextMenu

Attaches event handler fnFunction to the contextMenu event of this sap.ui.vbm.Region.

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.Region itself.

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

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.vbm.Region itself

detachClick

Detaches event handler fnFunction from the click event of this sap.ui.vbm.Region.

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.vbm.Region.

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.vbm.Region.extend

Creates a new subclass of class sap.ui.vbm.Region 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

code string

The region code.

fireContextMenu

Fires event contextMenu to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

code string

The region code.

getCode

Gets current value of property code.

The region code.

getColor

Gets current value of property color.

The color, this must be provided in the rgba(r,g,b,a) format.

getInfo

Returns Infos for the Region like name, bounding box and midpoint

getLabelArrow

Gets current value of property labelArrow.

The visual objects label arrow. For left/right/top/bottom aligned labels an additional arrow points to the label's object.

Default value is false.

getLabelBgColor

Gets current value of property labelBgColor.

Default value is 'RGB(255;255;255)'.

getLabelBorderColor

Gets current value of property labelBorderColor.

getLabelText

Gets current value of property labelText.

getLabelType

Gets current value of property labelType.

Type for semantic labels. A given semantic type will overrule color settings and add an icon.

Default value is None.

sap.ui.vbm.Region.getMetadata

Returns a metadata object for class sap.ui.vbm.Region.

getSelect

Gets current value of property select.

set to true if the element is selected

Default value is false.

setCode

Sets a new value for property code.

The region code.

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

Param Type DefaultValue Description
sCode string

New value for property code

setColor

Sets a new value for property color.

The color, this must be provided in the rgba(r,g,b,a) format.

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

Param Type DefaultValue Description
sColor sap.ui.core.CSSColor

New value for property color

setLabelArrow

Sets a new value for property labelArrow.

The visual objects label arrow. For left/right/top/bottom aligned labels an additional arrow points to the label's object.

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
bLabelArrow boolean false

New value for property labelArrow

setLabelBgColor

Sets a new value for property labelBgColor.

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

Default value is 'RGB(255;255;255)'.

Param Type DefaultValue Description
sLabelBgColor string 'RGB(255;255;255)'

New value for property labelBgColor

setLabelBorderColor

Sets a new value for property labelBorderColor.

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

Param Type DefaultValue Description
sLabelBorderColor string

New value for property labelBorderColor

setLabelText

Sets a new value for property labelText.

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

Param Type DefaultValue Description
sLabelText string

New value for property labelText

setLabelType

Sets a new value for property labelType.

Type for semantic labels. A given semantic type will overrule color settings and add an icon.

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

Default value is None.

Param Type DefaultValue Description
sLabelType sap.ui.vbm.SemanticType None

New value for property labelType

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