de.espirit.firstspirit.access.editor
Interface DomEditorValue

All Superinterfaces:

EditorValue<DomElement>, FormatTemplateAccess

public interface DomEditorValue
extends EditorValue<DomElement>, FormatTemplateAccess

Since:

2.3.17

Example:

Example how to get the value of a DomEditorValue and how to store a value into a DomEditorValue

Field Summary

static String

DOM_KEY root tag name - DO NOT CHANGE, will break stored data

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 DomEditorValue.getAllowedLinkTemplates() instead.
List<LinkTemplate>	getAllowedLinkTemplates() Get a list of allowed link types.
Element	getDomValue() Deprecated. since 4.0.17 - use get(Language).get() instead
Element	getDomValue(Language language) Deprecated. since 4.0.17 - use get(Language).get() instead
GomDom	getForm() Covariant return of concrete form container.
de.espirit.firstspirit.access.link.LinkConfig[]	getLinkConfig() Deprecated. since 4.0.17 - Use getLinkConfigs() instead.
de.espirit.firstspirit.access.link.LinkConfig	getLinkConfig(String name)
ListConfigProperty[]	getListConfigProperties() Deprecated. since 4.0.17 - Use GomDom.getListConfigProperties()
Map	getListDefaultConfig() Deprecated. since 4.0.17 - Use GomDom.getListConfigProperties()
String	getShortContent() Gets the first 20 characters of the value of this DOM editor's value as String in the project's master language.
String	getShortContent(Language language) Gets the first 20 characters of the value of this DOM editor's value as String in the given language.
void	setDomValue(Element value) Deprecated. since 4.0.17 - use get(Language).set(Element) instead
void	setDomValue(Language language, Element value) Deprecated. since 4.0.17 - use get(Language).set(Element) instead
String	toHtml(Language language) Build an HTML representation for the given language's value.

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

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

getFormatTemplates

Field Detail

DOM_KEY

static final String DOM_KEY

root tag name - DO NOT CHANGE, will break stored data

Since:

4.0.17

See Also:

Constant Field Values

Method Detail

getForm

GomDom getForm()

Covariant return of concrete form container.

Specified by:

getForm in interface EditorValue<DomElement>

Returns:

The form definition.

Since:

4.0.17

toHtml

String toHtml(Language language)

Build an HTML representation for the given language's value.

Returns:

The value in HTML format.

Since:

4.0.17

getDomValue

@Deprecated
Element getDomValue()

Deprecated. since 4.0.17 - use get(Language).get() instead

Get the value of the DOM editor in the project's master language.

Returns:

A node for the DOM editor.

Since:

2.3.17

setDomValue

@Deprecated
void setDomValue(Element value)

Deprecated. since 4.0.17 - use get(Language).set(Element) instead

Set the value of this DOM editor in the project master language.

Parameters:

value - The element container providing the new value for this DOM editor.

Since:

2.3.17

getDomValue

@Deprecated
Element getDomValue(Language language)

Deprecated. since 4.0.17 - use get(Language).get() instead

Gets the XML value of this DOM editor for the given language.

Parameters:

language - The language to get the value for.

Returns:

Element The XML Element DOM editor value

Since:

2.3.17

setDomValue

@Deprecated
void setDomValue(Language language,
                            Element value)

Deprecated. since 4.0.17 - use get(Language).set(Element) instead

Set the value of this DOM editor in the project master language. Note that only the children of the given element and not the element itself are taken as children of new value.

Parameters:

language - The language to set the value for.

value - The element container providing the new value for this DOM editor.

Since:

2.3.17

getLinkConfig

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

Deprecated. since 4.0.17 - Use getLinkConfigs() instead.

Since:

3.0.30

getLinkConfig

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

Since:

3.0.30

getShortContent

String getShortContent(Language language)

Gets the first 20 characters of the value of this DOM editor's value as String in the given language.

Parameters:

language - The language to get the value for.

Returns:

A short content string representation of the value.

Since:

3.0.59

getShortContent

String getShortContent()

Gets the first 20 characters of the value of this DOM editor's value as String in the project's master language.

Returns:

A short content string representation of the value.

Since:

4.0.17

getAllowedLinks

@Deprecated
List getAllowedLinks()

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

Since:

3.1.158

getAllowedLinkTemplates

@NotNull
List<LinkTemplate> getAllowedLinkTemplates()

Get a list of allowed link types.

Returns:

The list of allowed link types.

Since:

4.2.24

getListConfigProperties

@Deprecated
ListConfigProperty[] getListConfigProperties()

Deprecated. since 4.0.17 - Use GomDom.getListConfigProperties()

Since:

3.1.193

getListDefaultConfig

@Deprecated
Map getListDefaultConfig()

Deprecated. since 4.0.17 - Use GomDom.getListConfigProperties()

Since:

3.1.193