org.riotfamily.forms.element
Class TemplateElement

java.lang.Object
  org.riotfamily.forms.AbstractElement
      org.riotfamily.forms.AbstractEditorBase
          org.riotfamily.forms.CompositeElement
              org.riotfamily.forms.element.TemplateElement

All Implemented Interfaces:

Element, BeanFactoryAware

Direct Known Subclasses:

AbstractFileUpload.UploadElement, AbstractLocalizedElement, ElementGroup, FileUpload.PreviewElement, ListEditor, ListItem, MapEditor, MapEditor.MapItem, NestedForm, PasswordField

public class TemplateElement
extends CompositeElement

CompositeElement that is rendered using a template.

Field Summary

Fields inherited from class org.riotfamily.forms.AbstractElement

log

Constructor Summary

TemplateElement()

TemplateElement(String modelKey)

TemplateElement(String modelKey, String template)

Method Summary

protected void	addComponent(String key, Element element)
protected void	afterFormContextSet()
Object	getAttribute(String key)
Map<String,Object>	getRenderModel()
protected String	getTemplate() Returns the name of the template that is used to render the element.
protected void	renderInternal(PrintWriter writer)
protected void	renderTemplate(PrintWriter writer)
void	setAttribute(String key, Object value)
void	setTemplate(String name) Sets the name of the template that is used to render the element.

Methods inherited from class org.riotfamily.forms.CompositeElement

addComponent, afterFormSet, focus, getComponents, initComponent, initCompositeElement, isCompositeElement, isEmpty, processRequest, processRequestCompontents, processRequestInternal, removeComponent, setBeanFactory

Methods inherited from class org.riotfamily.forms.AbstractEditorBase

addChangeListener, afterBindingSet, fireChangeEvent, getEditorBinding, getFieldName, getHint, getLabel, getParamName, hasListeners, setEditorBinding, setFieldName, setParamName

Methods inherited from class org.riotfamily.forms.AbstractElement

getEventTriggerId, getForm, getFormContext, getFormListener, getId, getParent, getStyleClass, getSystemStyleClass, getWrapperStyleClass, isEnabled, isRequired, isVisible, render, render, setEnabled, setForm, setFormContext, setHint, setId, setInline, setLabel, setParent, setReadOnly, setRequired, setStyleClass, setVisible, setWrap

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateElement

public TemplateElement()

TemplateElement

public TemplateElement(String modelKey)

TemplateElement

public TemplateElement(String modelKey,
                       String template)

Method Detail

addComponent

protected void addComponent(String key,
                            Element element)

getRenderModel

public Map<String,Object> getRenderModel()

setAttribute

public void setAttribute(String key,
                         Object value)

getAttribute

public Object getAttribute(String key)

getTemplate

protected final String getTemplate()

Returns the name of the template that is used to render the element.

setTemplate

public final void setTemplate(String name)

Sets the name of the template that is used to render the element.

Parameters:

name - name of the template to use

See Also:

renderInternal(PrintWriter), TemplateRenderer

afterFormContextSet

protected void afterFormContextSet()

Overrides:

afterFormContextSet in class AbstractElement

renderInternal

protected void renderInternal(PrintWriter writer)

Overrides:

renderInternal in class CompositeElement

renderTemplate

protected void renderTemplate(PrintWriter writer)