public interface FormatTemplate extends IDProvider, TemplateContentProvider, PackagePoolItem, TemplateStoreElement
IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
Modifier and Type | Field and Description |
---|---|
static IDProvider.UidType |
UID_TYPE
The template's uid type.
|
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
BLOCKED, MODIFIED, UNMODIFIED
Modifier and Type | Method and Description |
---|---|
FormatTemplateChannel |
getChannel(TemplateSet templateSet)
Provides the channel specifica with respect to the given template set.
|
String |
getFormatTag()
Provides this format's tag.
|
Map<String,String> |
getStyleAttributes()
Provides the map of style attributes.
|
Style |
getStyleNode()
Get the StyleNode (properties-node) of the FormatTemplate as StoreElement
|
String |
getView()
Provides the view mode for this format.
|
boolean |
isCdata()
Indicates the format to represent CDATA.
|
boolean |
isQuote()
Indicates whether to quote the format.
|
boolean |
isSystem()
Indicates this to be a system format.
|
boolean |
isVisible()
Indicates whether the format will be visible.
|
void |
setCdata(boolean value)
Defines the format to represent CDATA.
|
void |
setFormatTag(String tag)
Defines this format's tag.
|
void |
setQuote(boolean value)
Defines whether to quote the format.
|
void |
setStyleAttributes(Map<String,String> attributes)
Defines the style attributes.
|
void |
setSystem(boolean system)
Defines this to be a system format.
|
void |
setUid(String value)
The uid of format templates is used as tag name in dom and dom-table instances.
|
void |
setView(String view)
Sets the view mode for this format.
|
void |
setVisible(boolean visible)
Defines whether the format shall be visible.
|
getTemplateDocument
getChannelSource, setChannelSource
contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, setDisplayName, setMeta, setMetaFormData
appendChild, appendChildBefore, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, 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
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
asRevisionProvider, getHistory, getHistory
addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState
getSubRootInStore
static final IDProvider.UidType UID_TYPE
Style getStyleNode()
boolean isSystem()
true
, if it is a system format.void setSystem(boolean system)
system
- true
, for a system format.String getFormatTag()
void setFormatTag(String tag)
tag
- The format's tag.String getView()
void setView(String view)
view
- The view mode.boolean isQuote()
true
, if to be quoted.void setQuote(boolean value)
value
- true
, if to quote.boolean isCdata()
true
, if it is CDATAvoid setCdata(boolean value)
value
- true
, if it is CDATA.boolean isVisible()
true
, if visible.void setVisible(boolean visible)
visible
- true
, for visibility.Map<String,String> getStyleAttributes()
void setStyleAttributes(Map<String,String> attributes)
attributes
- The style attributes.FormatTemplateChannel getChannel(@NotNull TemplateSet templateSet)
templateSet
- The template set.ChannelSourceProvider.getChannelSource(de.espirit.firstspirit.access.project.TemplateSet)
,
ChannelSourceProvider.setChannelSource(de.espirit.firstspirit.access.project.TemplateSet, String)
void setUid(@NotNull String value)
uid
should contain only lower case characters.tag
of the
style node
.setUid
in interface IDProvider
value
- new unique identifier; should contain only lower case characters - internally this value is
transformed to lower caseIDProvider.getUid()
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210