Package org.jgrapes.webconsole.base.events

Class RenderConlet

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.RenderConlet

All Implemented Interfaces:

Future<Void>, Associator, Eligible

public class RenderConlet
extends ConsoleCommand

A console command for conlet rendering.

Sent to the web console page for adding or updating a complete web console component representation. The actual content (the HTML) is passed to the constructor as a Future, allowing the content to be evaluated in parallel to the event handling.

The content must be valid HTML, usable as inner HTML of a block level element (typically a div). If the root element has an attribute data-conlet-title, its value overrides the default title (the display name of the conlet type, see AddConletType.displayNames()).

The content provided is searched for attributes data-jgwc-on-load and data-jgwc-on-unload which must have as value the name of a function. When the HTML has been loaded or unloaded (i.e. added to the DOM or removed from the DOM), the respective functions are invoked with the element containing the attribute as their first parameter. A second boolean parameter is true if the on-load function is called due to an update of an already existing container.

The HTML elements of edit dialogs (Conlet.RenderMode.Edit) can have an additional attribute data-jgwc-on-apply which must have as its value the name of a function. This function is invoked when changes made in the form must be applied (e.g. before the dialog is closed).

Field Summary

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

completed, completionEvents

Constructor Summary

Constructors

Constructor	Description
RenderConlet(String conletType, String conletId, Future<String> content)	Creates a new event.

Method Summary

Modifier and Type	Method	Description
RenderConlet	addSupportedMode(Conlet.RenderMode supportedMode)	Add the given render mode to the supported render modes.
String	conletId()	Returns the web console component id as specified on creation.
String	conletType()	Returns the web console component type as specified on creation.
Future<String>	content()	Provides the HTML that displays the web console component on the page.
Set<Conlet.RenderMode>	renderAs()	Returns the render mode.
RenderConlet	setRenderAs(Set<Conlet.RenderMode> renderAs)	Set the render mode (including modifier).
RenderConlet	setRenderAs(Conlet.RenderMode renderMode)	Set the render mode.
RenderConlet	setSupportedModes(Set<Conlet.RenderMode> supportedModes)	Set the supported render modes.
Set<Conlet.RenderMode>	supportedRenderModes()	Returns the supported modes.
void	toJson(Writer writer)	Writes the 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

RenderConlet

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

Creates a new event.

Parameters:

conletType - the conlet type

conletId - the id of the web console component

content - the content

Method Details

conletType

public String conletType()

Returns the web console component type as specified on creation.

Returns:

the type

conletId

public String conletId()

Returns the web console component id as specified on creation.

Returns:

the web console component id

setRenderAs

public RenderConlet setRenderAs(Conlet.RenderMode renderMode)

Set the render mode.

The default value is Conlet.RenderMode.Preview.

Parameters:

renderMode - the render mode to set

Returns:

the event for easy chaining

setRenderAs

public RenderConlet setRenderAs(Set<Conlet.RenderMode> renderAs)

Set the render mode (including modifier).

Parameters:

renderAs - the render mode to use

Returns:

the event for easy chaining

renderAs

public Set<Conlet.RenderMode> renderAs()

Returns the render mode.

Returns:

the render mode

setSupportedModes

public RenderConlet setSupportedModes(Set<Conlet.RenderMode> supportedModes)

Set the supported render modes.

The default value is Conlet.RenderMode.Preview.

Parameters:

supportedModes - the supported render modes to set

Returns:

the event for easy chaining

addSupportedMode

public RenderConlet addSupportedMode(Conlet.RenderMode supportedMode)

Add the given render mode to the supported render modes.

Parameters:

supportedMode - the supported render modes to add

Returns:

the event for easy chaining

supportedRenderModes

public Set<Conlet.RenderMode> supportedRenderModes()

Returns the supported modes.

Returns:

the supported modes

content

public Future<String> content()

Provides the HTML that displays the web console component on the page.

Returns:

the HTML

toJson

public void toJson(Writer writer)
            throws InterruptedException,
IOException

Writes the JSON notification to the given writer.

Specified by:

toJson in class ConsoleCommand

Parameters:

writer - the writer

Throws:

ExecutionException

InterruptedException

IOException