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

Interface TableFormatTemplate

All Superinterfaces:

Comparable<StoreElement>, GomSourceProvider, HistoryProvider, IDProvider, PackagePoolItem, PreviewImageProvider, StoreElement, TemplateStoreElement, Workflowable

public interface TableFormatTemplate
extends IDProvider, PackagePoolItem, TemplateStoreElement, PreviewImageProvider, GomSourceProvider

Interface providing means to operate on table format templates.

Since:

4.0.120

Nested Class Summary

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

HistoryProvider.RevisionProvider

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

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Field Summary

Fields

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

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

ALL_REVISIONS, EVER_SINCE, UNTIL_NOW

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

CHANGED, NEVER_RELEASED, RELEASED

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

BLOCKED, MODIFIED, UNMODIFIED

Method Summary

Modifier and Type	Method	Description
StyleTemplateLink	addLink(@NotNull StyleTemplate template)	Provide a StyleTemplate which should be used for table cells defined in the returned StyleTemplateLink
@Nullable StyleTemplate	getDefaultStyleTemplate()	Returns the StyleTemplate used for any table cell if not explicitly overridden using a StyleTemplateLink.
int	getMaximumColumnCount()	Returns the maximum column count. Hint: In case of a value lower than minimum column count Integer.MAX_VALUE is returned.
int	getMaximumRowCount()	Returns the maximum row count. Hint: In case of a value lower than minimum row count Integer.MAX_VALUE is returned.
int	getMinimumColumnCount()	Returns the minimum column count.
int	getMinimumRowCount()	Returns the minimum row count.
@Nullable StyleTemplateLink	getStyleTemplate(int row, boolean lastRow, int column, boolean lastColumn)	Get the first matching style template link for a specific row and column.
void	setDefaultStyleTemplate(@Nullable StyleTemplate template)	Provide the StyleTemplate that should be used for any table cell which style isn't explicitly overriden using a StyleTemplateLink definition
void	setMaximumColumnCount(int value)	Set the maximum column count.
void	setMaximumRowCount(int value)	Set the maximum row count.
void	setMinimumColumnCount(int value)	Set the minimum column count.
void	setMinimumRowCount(int value)	Set the minimum row count.

Methods inherited from interface java.lang.Comparable

compareTo

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

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

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

asRevisionProvider, getHistory, getHistory

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

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

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.PreviewImageProvider

getPreviewImage, setPreviewImage

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, getPermission, getPermission, getPermission, getPreviousSibling, getProject, getReferenceName, getReferences, 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.store.templatestore.TemplateStoreElement

getSubRootInStore

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

getColor, getTask, hasTask, removeTask, setColor, setTask

Field Details

UID_TYPE

static final IDProvider.UidType UID_TYPE

Uid type as returned by IDProvider.getUidType().

Since:

4.0.120

Method Details

getDefaultStyleTemplate

@Nullable
@Nullable StyleTemplate getDefaultStyleTemplate()

Returns the StyleTemplate used for any table cell if not explicitly overridden using a StyleTemplateLink.

Since:

4.0.120

setDefaultStyleTemplate

void setDefaultStyleTemplate(@Nullable
 @Nullable StyleTemplate template)

Provide the StyleTemplate that should be used for any table cell which style isn't explicitly overriden using a StyleTemplateLink definition

Since:

4.0.120

addLink

StyleTemplateLink addLink(@NotNull
 @NotNull StyleTemplate template)

Provide a StyleTemplate which should be used for table cells defined in the returned StyleTemplateLink

Since:

4.0.120

getMinimumRowCount

int getMinimumRowCount()

Returns the minimum row count.

Since:

4.0.120

setMinimumRowCount

void setMinimumRowCount(int value)

Set the minimum row count.

Since:

4.0.120

getMinimumColumnCount

int getMinimumColumnCount()

Returns the minimum column count.

Since:

4.0.120

setMinimumColumnCount

void setMinimumColumnCount(int value)

Set the minimum column count.

Since:

4.0.120

getMaximumRowCount

int getMaximumRowCount()

Returns the maximum row count.
Hint: In case of a value lower than minimum row count Integer.MAX_VALUE is returned.

Since:

4.0.120

setMaximumRowCount

void setMaximumRowCount(int value)

Set the maximum row count.

Since:

4.0.120

getMaximumColumnCount

int getMaximumColumnCount()

Returns the maximum column count.
Hint: In case of a value lower than minimum column count Integer.MAX_VALUE is returned.

Since:

4.0.120

setMaximumColumnCount

void setMaximumColumnCount(int value)

Set the maximum column count.

Since:

4.0.120

getStyleTemplate

@Nullable
@Nullable StyleTemplateLink getStyleTemplate(int row,
 boolean lastRow,
 int column,
 boolean lastColumn)

Get the first matching style template link for a specific row and column. If there is no matching template the default template link is returned.

Parameters:

row - a row number, starting with 0

lastRow - provide true if the row is the last row

column - a column number, starting with 0, or -1 to get the row template

lastColumn - provide true if the column is the last column

Returns:

a matching style template link or the default template link

Since:

4.0.122