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

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent
              extended by org.alfresco.web.ui.repo.component.template.UITemplate
All Implemented Interfaces:
javax.faces.component.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.


Nested Class Summary
static class UITemplate.URLHelper
          URL Helper - to supply ${url.context} value for templates in JSF client
 
Constructor Summary
UITemplate()
           
 
Method Summary
 void encodeBegin(javax.faces.context.FacesContext context)
           
 java.lang.String getFamily()
           
 java.lang.Object getModel()
          Return the custom data model to bind template against.
 java.lang.String getTemplate()
           
 java.lang.String getTemplatePath()
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setModel(java.lang.Object model)
           
 void setTemplate(java.lang.String template)
           
 void setTemplatePath(java.lang.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 java.lang.String getFamily()
Specified by:
getFamily in class javax.faces.component.UIComponent
See Also:
UIComponent.getFamily()

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UIComponentBase
See Also:
StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UIComponentBase
See Also:
StateHolder.saveState(javax.faces.context.FacesContext)

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException
Overrides:
encodeBegin in class javax.faces.component.UIComponentBase
Throws:
java.io.IOException
See Also:
UIComponentBase.encodeBegin(javax.faces.context.FacesContext)

getModel

public java.lang.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(java.lang.Object model)
Parameters:
model - The model to set.

getTemplate

public java.lang.String getTemplate()
Returns:
Returns the template NodeRef/classpath.

setTemplate

public void setTemplate(java.lang.String template)
Parameters:
template - The template NodeRef/classpath to set.

getTemplatePath

public java.lang.String getTemplatePath()
Returns:
Returns the template path.

setTemplatePath

public void setTemplatePath(java.lang.String templatePath)
Parameters:
templatePath - The template cm:name based path to set.


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.