Package de.espirit.firstspirit.access.store.templatestore

Interface TemplateExtension

All Superinterfaces:

Comparable<StoreElement>, StoreElement, Workflowable

public interface TemplateExtension
extends StoreElement

This interface provides methods to handle TemplateExtensions for Page- and Section-Templates

Since:

3.0

Method Summary

Modifier and Type	Method	Description
boolean	getGenerateAnchor()	Indicates whether to generate an anchor tag when rendering.
String	getLinkExtension()	Get the link-extension of the TemplateExtension
TemplateSet	getTemplateSet()	Get the current TemplateSet for this TemplateExtension
boolean	isReplaceable()	Indicates whether the file-extension can be overwriten or not.
void	setGenerateAnchor(boolean anchor)	Defines whether to generate an anchor tag when rendering the related template.
void	setLinkExtension(String linkExtension)	Set the link-extension of the TemplateExtension
void	setReplaceable(boolean replaceable)	Set if the file-extension can be overwriten

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, getParent, getPermission, getPermission, getPermission, getPreviousSibling, getProject, getReferenceName, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml

Methods inherited from interface de.espirit.firstspirit.access.Workflowable

getColor, getTask, hasTask, removeTask, setColor, setTask

Method Details

getLinkExtension

String getLinkExtension()

Get the link-extension of the TemplateExtension

Returns:

link-extension (e.g. HTML, PDF)

Since:

3.0

setLinkExtension

void setLinkExtension(String linkExtension)

Set the link-extension of the TemplateExtension

Parameters:

linkExtension - Extension of the link (e.g. HTML, PDF)

Since:

3.0

isReplaceable

boolean isReplaceable()

Indicates whether the file-extension can be overwriten or not.

Returns:

trueif this extension is replaceable, false otherwise.

Since:

3.0

setReplaceable

void setReplaceable(boolean replaceable)

Set if the file-extension can be overwriten

Parameters:

replaceable - 0 if can be overwriten; 1 if can't be overwriten

Since:

3.0

getTemplateSet

TemplateSet getTemplateSet()

Get the current TemplateSet for this TemplateExtension

Returns:

TemplateSet as object

Since:

3.0

getGenerateAnchor

boolean getGenerateAnchor()

Indicates whether to generate an anchor tag when rendering.

Returns:

true, if to generate an anchor.

Since:

3.0

setGenerateAnchor

void setGenerateAnchor(boolean anchor)

Defines whether to generate an anchor tag when rendering the related template.

Parameters:

anchor - true, to generate an anchor.

Since:

3.0