oracle.cabo.servlet.ui
Class DefaultUINodePageDescription

java.lang.Object
  |
  +--oracle.cabo.servlet.ui.BaseUINodePageDescription
        |
        +--oracle.cabo.servlet.ui.DefaultUINodePageDescription

All Implemented Interfaces:

PageDescription, UINodePageDescription

Direct Known Subclasses:

ParseErrorsPageDescription

public class DefaultUINodePageDescription

extends BaseUINodePageDescription

Default implementation of PageDescription for UIX Component-rendered pages.

Constructor Summary

DefaultUINodePageDescription()
Creates a DefaultUINodePageDescription.

DefaultUINodePageDescription(UINode root)
Creates a UINodePageDescription initialized with a UINode.

Method Summary

protected PageRenderer	createPageRenderer() Creates the PageRenderer that will be used for rendering the PageDescription.
EventHandler	getDefaultEventHandler() Registers a default event handler, used if no event is registered for the listed name.
EventHandler	getEventHandler(BajaContext context)
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.
void	resetEventHandlers() Clears all event handlers
void	setDefaultEventHandler(EventHandler handler) Registers a default event handler, used if no event is registered for the listed 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.

Methods inherited from class oracle.cabo.servlet.ui.BaseUINodePageDescription

getHTMLHeadUINode, getPageRenderer, getProperty, getRootUINode, renderEnded, renderStarted, setHTMLHeadUINode, setHTMLHeadUINodes, setProperty, setRootUINode

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultUINodePageDescription

public DefaultUINodePageDescription()

Creates a DefaultUINodePageDescription.

DefaultUINodePageDescription

public DefaultUINodePageDescription(UINode root)

Creates a UINodePageDescription initialized with a UINode.

Parameters:

root - the UINode tree for the root of the page contents.

Method Detail

setDefaultEventHandler

public void setDefaultEventHandler(EventHandler handler)

Registers a default event handler, used if no event is registered for the listed name.

Overrides:

setDefaultEventHandler in class BaseUINodePageDescription

Parameters:

handler - an event handler; if null, unregister the handler

getDefaultEventHandler

public EventHandler getDefaultEventHandler()

Registers a default event handler, used if no event is registered for the listed name.

registerEventHandler

public void registerEventHandler(java.lang.String eventName,
                                 EventHandler handler)

Registers an event handler to be called for a specific event name.

Overrides:

registerEventHandler in class BaseUINodePageDescription

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.

registerEventHandlerForSource

public void registerEventHandlerForSource(java.lang.String eventSource,
                                          EventHandler handler)

Registers an event handler to be called for a specific event source.

Overrides:

registerEventHandlerForSource in class BaseUINodePageDescription

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.

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.

Overrides:

registerEventHandler in class BaseUINodePageDescription

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 an unrecognised event source

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

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

resetEventHandlers

public void resetEventHandlers()

Clears all event handlers

getEventHandler

public final EventHandler getEventHandler(BajaContext context)

See Also:

PageDescription

createPageRenderer

protected PageRenderer createPageRenderer()

Creates the PageRenderer that will be used for rendering the PageDescription. Defaults to creating a page renderer for HTML.