Package org.jgrapes.webconsole.base.events

Class OpenModalDialog

java.lang.Object

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

org.jgrapes.core.Event<Void>

org.jgrapes.webconsole.base.events.ConsoleCommand

org.jgrapes.webconsole.base.events.OpenModalDialog

All Implemented Interfaces:

Future<Void>, Associator, Eligible

public class OpenModalDialog
extends ConsoleCommand

Causes a modal dialog to be display on behalf of the conlet.

Field Summary

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

completed, completionEvents

Constructor Summary

Constructors

Constructor	Description
OpenModalDialog(String conletType, String conletId, Future<String> content)	Creates a new event without any options.
OpenModalDialog(String conletType, String conletId, Future<String> content, Map<String,Object> options)	Creates a new event.

Method Summary

Modifier and Type	Method	Description
OpenModalDialog	addOption(String name, Object value)	Adds an option to the event.
Future<String>	content()	Returns the content.
Map<String,Object>	options()	Return the options.
void	toJson(Writer writer)	Writes the event as JSON notification to the given writer.

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

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

Constructor Details

OpenModalDialog

public OpenModalDialog(String conletType,
 String conletId,
 Future<String> content,
 Map<String,Object> options)

Creates a new event.

The content must be valid HTML, i.e. it must start with a tag. See the JavaScript documentation of the modal dialog options for details.

Parameters:

conletType - the conlet type

conletId - the conlet id

content - the content (valid HTML)

options - the options (must be serializable as JSON), see the JavaScript documentation of the modal dialog options for details.

OpenModalDialog

public OpenModalDialog(String conletType,
 String conletId,
 Future<String> content)

Creates a new event without any options.

The content must be valid HTML, i.e. it must start with a tag.

Parameters:

conletType - the conlet type

conletId - the conlet id

content - the content (valid HTML)

Method Details

addOption

public OpenModalDialog 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 Future<String> content()

Returns the content.

Returns:

the content

options

public Map<String,Object> options()

Return the options.

Returns:

the options

toJson

public void toJson(Writer writer)
            throws IOException

Description copied from class: ConsoleCommand

Writes the event as JSON notification to the given writer.

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

Specified by:

toJson in class ConsoleCommand

Parameters:

writer - the writer

Throws:

IOException