freemarker.template
Interface TemplateDirectiveModel
- TemplateModel
public interface TemplateDirectiveModel
Objects that implement this interface can be used as user-defined directives
(much like macros). They can do arbitrary actions, write arbitrary
text to the template output, and trigger rendering of their nested content
any number of times.
execute
public void execute(Environment env,
Map params,
TemplateModel[] loopVars,
TemplateDirectiveBody body)
throws TemplateException,
IOException
Executes this user-defined directive; called by FreeMarker when the user-defined
directive is called in the template.
env
- the current processing environment. Note that you can access
the output Writer
by Environment.getOut()
.params
- the parameters (if any) passed to the directive as a
map of key/value pairs where the keys are String
-s and the values are
TemplateModel
instances. This is never null
.loopVars
- an array that corresponds to the "loop variables", in
the order as they appear in the directive call. ("Loop variables" are out-parameters
that are available to the nested body of the directive; see in the Manual.)
You set the loop variables by writing this array. The length of the array gives the
number of loop-variables that the caller has specified.
Never null
, but can be a zero-length array.body
- an object that can be used to render the nested content (body) of
the directive call. If the directive call has no nested content (i.e., it is like
[@myDirective /] or [@myDirective][/@myDirective]), then this will be
null
.