abstract class sap.ui.core.message.MessageProcessor

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/core/message/MessageProcessor
Application Component: CA-UI5-COR

This is an abstract base class for MessageProcessor objects.


Constructor

Constructor for a new MessageProcessor

new sap.ui.core.message.MessageProcessor()

Events Overview

Event Description
messageChange

The messageChange event is fired when the messages are changed.

messageChange

The messageChange event is fired when the messages are changed.

Param Type Description
oEvent sap.ui.base.Event

Methods Overview

Method Description
attachMessageChange

Attaches event handler fnFunction to the messageChange event of this sap.ui.core.message.MessageProcessor.

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.core.message.MessageProcessor itself.

checkMessages

Implement in inheriting classes

destroy

Destroys the MessageProcessor Instance

detachMessageChange

Detaches event handler fnFunction from the messageChange event of this sap.ui.core.message.MessageProcessor.

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

sap.ui.core.message.MessageProcessor.extend

Creates a new subclass of class sap.ui.core.message.MessageProcessor 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.base.EventProvider.extend.

fireMessageChange

Fires event messageChange to attached listeners.

getId

Returns the ID of the MessageProcessor instance

sap.ui.core.message.MessageProcessor.getMetadata

Returns a metadata object for class sap.ui.core.message.MessageProcessor.

setMessages

Implement in inheriting classes

attachMessageChange

Attaches event handler fnFunction to the messageChange event of this sap.ui.core.message.MessageProcessor.

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.core.message.MessageProcessor itself.

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

The function to be called, when the event occurs

oListener object

Context object to call the event handler with, defaults to this MessageProcessor itself

checkMessages

Implement in inheriting classes

destroy

Destroys the MessageProcessor Instance

detachMessageChange

Detaches event handler fnFunction from the messageChange event of this sap.ui.core.message.MessageProcessor.

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

Param Type DefaultValue Description
fnFunction function

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.core.message.MessageProcessor.extend

Creates a new subclass of class sap.ui.core.message.MessageProcessor 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.base.EventProvider.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

fireMessageChange

Fires event messageChange to attached listeners.

Param Type DefaultValue Description
oParameters object

Parameters to pass along with the event

getId

Returns the ID of the MessageProcessor instance

sap.ui.core.message.MessageProcessor.getMetadata

Returns a metadata object for class sap.ui.core.message.MessageProcessor.

setMessages

Implement in inheriting classes

Param Type DefaultValue Description
vMessages Object<string,array>

map of messages: {'target': [array of messages],...}