Package org.jgrapes.webconsole.base.events

Class NotifyConletView

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

All Implemented Interfaces:

Future<Void>, Associator, Eligible

public class NotifyConletView
extends ConsoleCommand

A notification (as defined by the JSON RPC specification) to be sent to the web console component view (the browser).

Field Summary

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

completed, completionEvents

Constructor Summary

Constructors

Constructor	Description
NotifyConletView(String conletType, String conletId, String method, Object... params)	Creates a new event.

Method Summary

Modifier and Type	Method	Description
String	conletId()	Returns the web console component id.
String	conletType()	Returns the web console component class.
String	method()	Returns the method to be executed.
Object[]	params()	Returns the parameters.
void	toJson(Writer writer)	Writes the event as JSON notification to the given writer.
String	toString()

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

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

NotifyConletView

public NotifyConletView(String conletType,
 String conletId,
 String method,
 Object... params)

Creates a new event.

Parameters:

conletType - the web console component type (used by the console core JS to look up the available functions, see AddConletType)

conletId - the web console component (view) instance that the notification is directed at

method - the method (function) to be executed, must have been registered by handling AddConletType

params - the parameters

Method Details

conletType

public String conletType()

Returns the web console component class.

Returns:

the web console component class

conletId

public String conletId()

Returns the web console component id.

Returns:

the web console component id

method

public String method()

Returns the method to be executed.

Returns:

the method

params

public Object[] params()

Returns the parameters.

Returns:

the parameters

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

toString

public String toString()

Overrides:

toString in class Event<Void>