Package com.atlassian.confluence.setup.velocity

Class ApplyDecoratorDirective

java.lang.Object
org.apache.velocity.runtime.directive.Directive
com.atlassian.confluence.setup.velocity.ApplyDecoratorDirective
All Implemented Interfaces:
Cloneable, org.apache.velocity.runtime.directive.DirectiveConstants
@Deprecated(forRemoval=true) public final class ApplyDecoratorDirective extends org.apache.velocity.runtime.directive.Directive
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1 replaced by ApplyDecoratorDirective
An ApplyDecorator directive for Sitemesh.

Example use:

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

The title attribute is optional.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    ApplyDecoratorDirective.DirectiveStack
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • 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

    Constructors
    Constructor
    Description
    ApplyDecoratorDirective()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addParameter(String paramName, Object paramValue)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the name of the directive.
    int
    getType()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Tells velocity that this is a block-type directive.
    void
    init(org.apache.velocity.runtime.RuntimeServices services, org.apache.velocity.context.InternalContextAdapter adapter, org.apache.velocity.runtime.parser.node.Node node)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The directive is initialized.
    boolean
    render(org.apache.velocity.context.InternalContextAdapter adapter, Writer writer, org.apache.velocity.runtime.parser.node.Node node)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Does the actual decoration.

    Methods inherited from class org.apache.velocity.runtime.directive.Directive

    getColumn, getLine, getTemplateName, setLocation, setLocation

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ApplyDecoratorDirective

      public ApplyDecoratorDirective()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getName

      public String getName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the name of the directive.
      Specified by:
      getName in class org.apache.velocity.runtime.directive.Directive
      Returns:
      name of the directive

    • getType

      public int getType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Tells velocity that this is a block-type directive.
      Specified by:
      getType in class org.apache.velocity.runtime.directive.Directive
      Returns:
      directive type

    • init

      public void init(org.apache.velocity.runtime.RuntimeServices services, org.apache.velocity.context.InternalContextAdapter adapter, org.apache.velocity.runtime.parser.node.Node node)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The directive is initialized.
      Overrides:
      init in class org.apache.velocity.runtime.directive.Directive
      Parameters:
      services - Velocity runtime services.
      adapter - context.
      node - within the directive.

    • render

      public boolean render(org.apache.velocity.context.InternalContextAdapter adapter, Writer writer, org.apache.velocity.runtime.parser.node.Node node) throws IOException, org.apache.velocity.exception.ResourceNotFoundException, org.apache.velocity.exception.ParseErrorException, org.apache.velocity.exception.MethodInvocationException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Does the actual decoration.
      Specified by:
      render in class org.apache.velocity.runtime.directive.Directive
      Parameters:
      adapter - the context.
      writer - a writer instance to which to write the decorated text.
      node - the node within our block.
      Throws:
      IOException
      org.apache.velocity.exception.ResourceNotFoundException
      org.apache.velocity.exception.ParseErrorException
      org.apache.velocity.exception.MethodInvocationException

    • addParameter

      public void addParameter(String paramName, Object paramValue)
      Deprecated, for removal: This API element is subject to removal in a future version.