public interface LinkTemplate extends Template, RulesetContainer
Since FirstSpirit 4.2 a link template is also a container for the form presented to the editor for this link
(GomSourceProvider
).
IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
Modifier and Type | Field and Description |
---|---|
static IDProvider.UidType |
UID_TYPE
Uid type as returned by
IDProvider.getUidType() . |
CONTENT_TEMPLATE, LINK_TEMPLATE, PAGE_TEMPLATE, SECTION_TEMPLATE
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
BLOCKED, MODIFIED, UNMODIFIED
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 . |
getComment, getType, setComment
getReferenceName
getDefaults, getFormDefaults, getGomSource, setDefaults, setFormDefaults, setGomProvider, setGomSource
getTemplateDocument
getChannelSource, setChannelSource
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
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
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
asRevisionProvider, getHistory, getHistory
getRulesetDefinition, setRulesetDefinition
addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState
getSubRootInStore
getPreviewImage, setPreviewImage
static final IDProvider.UidType UID_TYPE
IDProvider.getUidType()
.@NotNull @Deprecated String getName()
IDProvider.getUid()
getName
in interface StoreElement
@Deprecated String getEditorName()
Link.GENERIC_LINK
are considered legacy. - no replacementGomEditorProvider getGomProvider() throws ParsingError, GomValidationError
getGomProvider
in interface GomSourceProvider
ParsingError
- If the current template's XML failed to be parsed.GomValidationError
- If the current template is invalid.@Nullable String getTextEditorName()
setTextEditorName(String)
void setTextEditorName(@Nullable String value)
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.getTextEditorName()
@Nullable String getPictureEditorName()
setPictureEditorName(String)
void setPictureEditorName(@Nullable String value)
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.getPictureEditorName()
@Nullable String getExternalUrlEditorName()
categorized
.void setExternalUrlEditorName(@Nullable String value)
getExternalUrlEditorName()
String getReferenceCategory()
setReferenceCategory(String)
void setReferenceCategory(String value)
IllegalArgumentException
- If the provided category string is empty.getReferenceCategory()
,
setExternalUrlEditorName(String)
void setHidden(boolean hidden)
boolean isHidden()
Link createLink(Language language)
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>
.language
- void LinkEditorValue.set(Language, Link)
,
List<Link> LinkListEditorValue.get(Language)
Copyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500