dk.brics.jwig

Class EventHandler

java.lang.Object

dk.brics.jwig.WebContext

dk.brics.jwig.AbstractHandler

dk.brics.jwig.EventHandler

@Regenerable
public abstract class EventHandler
extends AbstractHandler

Handler for HTML events.

A plain handler has a void run method that is invoked when the event occurs.

The run method for a handler that has been constructed with a session argument returns an XML value. This XML value can be obtained from an XML producer via getProducer().

The run methods may take parameters corresponding to form field values.

Field Summary

Fields inherited from class dk.brics.jwig.WebContext

CACHE_PRIORITY, context, HANDLERS, JWIG_DEFUNCT_SESSION, log, MAX_PRIORITY, PRE_CACHE

Constructor Summary

Constructors

Constructor and Description
EventHandler(boolean value, Object... dependencies) Constructs a new event handler with a JavaScript boolean value.
EventHandler(boolean value, Session ses, Object... dependencies) Constructs a new event handler with a JavaScript boolean value and a session.
EventHandler(Object... dependencies) Constructs a new event handler.
EventHandler(Session ses) Constructs a new event handler with a session.

Method Summary

Methods

Modifier and Type	Method and Description
String	getHandlerIdentifier() Returns the JavaScript instruction for running this event handler.
XMLProducer	getProducer() Creates an XML producer for this event handler.
void	setLatestReturnValue(XML val) Invoked by the runtime system after the run method has been invoked to store the resulting XML value for the XML producer, and then notifies listeners of the XML producer.

Methods inherited from class dk.brics.jwig.AbstractHandler

destroy, hashCode, process, toString

Methods inherited from class dk.brics.jwig.WebContext

addCookie, addResponseInvalidator, augment, cache, getCacheAugmentedString, getCookies, getRequestURL, getResponse, getServletContext, getServletRequest, getServletResponse, getUser, getWebAppParam, getWebAppParam, getWebAppURL, getWebSite, getWebSiteURL, getWebSiteURL, handlers, handleUpdatedObjects, isSecure, jwigJS, main, makeURL, makeURL, makeURL, makeURL, makeURL, makeURL, makeURL, next, punish, sendEmail, sendEmails, sendEmailsAsynchronously, sendResponse, touchSessions, transportSessionHandlers, update

Methods inherited from class java.lang.Object

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

Constructor Detail

EventHandler

public EventHandler(boolean value,
            Object... dependencies)

Constructs a new event handler with a JavaScript boolean value.

EventHandler

public EventHandler(boolean value,
            Session ses,
            Object... dependencies)

Constructs a new event handler with a JavaScript boolean value and a session.

EventHandler

public EventHandler(Object... dependencies)

Constructs a new event handler.

EventHandler

public EventHandler(Session ses)

Constructs a new event handler with a session.

Method Detail

getHandlerIdentifier

public final String getHandlerIdentifier()

Returns the JavaScript instruction for running this event handler. The instruction results in the boolean value set by the event handler constructor.

Overrides:

getHandlerIdentifier in class AbstractHandler

getProducer

public XMLProducer getProducer()

Creates an XML producer for this event handler.

setLatestReturnValue

public void setLatestReturnValue(XML val)

Invoked by the runtime system after the run method has been invoked to store the resulting XML value for the XML producer, and then notifies listeners of the XML producer.