de.espirit.firstspirit.access.editor
Interface DomTableEditorValue

All Superinterfaces:

EditorValue<Table>

public interface DomTableEditorValue
extends EditorValue<Table>

The DomTableEditorValue interface represents the FirstSpirit input component CMS_INPUT_DOMTABLE

Since:

2.3.17

Example:

How to get and store value

Field Summary

static String

TABLE_KEY

Fields inherited from interface de.espirit.firstspirit.access.editor.EditorValue

COPY_PRESET, DEFAULT, DELETE, FALLBACK_LANGUAGE, LANG_KEY, SOLE_LANGUAGE, UNSUPPORTED

Method Summary

void	addColumn(Language language, int afterColumn)
void	addRow(Language language, int afterRow)
void	deleteColumn(Language language, int column)
void	deleteRow(Language language, int row)
List	getAllowedLinks() Deprecated. since 4.0.17 - use getForm().getLinkEditors()
List<LinkTemplate>	getAllowedLinkTemplates() Get a list of allowed link types.
TableCell	getCell(Language language, int row, int column) Gets the cell of this dom table with the given row & col index or null if no cell exists with these indices.
int	getColumns(Language language)
GomDomTable	getForm() Get the form definition.
de.espirit.firstspirit.access.link.LinkConfig[]	getLinkConfig() Deprecated. since 4.0.17 - use GomDomTable
de.espirit.firstspirit.access.link.LinkConfig	getLinkConfig(String name) Deprecated. since 4.0.17 - use GomDomTable
Map	getListDefaultConfig() Deprecated. since 4.0.17 - use GomDomTable
int	getRows(Language language)
Section	getSection(Language language, int row, int column) Get a cell defined by language, row, and column as Section object.

Methods inherited from interface de.espirit.firstspirit.access.editor.EditorValue

addEditorValueListener, assimilate, beSet, clear, clear, findReferences, get, getContentType, getDataValue, getEditorLanguages, getGuiClassName, getGuiXml, getMatches, getReferences, getSearchableString, getTagName, getValue, getValue, getValueType, init, initialize, isDefault, isEmpty, isLanguageDependant, isLanguageDependent, isSet, isSet, isValid, removeEditorValueListener, set, setTagName, setValue, setValue, setValueNode, toXml, toXml, validate

Field Detail

TABLE_KEY

static final String TABLE_KEY

Since:

4.0.17

See Also:

Constant Field Values

Method Detail

getRows

int getRows(Language language)

Since:

3.0.95

getColumns

int getColumns(Language language)

Since:

3.0.95

addRow

void addRow(Language language,
            int afterRow)

Since:

3.0.95

deleteRow

void deleteRow(Language language,
               int row)

Since:

3.0.95

addColumn

void addColumn(Language language,
               int afterColumn)

Since:

3.0.95

deleteColumn

void deleteColumn(Language language,
                  int column)

Since:

3.0.95

getCell

@Nullable
TableCell getCell(Language language,
                           int row,
                           int column)

Gets the cell of this dom table with the given row & col index or null if no cell exists with these indices.

Parameters:

language - the language to get the cell value for

row - the row index

column - the col index

Returns:

TableCell or null if no cell exists for given indices

Since:

4.0.17

getLinkConfig

@Deprecated
de.espirit.firstspirit.access.link.LinkConfig[] getLinkConfig()

Deprecated. since 4.0.17 - use GomDomTable

Since:

3.1.324

getLinkConfig

@Deprecated
de.espirit.firstspirit.access.link.LinkConfig getLinkConfig(String name)

Deprecated. since 4.0.17 - use GomDomTable

Since:

3.1.324

getAllowedLinks

@Deprecated
List getAllowedLinks()

Deprecated. since 4.0.17 - use getForm().getLinkEditors()

Since:

3.1.324

getListDefaultConfig

@Deprecated
Map getListDefaultConfig()

Deprecated. since 4.0.17 - use GomDomTable

Since:

3.1.324

getForm

GomDomTable getForm()

Description copied from interface: EditorValue

Get the form definition.

Specified by:

getForm in interface EditorValue<Table>

Returns:

The form definition.

Since:

4.0.17

getSection

Section getSection(Language language,
                   int row,
                   int column)

Get a cell defined by language, row, and column as Section object.

Parameters:

language - The language to look up.

row - The row of the cell.

column - The column of the cell.

Returns:

The matching section or null.

Since:

4.0.17

getAllowedLinkTemplates

@NotNull
List<LinkTemplate> getAllowedLinkTemplates()

Get a list of allowed link types.

Returns:

The list of allowed link types.

Since:

4.2.8