org.apache.tiles.velocity.template
Class InsertTemplateDirective

Package class diagram package InsertTemplateDirective
java.lang.Object
  extended by org.apache.velocity.runtime.directive.Directive
      extended by org.apache.tiles.velocity.template.InsertTemplateDirective
All Implemented Interfaces:
Cloneable, org.apache.velocity.runtime.directive.DirectiveConstants

public class InsertTemplateDirective
extends org.apache.velocity.runtime.directive.Directive

Insert a template.

Insert a template with the possibility to pass parameters (called attributes). A template can be seen as a procedure that can take parameters or attributes. <tiles:insertTemplate> allows to define these attributes and pass them to the inserted jsp page, called template. Attributes are defined using nested tag <tiles:putAttribute> or <tiles:putListAttribute>.

You must specify template attribute, for inserting a template

Example :

 <code>
           <tiles:insertTemplate template="/basic/myLayout.jsp" flush="true">
              <tiles:putAttribute name="title" value="My first page" />
              <tiles:putAttribute name="header" value="/common/header.jsp" />
              <tiles:putAttribute name="footer" value="/common/footer.jsp" />
              <tiles:putAttribute name="menu" value="/basic/menu.jsp" />
              <tiles:putAttribute name="body" value="/basic/helloBody.jsp" />
           </tiles:insertTemplate>
         </code>
 


Field Summary
 
Fields inherited from class org.apache.velocity.runtime.directive.Directive
rsvc
 
Fields inherited from interface org.apache.velocity.runtime.directive.DirectiveConstants
BLOCK, LINE
 
Constructor Summary
InsertTemplateDirective()
           
 
Method Summary
 String getName()
          
 int getType()
          
 boolean render(org.apache.velocity.context.InternalContextAdapter context, Writer writer, org.apache.velocity.runtime.parser.node.Node node)
          
 
Methods inherited from class org.apache.velocity.runtime.directive.Directive
getColumn, getLine, getTemplateName, init, setLocation, setLocation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InsertTemplateDirective

public InsertTemplateDirective()
Method Detail

getName

public String getName()

Specified by:
getName in class org.apache.velocity.runtime.directive.Directive

getType

public int getType()

Specified by:
getType in class org.apache.velocity.runtime.directive.Directive

render

public boolean render(org.apache.velocity.context.InternalContextAdapter context,
                      Writer writer,
                      org.apache.velocity.runtime.parser.node.Node node)
               throws IOException

Specified by:
render in class org.apache.velocity.runtime.directive.Directive
Throws:
IOException


Copyright © 2001-2012 Apache Software Foundation. All Rights Reserved.