Oracle UIX API Reference
Release 2.1.22.0.0
B12196-01

oracle.cabo.servlet.event
Class TableEventHandler

java.lang.Object
  |
  +--oracle.cabo.servlet.event.TableEventHandler
All Implemented Interfaces:
EventHandler

public class TableEventHandler
extends java.lang.Object
implements EventHandler

Implementation of EventHandler that will dispatch to other event handlers based either or both the event name and event source. When multiple handlers are registered that could apply to any single event, they are used in the following descending priority order:

  1. Event handlers registered against both an event name and event source
  2. Event handlers registered only against an event name
  3. Event handlers registered only against an event source
  4. The default event handler

The highest priority handler that is applicable to the current event will be used. All lower priority handlers will be ignored.


Constructor Summary
  TableEventHandler()
          Create a TableEventHandler.
protected TableEventHandler(java.lang.String paramKey)
           
 
Method Summary
 EventHandler getDefaultEventHandler()
          Returns the default event handler, used if no handler is registered for an event name.
protected  EventHandler getDefaultEventHandlerImpl(boolean createIfNull)
           
 EventHandler getEventHandler(java.lang.String eventName)
          Returns the event handler used for the given event name.
protected  EventHandler getEventHandlerImpl(java.lang.String eventKey, boolean createIfNull)
          Returns the event handler used for the given event name.
 EventResult handleEvent(BajaContext context, Page page, PageEvent event)
          Handles an event.
 void registerEventHandler(java.lang.String eventName, EventHandler handler)
          Registers an event handler to be called for a specific event name.
 void registerEventHandler(java.lang.String eventName, java.lang.String eventSource, EventHandler handler)
          Registers an event handler to be called for a specific event name.
 void registerEventHandlerForSource(java.lang.String eventSource, EventHandler handler)
          Registers an event handler to be called for a specific event source but any event name.
protected  void registerEventHandlerImpl(java.lang.String eventKey, EventHandler handler)
          Registers an event handler to be called for a specific event name.
 void resetEventHandlers()
          Clears all event handlers
 void setDefaultEventHandler(EventHandler handler)
          Sets the default event handler, used if no handler is registered for an event name.
protected  void setDefaultEventHandlerImpl(EventHandler handler)
          Sets the default event handler, used if no handler is registered for an event name.
 void unregisterEventHandler(java.lang.String eventName)
          Unregisters an event handler.
 void unregisterEventHandler(java.lang.String eventName, java.lang.String eventSource)
          Unregisters an event handler.
 void unregisterEventHandlerForSource(java.lang.String eventSource)
          Unregisters an event handler.
protected  void unregisterEventHandlerImpl(java.lang.String eventKey)
          Unregisters an event handler.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TableEventHandler

public TableEventHandler()
Create a TableEventHandler.

TableEventHandler

protected TableEventHandler(java.lang.String paramKey)
Method Detail

setDefaultEventHandler

public void setDefaultEventHandler(EventHandler handler)
Sets the default event handler, used if no handler is registered for an event name.
Parameters:
handler - an event handler; if null, use no default handler

getDefaultEventHandler

public EventHandler getDefaultEventHandler()
Returns the default event handler, used if no handler is registered for an event name.

registerEventHandler

public void registerEventHandler(java.lang.String eventName,
                                 EventHandler handler)
Registers an event handler to be called for a specific event name.
Parameters:
eventName - the event name; if null, call this handler if called with a null event
handler - an event handler; if null, unregister the handler at this name.

unregisterEventHandler

public void unregisterEventHandler(java.lang.String eventName)
Unregisters an event handler.
Parameters:
eventName - the event name

registerEventHandler

public void registerEventHandler(java.lang.String eventName,
                                 java.lang.String eventSource,
                                 EventHandler handler)
Registers an event handler to be called for a specific event name.
Parameters:
eventName - the event name; if null, call this handler if called with a null event
eventSource - the event source; if null, call this handler if called with a null source
handler - an event handler; if null, unregister the handler at this name.

unregisterEventHandler

public void unregisterEventHandler(java.lang.String eventName,
                                   java.lang.String eventSource)
Unregisters an event handler.
Parameters:
eventName - the event name
eventSource - the event source; if null, call this handler if called with a null source

registerEventHandlerForSource

public void registerEventHandlerForSource(java.lang.String eventSource,
                                          EventHandler handler)
Registers an event handler to be called for a specific event source but any event name.
Parameters:
eventSource - the event source; if null, call this handler if called with a null source
handler - an event handler; if null, unregister the handler at this name.

unregisterEventHandlerForSource

public void unregisterEventHandlerForSource(java.lang.String eventSource)
Unregisters an event handler.
Parameters:
eventSource - the event source; if null, call this handler if called with a null source

resetEventHandlers

public void resetEventHandlers()
Clears all event handlers

getEventHandler

public EventHandler getEventHandler(java.lang.String eventName)
Returns the event handler used for the given event name.

handleEvent

public EventResult handleEvent(BajaContext context,
                               Page page,
                               PageEvent event)
                        throws java.lang.Throwable
Handles an event.
Specified by:
handleEvent in interface EventHandler
Parameters:
context - the BajaContext
page - the page the client is requesting
event - the event on that page, or null if the client is just requesting a page display
Returns:
the page that should be displayed in response to this event
Throws:
UnhandledEventException - if no handler is registered for a non-null event.
java.lang.Throwable - if any processing of the event fails

registerEventHandlerImpl

protected void registerEventHandlerImpl(java.lang.String eventKey,
                                        EventHandler handler)
Registers an event handler to be called for a specific event name.
Parameters:
eventKey - the event key; if null, call this handler if called with a null event
handler - an event handler; if null, unregister the handler at this name.

unregisterEventHandlerImpl

protected void unregisterEventHandlerImpl(java.lang.String eventKey)
Unregisters an event handler.
Parameters:
eventKey - the event key

setDefaultEventHandlerImpl

protected void setDefaultEventHandlerImpl(EventHandler handler)
Sets the default event handler, used if no handler is registered for an event name.
Parameters:
handler - an event handler; if null, use no default handler

getEventHandlerImpl

protected EventHandler getEventHandlerImpl(java.lang.String eventKey,
                                           boolean createIfNull)
Returns the event handler used for the given event name.

getDefaultEventHandlerImpl

protected EventHandler getDefaultEventHandlerImpl(boolean createIfNull)

Oracle UIX API Reference
Release 2.1.22.0.0
B12196-01

Copyright © 2002,2003, Oracle. All Rights Reserved.