class sap.ui.rta.util.changeVisualization.ChangeIndicator

Visiblity: restricted
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/rta/util/changeVisualization/ChangeIndicator
Application Component: CA-UI5-FL-RTA

Constructor for a new sap.ui.rta.util.changeVisualization.ChangeIndicator class. The ChangeIndicator class is used to visualize the changes of an app.


Constructor

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.rta.util.changeVisualization.ChangeIndicator()

Properties

Name Type Default Value Description
changes array

List of changes that should be rendered for the indicator

Visibility: public
mode string change

Mode of the indicator, "change" or "dependent"

Visibility: public
overlayId string

ID of the overlay that the indicator should be rendered in

Visibility: public
posX int

Distance from the left side of the screen in px

Visibility: public
posY int

Distance from the top of the screen in px

Visibility: public
selectorId string

ID of the selector that the indicator's changes belong to

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_icon 0..1 sap.ui.core.Icon
_popover 0..1 sap.m.Popover
_text 0..1 sap.m.Text

Events Overview

Event Description
keyPress

Fired when a key is pressed while the focus is on the indicator

selectChange

Fired when the details for a change should be displayed

keyPress

Fired when a key is pressed while the focus is on the indicator

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

selectChange

Fired when the details for a change should be displayed

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

Methods Overview

Method Description
attachKeyPress

Attaches event handler fnFunction to the keyPress event of this sap.ui.rta.util.changeVisualization.ChangeIndicator.

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.rta.util.changeVisualization.ChangeIndicator itself.

Fired when a key is pressed while the focus is on the indicator

attachSelectChange

Attaches event handler fnFunction to the selectChange event of this sap.ui.rta.util.changeVisualization.ChangeIndicator.

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.rta.util.changeVisualization.ChangeIndicator itself.

Fired when the details for a change should be displayed

detachKeyPress

Detaches event handler fnFunction from the keyPress event of this sap.ui.rta.util.changeVisualization.ChangeIndicator.

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

detachSelectChange

Detaches event handler fnFunction from the selectChange event of this sap.ui.rta.util.changeVisualization.ChangeIndicator.

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

sap.ui.rta.util.changeVisualization.ChangeIndicator.extend

Creates a new subclass of class sap.ui.rta.util.changeVisualization.ChangeIndicator 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.Control.extend.

fireKeyPress

Fires event keyPress to attached listeners.

fireSelectChange

Fires event selectChange to attached listeners.

getChanges

Gets current value of property changes.

List of changes that should be rendered for the indicator

Default value is [].

sap.ui.rta.util.changeVisualization.ChangeIndicator.getMetadata

Returns a metadata object for class sap.ui.rta.util.changeVisualization.ChangeIndicator.

getMode

Gets current value of property mode.

Mode of the indicator, "change" or "dependent"

Default value is "change".

getOverlayId

Gets current value of property overlayId.

ID of the overlay that the indicator should be rendered in

getPosX

Gets current value of property posX.

Distance from the left side of the screen in px

getPosY

Gets current value of property posY.

Distance from the top of the screen in px

getSelectorId

Gets current value of property selectorId.

ID of the selector that the indicator's changes belong to

setChanges

Sets a new value for property changes.

List of changes that should be rendered for the indicator

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

Default value is [].

setMode

Sets a new value for property mode.

Mode of the indicator, "change" or "dependent"

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

Default value is "change".

setOverlayId

Sets a new value for property overlayId.

ID of the overlay that the indicator should be rendered in

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

setPosX

Sets a new value for property posX.

Distance from the left side of the screen in px

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

setPosY

Sets a new value for property posY.

Distance from the top of the screen in px

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

setSelectorId

Sets a new value for property selectorId.

ID of the selector that the indicator's changes belong to

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

attachKeyPress

Attaches event handler fnFunction to the keyPress event of this sap.ui.rta.util.changeVisualization.ChangeIndicator.

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.rta.util.changeVisualization.ChangeIndicator itself.

Fired when a key is pressed while the focus is on the indicator

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.rta.util.changeVisualization.ChangeIndicator itself

attachSelectChange

Attaches event handler fnFunction to the selectChange event of this sap.ui.rta.util.changeVisualization.ChangeIndicator.

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.rta.util.changeVisualization.ChangeIndicator itself.

Fired when the details for a change should be displayed

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.rta.util.changeVisualization.ChangeIndicator itself

detachKeyPress

Detaches event handler fnFunction from the keyPress event of this sap.ui.rta.util.changeVisualization.ChangeIndicator.

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

detachSelectChange

Detaches event handler fnFunction from the selectChange event of this sap.ui.rta.util.changeVisualization.ChangeIndicator.

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.rta.util.changeVisualization.ChangeIndicator.extend

Creates a new subclass of class sap.ui.rta.util.changeVisualization.ChangeIndicator 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.Control.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

fireKeyPress

Fires event keyPress to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

originalEvent object

fireSelectChange

Fires event selectChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

changeId string

getChanges

Gets current value of property changes.

List of changes that should be rendered for the indicator

Default value is [].

sap.ui.rta.util.changeVisualization.ChangeIndicator.getMetadata

Returns a metadata object for class sap.ui.rta.util.changeVisualization.ChangeIndicator.

getMode

Gets current value of property mode.

Mode of the indicator, "change" or "dependent"

Default value is "change".

getOverlayId

Gets current value of property overlayId.

ID of the overlay that the indicator should be rendered in

getPosX

Gets current value of property posX.

Distance from the left side of the screen in px

getPosY

Gets current value of property posY.

Distance from the top of the screen in px

getSelectorId

Gets current value of property selectorId.

ID of the selector that the indicator's changes belong to

setChanges

Sets a new value for property changes.

List of changes that should be rendered for the indicator

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

Default value is [].

Param Type DefaultValue Description
sChanges array []

New value for property changes

setMode

Sets a new value for property mode.

Mode of the indicator, "change" or "dependent"

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

Default value is "change".

Param Type DefaultValue Description
sMode string "change"

New value for property mode

setOverlayId

Sets a new value for property overlayId.

ID of the overlay that the indicator should be rendered in

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

Param Type DefaultValue Description
sOverlayId string

New value for property overlayId

setPosX

Sets a new value for property posX.

Distance from the left side of the screen in px

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

Param Type DefaultValue Description
iPosX int

New value for property posX

setPosY

Sets a new value for property posY.

Distance from the top of the screen in px

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

Param Type DefaultValue Description
iPosY int

New value for property posY

setSelectorId

Sets a new value for property selectorId.

ID of the selector that the indicator's changes belong to

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

Param Type DefaultValue Description
sSelectorId string

New value for property selectorId