org.alfresco.web.ui.repo.component.template

Class UITemplate

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent

org.alfresco.web.ui.repo.component.template.UITemplate

All Implemented Interfaces:

StateHolder

public class UITemplate
extends org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent

Component responsible for rendering the output of a FreeMarker template directly to the page.

FreeMarker templates can be specified as a NodeRef or classpath location. The template output will be processed against the default model merged with any custom model reference supplied to the component as a value binding attribute. The output of the template is the output of the component tag.

Author:

Kevin Roast

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UITemplate.URLHelper URL Helper - to supply ${url.context} value for templates in JSF client

Constructor Summary

Constructors

Constructor and Description
UITemplate()

Method Summary

Modifier and Type	Method and Description
void	encodeBegin(FacesContext context)
String	getFamily()
Object	getModel() Return the custom data model to bind template against.
String	getTemplate()
String	getTemplatePath()
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setModel(Object model)
void	setTemplate(String template)
void	setTemplatePath(String templatePath)

Methods inherited from class org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent

outputAttribute

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Constructor Detail

UITemplate

public UITemplate()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

See Also:

UIComponent.getFamily()

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIComponentBase

See Also:

StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIComponentBase

See Also:

StateHolder.saveState(javax.faces.context.FacesContext)

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

See Also:

UIComponentBase.encodeBegin(javax.faces.context.FacesContext)

getModel

public Object getModel()

Return the custom data model to bind template against. Not cached.

Returns:

Returns the custom data model to bind template against.

setModel

public void setModel(Object model)

Parameters:

model - The model to set.

getTemplate

public String getTemplate()

Returns:

Returns the template NodeRef/classpath.

setTemplate

public void setTemplate(String template)

Parameters:

template - The template NodeRef/classpath to set.

getTemplatePath

public String getTemplatePath()

Returns:

Returns the template path.

setTemplatePath

public void setTemplatePath(String templatePath)

Parameters:

templatePath - The template cm:name based path to set.