org.springframework.extensions.surf.site

Class EmptyRegionRenderer

java.lang.Object

org.springframework.extensions.surf.render.AbstractProcessor

org.springframework.extensions.surf.site.EmptyRegionRenderer

All Implemented Interfaces:

Processor

public class EmptyRegionRenderer
extends AbstractProcessor

Processor class which renders a null result. Used to render vacant "empty" regions when there are no bound components. A common use case for application that are not "design focused".

Author:

Kevin Roast

Field Summary

Fields inherited from class org.springframework.extensions.surf.render.AbstractProcessor

processorModelHelper

Constructor Summary

Constructors

Constructor and Description
EmptyRegionRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
void	executeBody(ProcessorContext pc, ModelObject object) Executes the "body" of the processor output using the given processor context.
void	executeHeader(ProcessorContext pc, ModelObject object) Executes the "header" of the processor output using the given processor context.
boolean	exists(ProcessorContext pc, ModelObject object) Indicates whether the engine responsible for processing the body of the processor exists.

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

execute, getProperty, getRenderingDescriptor, setProcessorModelHelper

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyRegionRenderer

public EmptyRegionRenderer()

Method Detail

executeHeader

public void executeHeader(ProcessorContext pc,
                 ModelObject object)
                   throws RendererExecutionException

Description copied from interface: Processor

Executes the "header" of the processor output using the given processor context.

Specified by:

executeHeader in interface Processor

Overrides:

executeHeader in class AbstractProcessor

Parameters:

pc - processorContext

Throws:

RendererExecutionException

executeBody

public void executeBody(ProcessorContext pc,
               ModelObject object)
                 throws RendererExecutionException

Description copied from interface: Processor

Executes the "body" of the processor output using the given processor context.

Specified by:

executeBody in interface Processor

Specified by:

executeBody in class AbstractProcessor

Parameters:

pc - processorContext

Throws:

RendererExecutionException

exists

public boolean exists(ProcessorContext pc,
             ModelObject object)

Description copied from interface: Processor

Indicates whether the engine responsible for processing the body of the processor exists.

Parameters:

pc - ProcessorContext

object - ModelObject

Returns:

boolean