org.ametys.runtime.plugins.admin.notificator

Class Notification

java.lang.Object

org.ametys.runtime.plugins.admin.notificator.Notification

public class Notification
extends Object

Represents a client-side notification.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Notification.NotificationType The possible type of notification

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_action The associated JS action
protected String	_iconGlyph The icon of the notification
protected I18nizableText	_message The detailed message of the notification
protected I18nizableText	_title The title of the notification
protected Notification.NotificationType	_type The type of notification

Constructor Summary

Constructors

Constructor and Description
Notification(Notification.NotificationType type, I18nizableText title, I18nizableText message, String iconGlyph, String action) Constructs a new notification.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	toMap() Gets the representation of a notification as a map

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_type

protected Notification.NotificationType _type

The type of notification

_title

protected I18nizableText _title

The title of the notification

_message

protected I18nizableText _message

The detailed message of the notification

_iconGlyph

protected String _iconGlyph

The icon of the notification

_action

protected String _action

The associated JS action

Constructor Detail

Notification

public Notification(Notification.NotificationType type,
                    I18nizableText title,
                    I18nizableText message,
                    String iconGlyph,
                    String action)

Constructs a new notification.

Parameters:

type - The type of notification

title - The title of the notification

message - The detailed message (description) of the notification (can contain HTML)

iconGlyph - The icon of the notification

action - The JS action to execute when clicking on '<a>' elements of description

Method Detail

toMap

public Map<String,Object> toMap()

Gets the representation of a notification as a map

Returns:

The notification as a map