oracle.cabo.servlet.ui
Class UINodePageRenderer

java.lang.Object
  |
  +--oracle.cabo.servlet.ui.UINodePageRenderer

All Implemented Interfaces:

PageRenderer

Direct Known Subclasses:

HTMLUINodePageRenderer

public abstract class UINodePageRenderer

extends java.lang.Object

implements PageRenderer

Implementation of PageRenderer for UINode nodes.

Constructor Summary

UINodePageRenderer(UINodePageDescription description)
Creates a UINodePageRenderer.

Method Summary

protected RenderingContext	createRenderingContext(BajaContext context, java.io.PrintWriter out, Page page) Create the rendering context for the page.
protected java.lang.String	getCharacterEncoding(BajaContext context, Page page) Returns the character encoding to be used on this page.
protected java.lang.String	getContentType() Returns the content type of the page.
protected UINodePageDescription	getPageDescription() Returns the PageDescription used for this renderer.
protected UINode	getRootUINode(BajaContext context, RenderingContext rContext, Page page) Return the node that should be used to render the page.
protected boolean	isEmbedded(BajaContext context, Page page) Returns whether the Renderer should behave as if it is rendering embedded content, or the content for an entire page.
void	renderPage(BajaContext context, Page page) Renders a page by asking a UINode to render it.

Methods inherited from class java.lang.Object

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

Constructor Detail

UINodePageRenderer

public UINodePageRenderer(UINodePageDescription description)

Creates a UINodePageRenderer.

Method Detail

renderPage

public void renderPage(BajaContext context,
                       Page page)
                throws java.io.IOException,
                       javax.servlet.ServletException

Renders a page by asking a UINode to render it.

Specified by:

renderPage in interface PageRenderer

Parameters:

context - the BajaContext

page - the page returned from handleRequest

getContentType

protected java.lang.String getContentType()

Returns the content type of the page. By default, this returns null, which will allow UIX to properly default the MIME type for the agent. It can be overridden to force the output to a specific content type.

getCharacterEncoding

protected java.lang.String getCharacterEncoding(BajaContext context,
                                                Page page)

Returns the character encoding to be used on this page. Defaults, in order, to:

1. any character encoding on our PageDecoder
2. any character encoding set on the ServletRequest
3. UTF-8

getRootUINode

protected UINode getRootUINode(BajaContext context,
                               RenderingContext rContext,
                               Page page)

Return the node that should be used to render the page.

createRenderingContext

protected RenderingContext createRenderingContext(BajaContext context,
                                                  java.io.PrintWriter out,
                                                  Page page)

Create the rendering context for the page.

Parameters:

context - the BajaContext

out - a PrintWriter; this will always be null, and is passed only for backwards compatibility

page - the Page being rendered

getPageDescription

protected UINodePageDescription getPageDescription()

Returns the PageDescription used for this renderer.

isEmbedded

protected boolean isEmbedded(BajaContext context,
                             Page page)

Returns whether the Renderer should behave as if it is rendering embedded content, or the content for an entire page. The default behavior checks AbstractPageBroker.isEmbedded(), but assumes true for developers not using a subclass of AbstractPageBroker.

See Also:

AbstractPageBroker.isEmbedded()