Package org.jgrapes.webconlet.messagebox

Class MessageBoxConlet

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.webconsole.base.AbstractConlet<Serializable>

org.jgrapes.webconsole.base.freemarker.FreeMarkerConlet<Serializable>

org.jgrapes.webconlet.messagebox.MessageBoxConlet

All Implemented Interfaces:

Iterable<ComponentType>, Channel, ComponentType, Eligible, Manager

public class MessageBoxConlet
extends FreeMarkerConlet<Serializable>

Example of a simple conlet.

Nested Class Summary

Nested classes/interfaces inherited from class org.jgrapes.webconsole.base.AbstractConlet

AbstractConlet.ConletTrackingInfo

Nested classes/interfaces inherited from interface org.jgrapes.core.Channel

Channel.Default

Field Summary

Fields inherited from class org.jgrapes.webconsole.base.AbstractConlet

TYPE_INSTANCE_SEPARATOR

Fields inherited from class org.jgrapes.core.Component

logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
MessageBoxConlet(Channel componentChannel)	Creates a new component with its channel set to the given channel.

Method Summary

Modifier and Type	Method	Description
protected Set<Conlet.RenderMode>	doRenderConlet(RenderConletRequestBase<?> event, ConsoleConnection channel, String conletId, Serializable conletState)	Called by AbstractConlet.onAddConletRequest(AddConletRequest, ConsoleConnection) and AbstractConlet.onRenderConletRequest(RenderConletRequest, ConsoleConnection) to complete rendering the web console component.
void	onConsoleReady(ConsoleReady event, ConsoleConnection connection)	Trigger loading of resources when the console is ready.

Methods inherited from class org.jgrapes.webconsole.base.freemarker.FreeMarkerConlet

doGetResource, fmConletModel, fmModel, fmModel, fmSessionModel, fmTypeModel, freemarkerConfig, processTemplate, processTemplate

Methods inherited from class org.jgrapes.webconsole.base.AbstractConlet

afterOnClosed, conletIds, conletIdsByConsoleConnection, conletViews, createNewState, createStateRepresentation, doConletDeleted, doRemoveConletType, doSetLocale, doUpdateConletState, generateInstanceId, l10nBundles, localizations, onAddConletRequest, onClosed, onConletDeleted, onConletResourceRequest, onDetached, onNotifyConletModel, onRenderConletRequest, onSetLocale, putInSession, readContent, readContent, recreateState, removeState, resourceBundle, setPeriodicRefresh, stateFromSession, statesFromSession, supportedLocales, trackConlet, trackedConnections, type, typeFromId

Methods inherited from class org.jgrapes.core.Component

channel, component, defaultCriterion, isEligibleFor, setName

Methods inherited from class org.jgrapes.core.internal.ComponentVertex

activeEventPipeline, addHandler, attach, channelReplacements, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, toString, unregisterAsGenerator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jgrapes.core.Manager

stream

Constructor Details

MessageBoxConlet

public MessageBoxConlet(Channel componentChannel)

Creates a new component with its channel set to the given channel.

Parameters:

componentChannel - the channel that the component’s handlers listen on by default and that Manager.fire(Event, Channel...) sends the event to

Method Details

onConsoleReady

@Handler
public void onConsoleReady(ConsoleReady event,
 ConsoleConnection connection)
                    throws TemplateNotFoundException,
MalformedTemplateNameException,
ParseException,
IOException

Trigger loading of resources when the console is ready.

Parameters:

event - the event

connection - the console connection

Throws:

TemplateNotFoundException - the template not found exception

MalformedTemplateNameException - the malformed template name exception

ParseException - the parse exception

IOException - Signals that an I/O exception has occurred.

doRenderConlet

protected Set<Conlet.RenderMode> doRenderConlet(RenderConletRequestBase<?> event,
 ConsoleConnection channel,
 String conletId,
 Serializable conletState)
                                         throws Exception

Description copied from class: AbstractConlet

Called by AbstractConlet.onAddConletRequest(AddConletRequest, ConsoleConnection) and AbstractConlet.onRenderConletRequest(RenderConletRequest, ConsoleConnection) to complete rendering the web console component.

The

Specified by:

doRenderConlet in class AbstractConlet<Serializable>

Parameters:

event - the event

channel - the channel

conletId - the component id

conletState - the conlet’s state; may be null if the conlet doesn’t have associated state information

Returns:

the rendered modes

Throws:

Exception - the exception