|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent
org.alfresco.web.ui.repo.component.template.UITemplate
public class UITemplate
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 |
|---|
public UITemplate()
| Method Detail |
|---|
public java.lang.String getFamily()
getFamily in class javax.faces.component.UIComponentUIComponent.getFamily()
public void restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
restoreState in interface javax.faces.component.StateHolderrestoreState in class javax.faces.component.UIComponentBaseStateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState in interface javax.faces.component.StateHoldersaveState in class javax.faces.component.UIComponentBaseStateHolder.saveState(javax.faces.context.FacesContext)
public void encodeBegin(javax.faces.context.FacesContext context)
throws java.io.IOException
encodeBegin in class javax.faces.component.UIComponentBasejava.io.IOExceptionUIComponentBase.encodeBegin(javax.faces.context.FacesContext)public java.lang.Object getModel()
public void setModel(java.lang.Object model)
model - The model to set.public java.lang.String getTemplate()
public void setTemplate(java.lang.String template)
template - The template NodeRef/classpath to set.public java.lang.String getTemplatePath()
public void setTemplatePath(java.lang.String templatePath)
templatePath - The template cm:name based path to set.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||