org.springframework.extensions.surf.render.bean

Class ChromeRenderer

java.lang.Object

org.springframework.extensions.surf.render.AbstractRenderer

org.springframework.extensions.surf.render.bean.ChromeRenderer

All Implemented Interfaces:

Renderer

public class ChromeRenderer
extends AbstractRenderer

Bean responsible for rendering chrome

Author:

David Draper, muzquiano

Constructor Summary

Constructors

Constructor and Description
ChromeRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	render(RequestContext context, ModelObject object, RenderFocus focus) Overrides the method provided by AbstractRenderer to set a RENDER_TYPE entry into the RequestContext where the value indicates whether Component or Region chrome is being rendered.

Methods inherited from class org.springframework.extensions.surf.render.AbstractRenderer

all, getRenderService, header, print, print, setRenderService

Methods inherited from class java.lang.Object

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

Constructor Detail

ChromeRenderer

public ChromeRenderer()

Method Detail

render

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

Overrides the method provided by AbstractRenderer to set a RENDER_TYPE entry into the RequestContext where the value indicates whether Component or Region chrome is being rendered. This is done so that the chrome implementation can use EITHER the <componentInclude> or <regionInclude> tag without error (previously using the wrong type of include in the chrome would result in either an infinite loop or an OutOfMemoryException).

After setting the RENDER_TYPE the AbstractRenderer implementation of the method is called to direct the rendering request appropriately.

Specified by:

render in interface Renderer

Overrides:

render in class AbstractRenderer

Parameters:

context - The current context (to which the RENDER_TYPE will be added)

focus - The current focus to render

object - The current object to be rendered.

Throws:

RendererExecutionException - if the CURRENT_RENDERER key has not been set. This key should have been set somewhere in the context ancestry (typically when a RegionRenderer or ComponentRenderer is invoked.

body

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

Description copied from class: AbstractRenderer

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

Specified by:

body in class AbstractRenderer

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.