de.espirit.firstspirit.access.editor
Interface LinkEditorValue

All Superinterfaces:

EditorValue<Link>

public interface LinkEditorValue
extends EditorValue<Link>

The LinkEditorValue interface represents the FirstSpirit input component CMS_INPUT_LINK

Since:

2.3.17

Example:

How to create and store a link

Field Summary

static String

LINK_KEY

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

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

Method Summary

List	getAllowedLinks() Deprecated. since 4.0.17 - Use LinkEditorValue.getAllowedLinkTemplates() instead.
List<LinkTemplate>	getAllowedLinkTemplates() Get a list of allowed link types.
GomLink	getForm() Covariant return of concrete form container.
de.espirit.firstspirit.access.link.LinkConfig[]	getLinkConfig() Deprecated. since 4.0.17 - Use LinkEditorValue.getAllowedLinkTemplates() instead.
de.espirit.firstspirit.access.link.LinkConfig	getLinkConfig(String name)
Link	getLinkValue() Deprecated. since 4.0.17 - use EditorValue.get(de.espirit.firstspirit.access.Language) instead
Link	getLinkValue(Language language) Deprecated. since 4.0.17 - use EditorValue.get(de.espirit.firstspirit.access.Language) instead
void	set(Language language, Link object) Set the value object for the specified language.
void	setDomLink(Language language, Element linkElement)
void	setLinkValue(Language language, Link value) Deprecated. since 4.0.17 - use LinkEditorValue.set(de.espirit.firstspirit.access.Language, de.espirit.firstspirit.access.link.Link) instead
void	setLinkValue(Link value) Deprecated. since 4.0.17 - use LinkEditorValue.set(de.espirit.firstspirit.access.Language, de.espirit.firstspirit.access.link.Link) instead

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, setTagName, setValue, setValue, setValueNode, toXml, toXml, validate

Field Detail

LINK_KEY

static final String LINK_KEY

Since:

4.0.17

See Also:

Constant Field Values

Method Detail

getForm

GomLink getForm()

Covariant return of concrete form container.

Specified by:

getForm in interface EditorValue<Link>

Returns:

The form definition.

Since:

4.0.17

getLinkValue

@Deprecated
Link getLinkValue()

Deprecated. since 4.0.17 - use EditorValue.get(de.espirit.firstspirit.access.Language) instead

Since:

2.3.20

setLinkValue

@Deprecated
void setLinkValue(Link value)

Deprecated. since 4.0.17 - use LinkEditorValue.set(de.espirit.firstspirit.access.Language, de.espirit.firstspirit.access.link.Link) instead

Since:

2.3.20

getLinkValue

@Deprecated
Link getLinkValue(Language language)

Deprecated. since 4.0.17 - use EditorValue.get(de.espirit.firstspirit.access.Language) instead

Since:

2.3.20

setLinkValue

@Deprecated
void setLinkValue(Language language,
                             Link value)

Deprecated. since 4.0.17 - use LinkEditorValue.set(de.espirit.firstspirit.access.Language, de.espirit.firstspirit.access.link.Link) instead

Since:

2.3.20

setDomLink

void setDomLink(Language language,
                Element linkElement)

Since:

4.0.17

getLinkConfig

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

Deprecated. since 4.0.17 - Use LinkEditorValue.getAllowedLinkTemplates() instead.

Since:

3.0.71

getLinkConfig

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

Since:

3.0.71

getAllowedLinks

@Deprecated
List getAllowedLinks()

Deprecated. since 4.0.17 - Use LinkEditorValue.getAllowedLinkTemplates() instead.

Since:

3.0.114

getAllowedLinkTemplates

@NotNull
List<LinkTemplate> getAllowedLinkTemplates()

Get a list of allowed link types.

Returns:

The list of allowed link types.

Since:

4.2.24

set

void set(Language language,
         Link object)
         throws InvalidValueException

Set the value object for the specified language. If the editor is not language dependent, the language will be ignored.

Specified by:

set in interface EditorValue<Link>

Parameters:

language - The language to use.

object - The object to store.

Throws:

InvalidValueException - If the given object is no valid value.

Since:

4.2.24

Example:

How to create and store a link