Class RenderConletRequest
java.lang.Object
org.jgrapes.core.internal.EventBase<T>
org.jgrapes.core.Event<T>
org.jgrapes.webconsole.base.events.RenderConletRequestBase<Boolean>
org.jgrapes.webconsole.base.events.RenderConletRequest
- All Implemented Interfaces:
Future<Boolean>
,Associator
,Eligible
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.
-
Field Summary
Fields inherited from class org.jgrapes.core.internal.EventBase
completed, completionEvents
-
Constructor Summary
ConstructorsConstructorDescriptionRenderConletRequest
(RenderSupport renderSupport, String conletId, Set<Conlet.RenderMode> renderModes) Creates a new request. -
Method Summary
Modifier and TypeMethodDescriptionconletId()
Returns the web console component id.boolean
Checks if the web console component has been rendered (i.e.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
-
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 responseconletId
- the web console component to be updatedrenderModes
- the render options
-
-
Method Details
-
conletId
Returns the web console component id.- Returns:
- the web console component id
-
hasBeenRendered
Checks if the web console component has been rendered (i.e.the event has been handled).
- Returns:
- true, if successful
-