de.espirit.firstspirit.access.store.templatestore

Interface LinkTemplate

All Superinterfaces:

ChannelSourceProvider, Comparable<StoreElement>, GomSourceProvider, HistoryProvider, IDProvider, PackagePoolItem, PreviewImageProvider, Referenceable, RulesetContainer, StoreElement, Template, TemplateContentProvider, TemplateStoreElement, Workflowable

public interface LinkTemplate
extends Template, RulesetContainer

A link template is a container for the rendering template for links.

Since FirstSpirit 4.2 a link template is also a container for the form presented to the editor for this link (GomSourceProvider).

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.IDProvider

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Nested classes/interfaces inherited from interface de.espirit.firstspirit.storage.HistoryProvider

HistoryProvider.RevisionProvider

Field Summary

Fields

Modifier and Type	Field and Description
static IDProvider.UidType	UID_TYPE Uid type as returned by IDProvider.getUidType().

Fields inherited from interface de.espirit.firstspirit.access.store.templatestore.Template

CONTENT_TEMPLATE, LINK_TEMPLATE, PAGE_TEMPLATE, SECTION_TEMPLATE

Fields inherited from interface de.espirit.firstspirit.access.store.IDProvider

CHANGED, NEVER_RELEASED, RELEASED

Fields inherited from interface de.espirit.firstspirit.storage.HistoryProvider

ALL_REVISIONS, EVER_SINCE, UNTIL_NOW

Fields inherited from interface de.espirit.firstspirit.access.store.PackagePoolItem

BLOCKED, MODIFIED, UNMODIFIED

Method Summary

Methods

Modifier and Type	Method and Description
Link	createLink(Language language) Create a new link instance for this template.
String	getEditorName() Deprecated. since 4.2.24 - Since 4.2 this is retained for backward compatibility, all instances which provide a different value than Link.GENERIC_LINK are considered legacy. - no replacement
String	getExternalUrlEditorName() The name of the editor which will contain the textual representation of an external "url".
GomEditorProvider	getGomProvider() Get this template's GOM provider containing the hierarchical definition of the templates GUI including structure and input elements.
String	getName() Deprecated. since 4.1.10 - use IDProvider.getUid()
String	getPictureEditorName()
String	getReferenceCategory() Default value is "url".
String	getTextEditorName()
boolean	isHidden() State if the template is hidden in the selection-list.
void	setExternalUrlEditorName(String value)
void	setHidden(boolean hidden) Set if the template should be hidden.
void	setPictureEditorName(String value) Set the variable name from the form which is used to get an image to display from link instances created with this template.
void	setReferenceCategory(String value) Set the reference category which is used to categorize "external" links.
void	setTextEditorName(String value) Set the variable name from the form which is used to get the display text from link instances created with this template.

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.Template

getComment, getType, setComment

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

getReferenceName

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.GomSourceProvider

getDefaults, getFormDefaults, getGomSource, setDefaults, setFormDefaults, setGomProvider, setGomSource

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.TemplateContentProvider

getTemplateDocument

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.ChannelSourceProvider

getChannelSource, setChannelSource

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

contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, setMeta, setMetaFormData, setUid

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, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getProject, 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, update

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

getColor, getTask, hasTask, removeTask, setColor, setTask

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.storage.HistoryProvider

asRevisionProvider, getHistory, getHistory

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.RulesetContainer

getRulesetDefinition, setRulesetDefinition

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

addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.TemplateStoreElement

getSubRootInStore

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.PreviewImageProvider

getPreviewImage, setPreviewImage

Field Detail

UID_TYPE

static final IDProvider.UidType UID_TYPE

Uid type as returned by IDProvider.getUidType().

Since:

4.2

Method Detail

getName

@NotNull
@Deprecated
String getName()

Deprecated. since 4.1.10 - use IDProvider.getUid()

Specified by:

getName in interface StoreElement

Since:

3.0

getEditorName

@Deprecated
String getEditorName()

Deprecated. since 4.2.24 - Since 4.2 this is retained for backward compatibility, all instances which provide a different value than Link.GENERIC_LINK are considered legacy. - no replacement

Get the LinkEditor-name of the current LinkTemplate (e.g. internalLink, externalLink, contentLink, relatedprojectLink)

Returns:

LinkEditor-name (e.g. internalLink, externalLink, contentLink, relatedprojectLink)

Since:

3.0

getGomProvider

GomEditorProvider getGomProvider()
                                 throws ParsingError,
                                        GomValidationError

Get this template's GOM provider containing the hierarchical definition of the templates GUI including structure and input elements.

Specified by:

getGomProvider in interface GomSourceProvider

Returns:

The GuiXML provider.

Throws:

ParsingError - If the current template's XML failed to be parsed.

GomValidationError - If the current template is invalid.

Since:

4.2

getTextEditorName

@Nullable
String getTextEditorName()

Since:

4.2

See Also:

setTextEditorName(String)

setTextEditorName

void setTextEditorName(@Nullable
                     String value)

Set the variable name from the form which is used to get the display text from link instances created with this template. This is used in input components like CMS_INPUT_LINK, CMS_INPUT_DOMEDITOR and others to give the user a visual feedback of the link content.

Since:

4.2

See Also:

getTextEditorName()

getPictureEditorName

@Nullable
String getPictureEditorName()

Since:

4.2

See Also:

setPictureEditorName(String)

setPictureEditorName

void setPictureEditorName(@Nullable
                        String value)

Set the variable name from the form which is used to get an image to display from link instances created with this template. This is used in input components like CMS_INPUT_LINK, CMS_INPUT_DOMEDITOR and others to give the user a visual feedback of the link content.

Since:

4.2

See Also:

getPictureEditorName()

getExternalUrlEditorName

@Nullable
String getExternalUrlEditorName()

The name of the editor which will contain the textual representation of an external "url". This is used to track external references in the reference graph. External references could be categorized.

Since:

4.2

setExternalUrlEditorName

void setExternalUrlEditorName(@Nullable
                            String value)

Since:

4.2

See Also:

getExternalUrlEditorName()

getReferenceCategory

String getReferenceCategory()

Default value is "url".

Since:

4.2

See Also:

setReferenceCategory(String)

setReferenceCategory

void setReferenceCategory(String value)

Set the reference category which is used to categorize "external" links. Changing this value will not change existing external references to the provided category and will only affect new or changed links based on this template.

Throws:

IllegalArgumentException - If the provided category string is empty.

Since:

4.2

See Also:

getReferenceCategory(), setExternalUrlEditorName(String)

setHidden

void setHidden(boolean hidden)

Set if the template should be hidden.

Specified by:

setHidden in interface Template

Since:

4.2

isHidden

boolean isHidden()

State if the template is hidden in the selection-list.

Specified by:

isHidden in interface Template

Since:

4.2

createLink

Link createLink(Language language)

Create a new link instance for this template. Only the default values are set. The template of the link points to this link template.

The instance can be used to put it into an editor value instance of type Link or List<Link>.

Parameters:

language -

Returns:

a new link instance

Since:

4.2

See Also:

void LinkEditorValue.set(Language, Link), List<Link> LinkListEditorValue.get(Language)