public final class

ApplyDecoratorDirective

extends Directive
java.lang.Object
   ↳ org.apache.velocity.runtime.directive.Directive
     ↳ com.atlassian.confluence.setup.velocity.ApplyDecoratorDirective

Class Overview

An ApplyDecorator directive for Sitemesh. Example use:

#applyDecorator("mydecorator" "inline title")
  The body goes here. #end

The title attribute is optional.

See Also

Summary

Nested Classes
class ApplyDecoratorDirective.DirectiveStack  
[Expand]
Inherited Constants
From interface org.apache.velocity.runtime.directive.DirectiveConstants
Fields
public static final String STACK_KEY
[Expand]
Inherited Fields
From class org.apache.velocity.runtime.directive.Directive
Public Constructors
ApplyDecoratorDirective()
Public Methods
void addParameter(String paramName, Object paramValue)
String getName()
Returns the name of the directive.
int getType()
Tells velocity that this is a block-type directive.
void init(RuntimeServices services, InternalContextAdapter adapter, Node node)
The directive is initialized.
boolean render(InternalContextAdapter adapter, Writer writer, Node node)
Does the actual decoration.
[Expand]
Inherited Methods
From class org.apache.velocity.runtime.directive.Directive
From class java.lang.Object

Fields

public static final String STACK_KEY

Public Constructors

public ApplyDecoratorDirective ()

Public Methods

public void addParameter (String paramName, Object paramValue)

public String getName ()

Returns the name of the directive.

Returns
  • name of the directive

public int getType ()

Tells velocity that this is a block-type directive.

Returns
  • directive type

public void init (RuntimeServices services, InternalContextAdapter adapter, Node node)

The directive is initialized.

Parameters
services Velocity runtime services.
adapter context.
node within the directive.

public boolean render (InternalContextAdapter adapter, Writer writer, Node node)

Does the actual decoration.

Parameters
adapter the context.
writer a writer instance to which to write the decorated text.
node the node within our block.
Throws
IOException
MethodInvocationException
ParseErrorException
ResourceNotFoundException