Description

Renders an custom UI widget using the specified templates. Additional objects can be passed in to the template using the param tags.

Freemarker:

Objects provided can be retrieve from within the template via $parameters.paramname.

Jsp:

Objects provided can be retrieve from within the template via <ww:property value="%{parameters.paramname}" />

In the bottom JSP and Velocity samples, two parameters are being passed in to the component. From within the component, they can be accessed as:-

Freemarker:

$parameters.get('key1') and $parameters.get('key2') or $parameters.key1 and $parameters.key2

Jsp:

<ww:property value="%{parameters.key1}" /> and <ww:property value="%{'parameters.key2'}" /> or <ww:property value="%{parameters.get('key1')}" /> and <ww:property value="%{parameters.get('key2')}" />

Currently, your custom UI components can be written in Velocity, JSP, or Freemarker, and the correct rendering engine will be found based on file extension.

Remember: the value params will always be resolved against the OgnlValueStack so if you mean to pass a string literal to your component, make sure to wrap it in quotes i.e. value="'value1'" otherwise, the the value stack will search for an Object on the stack with a method of getValue1(). (now that i've written this, i'm not entirely sure this is the case. i should verify this manana)

If Jsp is used as the template, the jsp template itself must lie within the webapp itself and not the classpath. Unlike Freemarker or Velocity, JSP template could not be picked up from the classpath.

Parameters

Name	Required	Default	Type	Description
theme	false		Object/String	The theme (other than default) to use for rendering the element
templateDir	false		Object/String	The template directory (other than default) to used to find the themes and hence the template.
template	false		Object/String	The template (other than default) to use for rendering the element
cssClass	false		Object/String	The css class to use for element
cssStyle	false		Object/String	The css style definitions for element ro use
title	false		Object/String	Set the html title attribute on rendered html element
disabled	false		Object/String	Set the html disabled attribute on rendered html element
label	false		Object/String	Label expression used for rendering a element specific label
labelPosition	false	left	Object/String	deprecated.
labelposition	false		Object/String	define label position of form element (top/left)
requiredposition	false		Object/String	define required position of required form element (left|right)
name	false		Object/String	The name to set for element
required	false	false	Boolean	If set to true, the rendered element will indicate that input is required
tabindex	false		Object/String	Set the html tabindex attribute on rendered html element
value	false		Object/String	Preset the value of input element.
onclick	false		Object/String	Set the html onclick attribute on rendered html element
ondblclick	false		Object/String	Set the html ondblclick attribute on rendered html element
onmousedown	false		Object/String	Set the html onmousedown attribute on rendered html element
onmouseup	false		Object/String	Set the html onmouseup attribute on rendered html element
onmouseover	false		Object/String	Set the html onmouseover attribute on rendered html element
onmousemove	false		Object/String	Set the html onmousemove attribute on rendered html element
onmouseout	false		Object/String	Set the html onmouseout attribute on rendered html element
onfocus	false		Object/String	Set the html onfocus attribute on rendered html element
onblur	false		Object/String	Set the html onblur attribute on rendered html element
onkeypress	false		Object/String	Set the html onkeypress attribute on rendered html element
onkeydown	false		Object/String	Set the html onkeydown attribute on rendered html element
onkeyup	false		Object/String	Set the html onkeyup attribute on rendered html element
onselect	false		Object/String	Set the html onselect attribute on rendered html element
onchange	false		Object/String	Set the html onchange attribute on rendered html element
accesskey	false		Object/String	Set the html accesskey attribute on rendered html ekement
tooltip	false		String	Set the tooltip of this particular component
tooltipConfig	false		String	Set the tooltip configuration
id	false		Object/String	id for referencing element. For UI and form tags it will be used as HTML id attribute

Examples

JSP
    <ww:component template="/my/custom/component.vm"/>
    
      or

    <ww:component template="/my/custom/component.vm">
      <ww:param name="key1" value="value1"/>
      <ww:param name="key2" value="value2"/>
    </ww:component>

Velocity
    #wwcomponent( "template=/my/custom/component.vm" )

      or

    #wwcomponent( "template=/my/custom/component.vm" )
      #wwparam( "name=key1" "value=value1" )
      #wwparam( "name=key2" "value=value2" )
    #end
    
Freemarker
   <@ww.component template="/my/custom/component.ftl" />
   
     or
     
   <@ww.component template="/my/custom/component.ftl">
      <@ww.param name="key1" value="%{'value1'}" />
      <@ww.param name="key2" value="%{'value2'}" />
   </@ww.component>