Package com.atlassian.confluence.util.velocity

Interface ConfluenceVelocityTemplate

All Superinterfaces:

HtmlSafeVelocityTemplate

public interface ConfluenceVelocityTemplate
extends HtmlSafeVelocityTemplate

Exposes template details that are of interest to the Confluence Velocity template rendering subsystem.

Method Summary

Modifier and Type	Method	Description
String	getName()	Get the name of this template.
boolean	isAutoEncodeDisabled()	Determines whether the template has disabled auto encoding on its contents.
boolean	isDeclaredHtmlSafe()	Used by plugins to determine whether auto encoding should be enabled on its contents.
boolean	isPluginTemplate()

Method Details

getName

String getName()

Get the name of this template.

Returns:

The name of this template.

isAutoEncodeDisabled

boolean isAutoEncodeDisabled()

Determines whether the template has disabled auto encoding on its contents. This is achieved by including the DisableAntiXssDirective Returns false if no directive is found.

Specified by:

isAutoEncodeDisabled in interface HtmlSafeVelocityTemplate

Returns:

true if this template has disabled auto encoding on its contents

isDeclaredHtmlSafe

boolean isDeclaredHtmlSafe()

Used by plugins to determine whether auto encoding should be enabled on its contents. This is achieved by including the HtmlSafeDirective Returns false if no directive is found.

Specified by:

isDeclaredHtmlSafe in interface HtmlSafeVelocityTemplate

Returns:

true if the template should have auto encoding enabled

isPluginTemplate

boolean isPluginTemplate()

Returns:

true if this template was loaded from a dynamic plugin.