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

Class AbstractGomSelect

java.lang.Object

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

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

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

All Implemented Interfaces:

Cloneable<GomFormElement>, OptionFactoryProvider, GomCheckable, GomElement, GomEntryProvider, GomFormElement, GomHideable, GomLangInfoProvider, GomSearchRelevancy, LineBreakable, RelationEnabling, Serializable, Cloneable

Direct Known Subclasses:

AbstractGomCombobox, AbstractGomGridSelect

@NonExtendable
public abstract class AbstractGomSelect
extends AbstractGomFormElement
implements GomEntryProvider, RelationEnabling

Abstract base class for selectable GOM elements like checkboxes or radio-buttons.

Since:

3.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomCheckable

GomCheckable.Context

Constructor Summary

Constructors

Constructor	Description
AbstractGomSelect()

Method Summary

Modifier and Type	Method	Description
boolean	allowsRelations()	Indicates whether foreign key relationships are supported as value source.
AbstractGomSelect	clone()	Creates a clone of this form element.
DefaultGomEntryList	getEntries()	Get a GOM list element that provides labeled entries.
OptionFactory	getOptionFactory()	Get an option factory.
SortOrder	getSortOrder()	Returns the order in which display options are displayed
void	setSortOrder(SortOrder sortOrder)	Sets the order in which display options are displayed
@NotNull SortOrder	sortOrder()	Convenience method for getSortOrder() returning a non-null value
void	validate(GomCheckable.Context context)	Validates the form element's state with respect to the given context.

Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement

allowsEmpty, breaks, convertEntities, description, fillsHorizontally, getAllowEmpty, getConvertEntities, getDefaultValue, getHFill, getHidden, getLabel, getLangInfos, getName, getNoBreak, getPreset, getSearchRelevancy, getUseLanguages, isHidden, label, name, preset, setAllowEmpty, setConvertEntities, setDefaultValue, setHFill, setHidden, setLabel, setLabelAndDescription, setName, setNoBreak, setPreset, setSearchRelevancy, setUseLanguages, usesLanguages, verify

Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement

getDefaultTag, getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Constructor Details

AbstractGomSelect

public AbstractGomSelect()

Method Details

getSortOrder

public SortOrder getSortOrder()

Returns the order in which display options are displayed

Since:

3.0

setSortOrder

public void setSortOrder(SortOrder sortOrder)

Sets the order in which display options are displayed

Since:

3.0

getEntries

public DefaultGomEntryList getEntries()

Description copied from interface: GomEntryProvider

Get a GOM list element that provides labeled entries.

Specified by:

getEntries in interface GomEntryProvider

Returns:

The entries container.

validate

public void validate(GomCheckable.Context context)
              throws GomValidationError

Description copied from class: AbstractGomFormElement

Validates the form element's state with respect to the given context. This generic stub does not check anything.

Specified by:

validate in interface GomCheckable

Overrides:

validate in class AbstractGomFormElement

Parameters:

context - The context to validate for, must not be null.

Throws:

GomValidationError - if any requirement is violated.

getOptionFactory

public OptionFactory getOptionFactory()

Description copied from interface: OptionFactoryProvider

Get an option factory.

Specified by:

getOptionFactory in interface OptionFactoryProvider

Returns:

The factory.

allowsRelations

public boolean allowsRelations()

Description copied from interface: RelationEnabling

Indicates whether foreign key relationships are supported as value source.

Specified by:

allowsRelations in interface RelationEnabling

Returns:

true, if supported.

clone

public AbstractGomSelect clone()

Description copied from class: AbstractGomFormElement

Creates a clone of this form element.

Specified by:

clone in interface Cloneable<GomFormElement>

Specified by:

clone in interface GomEntryProvider

Overrides:

clone in class AbstractGomFormElement

Returns:

A clone.

sortOrder

@NotNull
public @NotNull SortOrder sortOrder()

Convenience method for getSortOrder() returning a non-null value

Returns:

the sort order or SortOrder.KEEP_ORDER if not available

Since:

4.0