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

Interface StyleTemplateLink

All Superinterfaces:

Comparable<StoreElement>, StoreElement, Workflowable

public interface StyleTemplateLink
extends StoreElement

Definition for defining a link to a style template from a rendering component.

Since:

4.0.120

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	StyleTemplateLink.Region	The region targeted by this link.

Method Summary

Modifier and Type	Method	Description
int	getColumn()	Returns the number of the column this rule should be used for. For regions different to Region.CUSTOM -1 will be returned.
@NotNull StyleTemplateLink.Region	getColumnRegion()	Returns the column region set for this rule.
int	getRow()	Returns the number of the row this rule should be used for. For regions different to Region.CUSTOM -1 will be returned.
@NotNull StyleTemplateLink.Region	getRowRegion()	Returns the row region set for this rule.
@Nullable StyleTemplate	getTargetTemplate()	Returns the target template
boolean	isDeletable()	Returns true if the region defined in this link is deletable, false otherwise. Note: Can only be true for row and column rules.
boolean	isEditable()	Returns true if the region defined in this link is editable, false otherwise.
boolean	matches(int rowNumber, boolean lastRow, int columnNumber, boolean lastColumn)	Indicates whether the link is applicable for the given region.
void	setColumn(int columnNumber)	Provide the number of the column this rule should be used for. The column region is set to Region.NUMBER automatically.
void	setColumnRegion(@NotNull StyleTemplateLink.Region region)	Provide the column region to be used for this rule.
void	setDeletable(boolean value)	Provide true if the region defined in this link should be deletable, false otherwise. Note: This setting takes effect for row and column rules only.
void	setEditable(boolean value)	Provide true if the region defined in this link should be editable, false otherwise.
void	setRow(int rowNumber)	Provide the number of the row this rule should be used for. The row region is set to Region.NUMBER automatically.
void	setRowRegion(@NotNull StyleTemplateLink.Region region)	Provide the row region to be used for this rule.
void	setTargetTemplate(@NotNull StyleTemplate styleTemplate)	Provide the StyleTemplate to be linked to.

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, 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

getTargetTemplate

@Nullable
@Nullable StyleTemplate getTargetTemplate()

Returns the target template

Since:

4.0.120

setTargetTemplate

void setTargetTemplate(@NotNull
 @NotNull StyleTemplate styleTemplate)

Provide the StyleTemplate to be linked to.

Since:

4.0.120

getRowRegion

@NotNull
@NotNull StyleTemplateLink.Region getRowRegion()

Returns the row region set for this rule.

Since:

4.0.120

setRowRegion

void setRowRegion(@NotNull
 @NotNull StyleTemplateLink.Region region)

Provide the row region to be used for this rule.

Since:

4.0.120

getRow

int getRow()

Returns the number of the row this rule should be used for.
For regions different to Region.CUSTOM -1 will be returned.

Since:

4.0.120

setRow

void setRow(int rowNumber)

Provide the number of the row this rule should be used for.
The row region is set to Region.NUMBER automatically.

Since:

4.0.120

getColumnRegion

@NotNull
@NotNull StyleTemplateLink.Region getColumnRegion()

Returns the column region set for this rule.

Since:

4.0.120

setColumnRegion

void setColumnRegion(@NotNull
 @NotNull StyleTemplateLink.Region region)

Provide the column region to be used for this rule.

Since:

4.0.120

getColumn

int getColumn()

Returns the number of the column this rule should be used for.
For regions different to Region.CUSTOM -1 will be returned.

Since:

4.0.120

setColumn

void setColumn(int columnNumber)

Provide the number of the column this rule should be used for.
The column region is set to Region.NUMBER automatically.

Since:

4.0.120

isEditable

boolean isEditable()

Returns true if the region defined in this link is editable, false otherwise.

Since:

4.1.10

setEditable

void setEditable(boolean value)

Provide true if the region defined in this link should be editable, false otherwise.

Since:

4.1.10

isDeletable

boolean isDeletable()

Returns true if the region defined in this link is deletable, false otherwise.
Note: Can only be true for row and column rules.

Since:

4.1.10

setDeletable

void setDeletable(boolean value)

Provide true if the region defined in this link should be deletable, false otherwise.
Note: This setting takes effect for row and column rules only.

Since:

4.1.10

matches

boolean matches(int rowNumber,
 boolean lastRow,
 int columnNumber,
 boolean lastColumn)

Indicates whether the link is applicable for the given region.

Parameters:

rowNumber - The row.

lastRow - The last row.

columnNumber - The column.

lastColumn - The last column.

Since:

4.0.120