Package org.jgrapes.webconsole.base.events

Class DeleteConlet

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

All Implemented Interfaces:

Future<Void>, Associator, Eligible

public class DeleteConlet
extends ConsoleCommand

Request the browser to remove a conlet view from the display.

Field Summary

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

completed, completionEvents

Constructor Summary

Constructors

Constructor	Description
DeleteConlet(String conletId, Set<Conlet.RenderMode> renderModes)	Creates a new event.

Method Summary

Modifier and Type	Method	Description
String	conletId()	Returns the web console component id.
Set<Conlet.RenderMode>	renderModes()	Returns the render modes that should be deleted.
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

DeleteConlet

public DeleteConlet(String conletId,
 Set<Conlet.RenderMode> renderModes)

Creates a new event.

Parameters:

conletId - the web console component (view) that should be deleted

renderModes - the views to delete. If empty, all views should be deleted, i.e. the conlet may no longer be used in the browser.

Method Details

conletId

public String conletId()

Returns the web console component id.

Returns:

the web console component id

renderModes

public Set<Conlet.RenderMode> renderModes()

Returns the render modes that should be deleted.

An empty set indicates that all views should be deleted, i.e. the conlet is no longer used in the browser.

Returns:

the render modes

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