de.espirit.firstspirit.access.editor

Interface ReferenceEditorValue

All Superinterfaces:

EditorValue<TargetReference>

public interface ReferenceEditorValue
extends EditorValue<TargetReference>

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

Since:

4.2

Example:

How to get and store references

Field Summary

Fields

Modifier and Type	Field and Description
static String	REF_KEY
static String	REMOTE_NAME_KEY
static String	SECTION_KEY
static String	UID_KEY
static String	UID_TYPE_KEY

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

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

Method Summary

Methods

Modifier and Type	Method and Description
TargetReference	getEmpty(Language language) Get an empty TargetReference.
GomReference	getForm() Get the GuiXml formular definiotn values.
boolean	isEmpty(TargetReference target) Test whether a TargetReference is empty.

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

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

Field Detail

REF_KEY

static final String REF_KEY

Since:

4.2.24

See Also:

Constant Field Values

UID_KEY

static final String UID_KEY

Since:

4.2.24

See Also:

Constant Field Values

UID_TYPE_KEY

static final String UID_TYPE_KEY

Since:

4.2.24

See Also:

Constant Field Values

REMOTE_NAME_KEY

static final String REMOTE_NAME_KEY

Since:

4.2.24

See Also:

Constant Field Values

SECTION_KEY

static final String SECTION_KEY

Since:

4.2.24

See Also:

Constant Field Values

Method Detail

getForm

GomReference getForm()

Get the GuiXml formular definiotn values. Covariant return of concrete form container.

Specified by:

getForm in interface EditorValue<TargetReference>

Returns:

The form definition.

Since:

4.2

getEmpty

TargetReference getEmpty(Language language)

Get an empty TargetReference.

Parameters:

language - A Language

Returns:

an empty TargetReference

Since:

4.2

isEmpty

boolean isEmpty(TargetReference target)

Test whether a TargetReference is empty. a TargetReference is empty if the encapsulated element is null. element is always a type of IDProvider.

Specified by:

isEmpty in interface EditorValue<TargetReference>

Parameters:

target - the TargetReference to test.

Returns:

true if empty otherwise

Since:

4.2.24