Package de.espirit.firstspirit.access.editor

Interface ReferenceEditorValue

All Superinterfaces:

EditorValue<TargetReference>

@Deprecated(since="5.2.21")
public interface ReferenceEditorValue
extends EditorValue<TargetReference>

Deprecated.

since 5.2.21 - use FormField instead

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

Since:

4.2

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REF_KEY	Deprecated. Key to store the referenced target.
static final String	REMOTE_NAME_KEY	Deprecated. Key to store the symbolic remote project name.
static final String	SECTION_KEY	Deprecated. Key to store the name of a section referenced to.
static final String	UID_KEY	Deprecated. Key to store the reference's UID.
static final String	UID_TYPE_KEY	Deprecated. Key to store the reference's UID type.

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
TargetReference	getEmpty(Language language)	Deprecated. Get an empty TargetReference.
GomReference	getForm()	Deprecated. Get the GuiXml form definition values.
boolean	isEmpty(TargetReference target)	Deprecated. 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, getGuiXml, getMatches, getSearchableString, getTagName, getValueType, initialize, isDefault, isLanguageDependent, isSet, isSet, isValid, removeEditorValueListener, set, setTagName, setValueNode, toXml, toXml, validate

Field Details

REF_KEY

static final String REF_KEY

Deprecated.

Key to store the referenced target.

Since:

4.2.24

See Also:

• Constant Field Values

UID_KEY

static final String UID_KEY

Deprecated.

Key to store the reference's UID.

Since:

4.2.24

See Also:

• Constant Field Values

UID_TYPE_KEY

static final String UID_TYPE_KEY

Deprecated.

Key to store the reference's UID type.

Since:

4.2.24

See Also:

• Constant Field Values

REMOTE_NAME_KEY

static final String REMOTE_NAME_KEY

Deprecated.

Key to store the symbolic remote project name.

Since:

4.2.24

See Also:

• Constant Field Values

SECTION_KEY

static final String SECTION_KEY

Deprecated.

Key to store the name of a section referenced to.

Since:

4.2.24

See Also:

• Constant Field Values

Method Details

getForm

GomReference getForm()

Deprecated.

Get the GuiXml form definition 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)

Deprecated.

Get an empty TargetReference.

Parameters:

language - A Language

Returns:

an empty TargetReference

Since:

4.2

isEmpty

boolean isEmpty(TargetReference target)

Deprecated.

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 false

Since:

4.2.24