de.espirit.firstspirit.access.store.templatestore.gom

Interface GomFormElement

All Superinterfaces:

GomElement, GomHideable, GomLangInfoProvider, Serializable

All Known Implementing Classes:

AbstractGomFormElement

public interface GomFormElement
extends GomLangInfoProvider, GomHideable

Definition for a GOM element acting as editor.

Since:

4.0.17

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowsEmpty() Indicates that empty values are allowed.
boolean	breaks() Indicates, that the form shall be followed by a line break.
ConvertEntity	convertEntities() Get the mode for converting unicode characters.
boolean	fillsHorizontally() Indicates, that the form shall be filled horizontally.
YesNo	getAllowEmpty() Indicates, whether leaving the form empty is allowed.
EditorValue<?>	getDefaultValue() Get the default value for the form element.
YesNo	getHidden() Indicates, whether the component will be hidden or shown.
Designator	getName() Get the name identifying the editor's value.
Preset	getPreset() Get the mode to be applied for fallback values.
String	name() Get the name of this form element.
Preset	preset() Get the preset mode to be used.
void	setAllowEmpty(YesNo allowEmpty) Set, whether leaving the form empty is allowed.
void	setDefaultValue(EditorValue<?> editorValue) Set the default value for the form element.
void	setHidden(YesNo hidden) Set, whether the form will be hidden.
void	setName(Designator name) Set the name that identifies the editor's value.
void	setPreset(Preset preset) Set the mode to be applied for fallback values.
boolean	usesLanguages() Indicates, that the form element uses languages.

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomLangInfoProvider

description, getLangInfos, label

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration, validate

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomHideable

isHidden

Method Detail

setName

void setName(Designator name)

Set the name that identifies the editor's value.

Parameters:

name - The name.

Since:

4.0.17

getName

Designator getName()

Get the name identifying the editor's value.

Returns:

The name.

Since:

4.0.17

setDefaultValue

void setDefaultValue(EditorValue<?> editorValue)

Set the default value for the form element.

Parameters:

editorValue - The value container.

Since:

4.0.17

getDefaultValue

EditorValue<?> getDefaultValue()

Get the default value for the form element.

Returns:

The default value container or null.

Since:

4.0.17

getAllowEmpty

YesNo getAllowEmpty()

Indicates, whether leaving the form empty is allowed.

Returns:

Definition for allowing emptiness.

Since:

4.0.17

setAllowEmpty

void setAllowEmpty(YesNo allowEmpty)

Set, whether leaving the form empty is allowed.

Parameters:

allowEmpty - Indicator for allowing emptiness.

Since:

4.0.17

getHidden

YesNo getHidden()

Indicates, whether the component will be hidden or shown.

Returns:

true, if to be hidden.

Since:

4.0.44

setHidden

void setHidden(YesNo hidden)

Set, whether the form will be hidden.

Parameters:

hidden - Indicator for the element being hidden.

Since:

4.0.44

getPreset

Preset getPreset()

Get the mode to be applied for fallback values.

Returns:

The mode to be used.

Since:

4.0.55

setPreset

void setPreset(Preset preset)

Set the mode to be applied for fallback values.

Parameters:

preset - The preset mode to be used.

Since:

4.0.55

name

@NotNull
String name()

Get the name of this form element.

Returns:

The name.

Since:

4.0.17

convertEntities

ConvertEntity convertEntities()

Get the mode for converting unicode characters.

Returns:

The ConvertEntity mode.

Since:

4.0.17

fillsHorizontally

boolean fillsHorizontally()

Indicates, that the form shall be filled horizontally.

Returns:

true, iff to be filled.

Since:

4.0.17

usesLanguages

boolean usesLanguages()

Indicates, that the form element uses languages.

Returns:

true, iff it uses languages.

Since:

4.0.17

breaks

boolean breaks()

Indicates, that the form shall be followed by a line break.

Returns:

false, iff it shall not break.

Since:

4.0.17

allowsEmpty

boolean allowsEmpty()

Indicates that empty values are allowed.

Returns:

true, if empty values are allowed.

Since:

4.0.17

preset

Preset preset()

Get the preset mode to be used.

Returns:

The preset mode.

Since:

4.0.55