Provides the ability to display logged console messages within your application.
Constructor for a new Notifications.
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.Notifications(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new Notifications control. Generated automatically if no ID is given. |
|
mSettings? | object | Initial settings for the new Notifications control. |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
_messagePopover | 0..1 | sap.m.MessagePopover | |
_messagePopoverToggleButton | 0..1 | sap.m.ToggleButton |
Event | Description |
---|---|
allMessagesCleared |
This event will be fired when all messages in the log are deleted. |
messageAdded |
This event will be fired when a new log message is added. |
Method | Description |
---|---|
attachAllMessagesCleared |
Attaches event handler When called, the context of the event handler (its This event will be fired when all messages in the log are deleted. |
attachMessageAdded |
Attaches event handler When called, the context of the event handler (its This event will be fired when a new log message is added. |
clearAllMessages |
Clears the items in the Message Popover list. |
detachAllMessagesCleared |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachMessageAdded |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.vk.Notifications.extend |
Creates a new subclass of class sap.ui.vk.Notifications with name
|
fireAllMessagesCleared |
Fires event allMessagesCleared to attached listeners. |
fireMessageAdded |
Fires event messageAdded to attached listeners. |
sap.ui.vk.Notifications.getMetadata |
Returns a metadata object for class sap.ui.vk.Notifications. |
Attaches event handler fnFunction
to the allMessagesCleared event of this sap.ui.vk.Notifications
.
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.Notifications
itself.
This event will be fired when all messages in the log are deleted.
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 |
Attaches event handler fnFunction
to the messageAdded event of this sap.ui.vk.Notifications
.
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.Notifications
itself.
This event will be fired when a new log message is added.
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 |
Detaches event handler fnFunction
from the allMessagesCleared event of this sap.ui.vk.Notifications
.
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 |
Detaches event handler fnFunction
from the messageAdded event of this sap.ui.vk.Notifications
.
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 |
Creates a new subclass of class sap.ui.vk.Notifications 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 |
Fires event allMessagesCleared to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event messageAdded to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |