BlockDirective

java.lang.Object
- Directive
- - org.apache.tiles.velocity.template.BlockDirective

Direct Known Subclasses:

AddListAttributeDirective, DefinitionDirective, GetAsStringDirective, InsertAttributeDirective, InsertDefinitionDirective, InsertTemplateDirective, PutListAttributeDirective
```
public abstract class BlockDirective
extends Directive
```
Base abstract directive for those models who need to evaluate, but not use, a body.

Since:

2.2.2

Version:

$Rev: 901355 $ $Date: 2010-01-20 20:58:12 +0100 (mer, 20 gen 2010) $

Constructor Summary

Constructors
Constructor and Description

BlockDirective()

Constructors
Constructor and Description
`BlockDirective()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected abstract void`	`end(InternalContextAdapter context, java.io.Writer writer, java.util.Map<java.lang.String,java.lang.Object> params, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)` Ends the directive, after evaluating the body.
`int`	`getType()`
`boolean`	`render(InternalContextAdapter context, java.io.Writer writer, Node node)`
`protected abstract void`	`start(InternalContextAdapter context, java.io.Writer writer, java.util.Map<java.lang.String,java.lang.Object> params, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)` Starts the directive, before evaluating the body.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- BlockDirective
```
public BlockDirective()
```

Method Detail

getType
```
public int getType()
```

render

public boolean render(InternalContextAdapter context,
             java.io.Writer writer,
             Node node)
               throws java.io.IOException

Throws:: java.io.IOException

start
```
protected abstract void start(InternalContextAdapter context,
         java.io.Writer writer,
         java.util.Map<java.lang.String,java.lang.Object> params,
         HttpServletRequest request,
         HttpServletResponse response,
         ServletContext servletContext)
```
Starts the directive, before evaluating the body.

Parameters:
context - The Velocity context.
writer - The writer user to write the result.
params - The parameters got from the first node of the directive.
request - The HTTP request.
response - The HTTP response.
servletContext - The servlet context.
Since:

2.2.2

end
```
protected abstract void end(InternalContextAdapter context,
       java.io.Writer writer,
       java.util.Map<java.lang.String,java.lang.Object> params,
       HttpServletRequest request,
       HttpServletResponse response,
       ServletContext servletContext)
                     throws java.io.IOException
```
Ends the directive, after evaluating the body.

Parameters:
context - The Velocity context.
writer - The writer user to write the result.
params - The parameters got from the first node of the directive.
request - The HTTP request.
response - The HTTP response.
servletContext - The servlet context.

Throws:

java.io.IOException - If something goes wrong when finishing this directive.
Since:

2.2.2

Class BlockDirective

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BlockDirective

Method Detail

getType

render

start

end