Package org.jgrapes.webconsole.base.events

Class DisplayNotification

java.lang.Object

org.jgrapes.core.internal.EventBase<Void>

org.jgrapes.core.Event<Void>

org.jgrapes.webconsole.base.events.ConsoleCommand

org.jgrapes.webconsole.base.events.DisplayNotification

All Implemented Interfaces:

Future<Void>, org.jgrapes.core.Associator, org.jgrapes.core.Eligible

public class DisplayNotification
extends ConsoleCommand

Causes a notification to be display on the top of the web console page.

The event triggers the creation of a notification widget in the web console page.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

Fields inherited from class org.jgrapes.webconsole.base.events.ConsoleCommand

mapper

Fields inherited from class org.jgrapes.core.internal.EventBase

completed, completionEvents, invokedFor

Constructor Summary

Constructors

Constructor	Description
DisplayNotification(String content)	Creates a new event without any options.
DisplayNotification(String content, Map<String,Object> options)	Creates a new event.

Method Summary

Modifier and Type	Method	Description
DisplayNotification	addOption(String name, Object value)	Adds an option to the event.
String	content()	Returns the content.
void	emitJson(Writer writer)	Emits the JSON notification using the given writer.
Map<String,Object>	options()	Return the options.

Methods inherited from class org.jgrapes.webconsole.base.events.ConsoleCommand

emitJson, toJson

Methods inherited from class org.jgrapes.core.Event

addCompletionEvent, associated, cancel, channels, channels, completionEvents, currentResults, defaultCriterion, forChannels, get, get, handled, handlingError, isCancelled, isDone, isEligibleFor, isStopped, processedBy, results, results, resumeHandling, setAssociated, setChannels, setRequiresResult, setResult, stop, suspendHandling, suspendHandling, tieTo, toString

Methods inherited from class org.jgrapes.core.internal.EventBase

disableTracking, enqueued, firstResultAssigned, isTracked, onCompletion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapes.core.Associator

associated, associated, associated, associatedGet

Methods inherited from interface java.util.concurrent.Future

exceptionNow, resultNow, state

Constructor Details

DisplayNotification

public DisplayNotification(String content,
 Map<String,Object> options)

Creates a new event.

The content must be valid HTML, i.e. it must start with a tag (usually a “<span>”). See the console’s notification method and the JavaScript documentation of the notification options for details.

Parameters:

content - the content (valid HTML)

options - the options (must be serializable as JSON)

DisplayNotification

public DisplayNotification(String content)

Creates a new event without any options.

The content must be valid HTML, i.e. it must start with a tag (usually a “<span>”).

Parameters:

content - the content (valid HTML)

Method Details

addOption

public DisplayNotification addOption(String name,
 Object value)

Adds an option to the event.

Parameters:

name - the option name

value - the option value (must be serializable as JSON)

Returns:

the event for easy chaining

content

public String content()

Returns the content.

Returns:

the content

options

public Map<String,Object> options()

Return the options.

Returns:

the options

emitJson

public void emitJson(Writer writer)
              throws IOException

Description copied from class: ConsoleCommand

Emits the JSON notification using the given writer.

Derived classes usually simply call ConsoleCommand.emitJson(Writer, String, Object...) with the method name and parameters.

Specified by:

emitJson in class ConsoleCommand

Parameters:

writer - the writer

Throws:

IOException