org.springframework.extensions.surf.render

Class AbstractRenderer

java.lang.Object

org.springframework.extensions.surf.render.AbstractRenderer

All Implemented Interfaces:

Renderer

Direct Known Subclasses:

ChromeRenderer, ComponentRenderer, PageRenderer, RegionRenderer, TemplateInstanceRenderer

public abstract class AbstractRenderer
extends Object
implements Renderer

An abstract implementation of the Renderer interface that can be extended by application developers for quick implementation.

Author:

David Draper, muzquiano

Constructor Summary

Constructors

Constructor and Description
AbstractRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
void	all(RequestContext context, ModelObject object) Renders both the header and body focus by calling the header and body methods in succession.
abstract void	body(RequestContext context, ModelObject object) This method must be implemented by concrete subclasses to render the body focus for artifact being handled by the renderer.
RenderService	getRenderService() Gets the render service.
void	header(RequestContext context, ModelObject object) This method should be overridden by concrete subclasses to render the header focus for artifact being handled by the renderer.
protected void	print(javax.servlet.http.HttpServletResponse response, String str) Commits the given string to the response output stream
protected static void	print(RequestContext context, String str) Commits the given string to the response output stream
void	render(RequestContext context, ModelObject object, RenderFocus focus) This method directs rendering requests to the appropriate method for the RenderFocus provided.
void	setRenderService(RenderService renderService)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRenderer

public AbstractRenderer()

Method Detail

setRenderService

public void setRenderService(RenderService renderService)

getRenderService

public RenderService getRenderService()

Gets the render service.

Returns:

the render service

render

public void render(RequestContext context,
          ModelObject object,
          RenderFocus focus)
            throws RendererExecutionException

This method directs rendering requests to the appropriate method for the RenderFocus provided. It should only be overridden in exceptional circumstances as actual rendering should be carried out in the body and header methods.

Specified by:

render in interface Renderer

Parameters:

context - The current RequestContext that contains all the information required to perform rendering.

object - The current object to be rendered.

focus - The focus to be rendered.

Throws:

RendererExecutionException - If the concrete rendering subclass methods fail to render the request.

all

public void all(RequestContext context,
       ModelObject object)
         throws RendererExecutionException

Renders both the header and body focus by calling the header and body methods in succession. This method is invoked from the render method when a RenderFocus of "ALL" is provided.

Specified by:

all in interface Renderer

Parameters:

context - The current RequestContext that contains all the information required to perform rendering.

object - The current object to be rendered.

Throws:

RendererExecutionException - if thrown from the header or body methods.

header

public void header(RequestContext context,
          ModelObject object)
            throws RendererExecutionException

This method should be overridden by concrete subclasses to render the header focus for artifact being handled by the renderer.

Specified by:

header in interface Renderer

Parameters:

context - The current RequestContext that contains all the information required to perform rendering.

object - The current object to be rendered.

Throws:

RendererExecutionException - If rendering cannot be completed without error.

body

public abstract void body(RequestContext context,
        ModelObject object)
                   throws RendererExecutionException

This method must be implemented by concrete subclasses to render the body focus for artifact being handled by the renderer.

Specified by:

body in interface Renderer

Parameters:

context - The current RequestContext that contains all the information required to perform rendering.

object - The current object to be rendered.

Throws:

RendererExecutionException - If rendering cannot be completed without error.

print

protected void print(javax.servlet.http.HttpServletResponse response,
         String str)
              throws RendererExecutionException

Commits the given string to the response output stream

Parameters:

response - the response

str - the string

Throws:

RendererExecutionException

print

protected static void print(RequestContext context,
         String str)
                     throws RendererExecutionException

Commits the given string to the response output stream

Parameters:

context - the render context

str - the string

Throws:

RendererExecutionException