Java Doc for GenericUIBean.java in  » Web-Framework » struts-2.0.11 » org » apache » struts2 » components » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Freemarker:

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

Jsp:

Objects provided can be retrieve from within the template via <s: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:

<s:property value="%{parameters.key1}" /> and <s:property value="%{'parameters.key2'}" /> or <s:property value="%{parameters.get('key1')}" /> and <s: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 ValueStack 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)

Examples

 
 JSP
 <s:component template="/my/custom/component.vm"/>
 or
 <s:component template="/my/custom/component.vm">
 <s:param name="key1" value="value1"/>
 <s:param name="key2" value="value2"/>
 </s:component>
 Velocity
 #s-component( "template=/my/custom/component.vm" )
 or
 #s-component( "template=/my/custom/component.vm" )
 #s-param( "name=key1" "value=value1" )
 #s-param( "name=key2" "value=value2" )
 #end
 Freemarker
 <@s..component template="/my/custom/component.ftl" />
 or
 <@s..component template="/my/custom/component.ftl">
 <@s..param name="key1" value="%{'value1'}" />
 <@s..param name="key2" value="%{'value2'}" />
 </@s..component>
 
 

NOTE: 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.