Package org.jgrapes.webconsole.base.events

Class UpdateConletType

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

All Implemented Interfaces:

Future<Void>, Associator, Eligible

public class UpdateConletType
extends ConsoleCommand

Inform the front-end about changes of a conlet type.

The only supported change is a modification of the render modes offered to the user (see AddConletType.addRenderMode(org.jgrapes.webconsole.base.Conlet.RenderMode).

Field Summary

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

completed, completionEvents

Constructor Summary

Constructors

Constructor	Description
UpdateConletType(String conletType)	Create a new event for the given web console component type.

Method Summary

Modifier and Type	Method	Description
UpdateConletType	addRenderMode(Conlet.RenderMode mode)	Add a render mode.
String	conletType()	Return the web console component type.
Set<Conlet.RenderMode>	renderModes()	Return the render modes.
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

UpdateConletType

public UpdateConletType(String conletType)

Create a new event for the given web console component type.

Parameters:

conletType - a unique id for the web console component type (usually the class name)

Method Details

conletType

public String conletType()

Return the web console component type.

Returns:

the web console component type

addRenderMode

public UpdateConletType addRenderMode(Conlet.RenderMode mode)

Add a render mode.

Parameters:

mode - the mode

Returns:

the event for easy chaining

renderModes

public Set<Conlet.RenderMode> renderModes()

Return the render modes.

Returns:

the result

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