Package de.espirit.firstspirit.access.editor

Interface ContentAreaListValue

All Superinterfaces:

EditorValue<SectionList>

@Deprecated
public interface ContentAreaListValue
extends EditorValue<SectionList>

Deprecated.

Since 5.0.107 - usages of CMS_INPUT_CONTENTAREALIST should be replaced with FS_CATALOG.

Tagging interface for an EditorValue representing the FirstSpirit input component CMS_INPUT_CONTENTAREALIST.

Since:

3.0.78

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENTAREA_LIST_KEY	Deprecated. Section container key.
static final String	SECTION_KEY	Deprecated. Section entry key.

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

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

Method Summary

Modifier and Type	Method	Description
@NotNull SectionList	get(Language language)	Deprecated. Get the value object in the specified language.
@NotNull Iterable<SectionTemplate>	getAllowedSectionTemplates()	Deprecated. Returns an unmodifiable iterable of allowed section templates which could be used to create new sections.
SectionTemplate[]	getAllowedTemplates()	Deprecated. since 4.2.200 - use getAllowedSectionTemplates() instead
String[]	getDisplayNames()	Deprecated. Provides the display names as array.
String[]	getDisplayValues(Section section)	Deprecated. Provides the display values for the given section as array.
GomContentAreaList	getForm()	Deprecated. Covariant return of concrete form container.

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

addEditorValueListener, assimilate, beSet, clear, clear, findReferences, getContentType, getDataValue, getEditorLanguages, getGuiXml, getMatches, getSearchableString, getTagName, getValueType, initialize, isDefault, isEmpty, isLanguageDependent, isSet, isSet, isValid, removeEditorValueListener, set, setTagName, setValueNode, toXml, toXml, validate

Field Details

CONTENTAREA_LIST_KEY

static final String CONTENTAREA_LIST_KEY

Deprecated.

Section container key.

Since:

4.0.17

See Also:

• Constant Field Values

SECTION_KEY

static final String SECTION_KEY

Deprecated.

Section entry key.

Since:

4.0.17

See Also:

• Constant Field Values

Method Details

getForm

GomContentAreaList getForm()

Deprecated.

Covariant return of concrete form container.

Specified by:

getForm in interface EditorValue<SectionList>

Returns:

The form definition.

Since:

4.0.17

getAllowedTemplates

@Deprecated
SectionTemplate[] getAllowedTemplates()

Deprecated.

since 4.2.200 - use getAllowedSectionTemplates() instead

Forwards to getAllowedSectionTemplates(), providing an array instead of a list.

Returns:

Array of section templates.

Since:

3.0.78

getAllowedSectionTemplates

@NotNull
@NotNull Iterable<SectionTemplate> getAllowedSectionTemplates()

Deprecated.

Returns an unmodifiable iterable of allowed section templates which could be used to create new sections.

Returns:

an unmodifiable iterable of allowed section templates for this editor

Since:

4.2.200

getDisplayNames

String[] getDisplayNames()

Deprecated.

Provides the display names as array.

Returns:

The display names.

Since:

3.0.78

getDisplayValues

String[] getDisplayValues(Section section)

Deprecated.

Provides the display values for the given section as array.

Parameters:

section - The section.

Returns:

The display values.

Since:

3.0.78

get

@NotNull
@NotNull SectionList get(Language language)

Deprecated.

Get the value object in the specified language. If the editor is not language dependent, the returned object always will be the same for any given language.

Specified by:

get in interface EditorValue<SectionList>

Parameters:

language - The language to look up.

Returns:

The language specific value object.

Since:

4.0.17