Package org.jgrapes.webconsole.base.events

Class RenderConletRequest

java.lang.Object

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

org.jgrapes.core.Event<Boolean>

org.jgrapes.webconsole.base.events.RenderConletRequestBase<Boolean>

org.jgrapes.webconsole.base.events.RenderConletRequest

All Implemented Interfaces:

Future<Boolean>, org.jgrapes.core.Associator, org.jgrapes.core.Eligible

public class RenderConletRequest
extends RenderConletRequestBase<Boolean>

Sent to the web console (server) if an existing web console component instance should be updated.

The web console server usually responds with a RenderConlet event that has as payload the HTML that displays the web console component on the web console page.

The event’s result must be set to true by the rendering web console component.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

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

completed, completionEvents, invokedFor

Constructor Summary

Constructors

Constructor	Description
RenderConletRequest(RenderSupport renderSupport, String conletId, Set<Conlet.RenderMode> renderModes)	Creates a new request.

Method Summary

Modifier and Type	Method	Description
String	conletId()	Returns the web console component id.
String	conletType()	Return the web console component type.
boolean	hasBeenRendered()	Checks if the web console component has been rendered (i.e. the event has been handled).

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

renderAs, renderSupport

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

Methods inherited from interface java.util.concurrent.Future

exceptionNow, resultNow, state

Constructor Details

RenderConletRequest

public RenderConletRequest(RenderSupport renderSupport,
 String conletId,
 Set<Conlet.RenderMode> renderModes)

Creates a new request.

Parameters:

renderSupport - the render support for generating the response

conletId - the web console component to be updated

renderModes - the render options

Method Details

conletType

public String conletType()

Return the web console component type.

Returns:

the web console component type

conletId

public String conletId()

Returns the web console component id.

Returns:

the web console component id

hasBeenRendered

public boolean hasBeenRendered()

Checks if the web console component has been rendered (i.e. the event has been handled).

Returns:

true, if successful