org.alfresco.wcm.client.directive

Class AbstractTemplateDirective

java.lang.Object

org.alfresco.wcm.client.directive.AbstractTemplateDirective

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

Direct Known Subclasses:

WebEditorEndTemplateDirective, WebEditorMarkContentDirective, WebEditorStartTemplateDirective

public abstract class AbstractTemplateDirective
extends Object
implements freemarker.template.TemplateDirectiveModel

Base class for all Web Editor directive implementations.

Author:

gavinc, Chris Lack

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID
protected String	urlPrefix

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor and Description
AbstractTemplateDirective()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	encode(String string) Encodes the given string, so that it can be used within an HTML page.
protected javax.servlet.http.HttpServletRequest	getRequest(freemarker.core.Environment env)
protected String	getToolbarLocation(freemarker.core.Environment env) Determins the location of the toolbar
protected String	getWebEditorUrlPrefix(freemarker.core.Environment env) Returns the URL prefix for the web editor application.
protected boolean	isDebugEnabled(freemarker.core.Environment env) Determines whether debug is enabled for the web editor application
protected boolean	isEditingEnabled(freemarker.core.Environment env) Determines whether editing is currently enabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface freemarker.template.TemplateDirectiveModel

execute

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

urlPrefix

protected String urlPrefix

Constructor Detail

AbstractTemplateDirective

public AbstractTemplateDirective()

Method Detail

getRequest

protected javax.servlet.http.HttpServletRequest getRequest(freemarker.core.Environment env)
                                                    throws freemarker.template.TemplateModelException

Throws:

freemarker.template.TemplateModelException

isEditingEnabled

protected boolean isEditingEnabled(freemarker.core.Environment env)
                            throws freemarker.template.TemplateModelException

Determines whether editing is currently enabled

Returns:

true if editing is enabled

Throws:

freemarker.template.TemplateModelException

getWebEditorUrlPrefix

protected String getWebEditorUrlPrefix(freemarker.core.Environment env)
                                throws freemarker.template.TemplateModelException

Returns the URL prefix for the web editor application.

Returns:

The WEF prefix URL

Throws:

freemarker.template.TemplateModelException

isDebugEnabled

protected boolean isDebugEnabled(freemarker.core.Environment env)
                          throws freemarker.template.TemplateModelException

Determines whether debug is enabled for the web editor application

This is the value of the debug init parameter of the Web Editor filter definition in web.xml. If the init parameter is not present false will be returned.

Returns:

true if debug is enabled

Throws:

freemarker.template.TemplateModelException

getToolbarLocation

protected String getToolbarLocation(freemarker.core.Environment env)
                             throws freemarker.template.TemplateModelException

Determins the location of the toolbar

Returns:

string location

Throws:

freemarker.template.TemplateModelException

encode

protected String encode(String string)

Encodes the given string, so that it can be used within an HTML page.

Parameters:

string - the String to convert