Overview  Package   Class  Tree  Deprecated  Index  Help 
Oracle UIX API Reference
Release 2.1.22.0.0
B12196-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

oracle.cabo.servlet.ui
Class BaseUINodePageDescription

java.lang.Object
  |
  +--oracle.cabo.servlet.ui.BaseUINodePageDescription
All Implemented Interfaces:
PageDescription, UINodePageDescription
Direct Known Subclasses:
DefaultUINodePageDescription
public abstract class BaseUINodePageDescription
extends java.lang.Object
implements UINodePageDescription

Abstract implementation of UINodePageDescription.

Clients that wish to use the UIX <javaClass> element must make sure that they extend this class directly or indirectly. Most clients should simply extend DefaultUINodePageDescription.

Constructor Summary
BaseUINodePageDescription()
          Creates a BaseUINodePageDescription.
 
Method Summary
 UINode getHTMLHeadUINode()
          Get the UINode used to render the HTML <head> section.
 PageRenderer getPageRenderer(BajaContext context)
           
 java.lang.Object getProperty(java.lang.String namespace, java.lang.Object key)
          Gets a property on the PageDescription.
 UINode getRootUINode()
          Gets the default root UI node for the page.
abstract  void registerEventHandler(java.lang.String eventName, EventHandler handler)
          Registers an event handler to be called for a specific event name.
abstract  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 renderEnded(BajaContext context, Page page, RenderingContext rContext)
          A callback executed immediately after the page finishes rendering.
 void renderStarted(BajaContext context, Page page, RenderingContext rContext)
          A callback executed immediately before the page will start rendering.
abstract  void setDefaultEventHandler(EventHandler handler)
          Registers a default event handler, used if no event is registered for the listed name.
 void setHTMLHeadUINode(UINode head)
          Sets the node used to render the head section of the page.
 void setHTMLHeadUINodes(UINode[] headNodes)
          Sets the array of nodes used to render the head section of the page.
 void setProperty(java.lang.String namespace, java.lang.Object key, java.lang.Object value)
          Sets a property on the PageDescription.
 void setRootUINode(UINode root)
          Sets the default root UI node for the page.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.cabo.servlet.PageDescription
getEventHandler
 

Constructor Detail

BaseUINodePageDescription

public BaseUINodePageDescription()
Creates a BaseUINodePageDescription.
Method Detail

setDefaultEventHandler

public abstract void setDefaultEventHandler(EventHandler handler)
Registers a default event handler, used if no event is registered for the listed name.
Parameters:
handler - an event handler; if null, unregister the handler

registerEventHandler

public abstract 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.

registerEventHandlerForSource

public void registerEventHandlerForSource(java.lang.String eventSource,
                                          EventHandler handler)
Registers an event handler to be called for a specific event source.
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 abstract 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
eventName - the event source; if null, call this handler if called with an unregistered source
handler - an event handler; if null, unregister the handler at this name.

getPageRenderer

public final PageRenderer getPageRenderer(BajaContext context)
Specified by:
getPageRenderer in interface PageDescription
See Also:
PageDescription

getProperty

public java.lang.Object getProperty(java.lang.String namespace,
                                    java.lang.Object key)
Gets a property on the PageDescription.
Specified by:
getProperty in interface PageDescription

setProperty

public void setProperty(java.lang.String namespace,
                        java.lang.Object key,
                        java.lang.Object value)
Sets a property on the PageDescription.

getRootUINode

public UINode getRootUINode()
Gets the default root UI node for the page.
Specified by:
getRootUINode in interface UINodePageDescription

setRootUINode

public void setRootUINode(UINode root)
Sets the default root UI node for the page.

setHTMLHeadUINodes

public void setHTMLHeadUINodes(UINode[] headNodes)
Sets the array of nodes used to render the head section of the page.

setHTMLHeadUINode

public void setHTMLHeadUINode(UINode head)
Sets the node used to render the head section of the page.

getHTMLHeadUINode

public UINode getHTMLHeadUINode()
Get the UINode used to render the HTML <head> section.
Specified by:
getHTMLHeadUINode in interface UINodePageDescription

renderStarted

public void renderStarted(BajaContext context,
                          Page page,
                          RenderingContext rContext)
                   throws javax.servlet.ServletException
A callback executed immediately before the page will start rendering.
Specified by:
renderStarted in interface UINodePageDescription

renderEnded

public void renderEnded(BajaContext context,
                        Page page,
                        RenderingContext rContext)
                 throws javax.servlet.ServletException
A callback executed immediately after the page finishes rendering.
Specified by:
renderEnded in interface UINodePageDescription
Overview  Package   Class  Tree  Deprecated  Index  Help 
Oracle UIX API Reference
Release 2.1.22.0.0
B12196-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2002,2003, Oracle. All Rights Reserved.