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

Interface GomCatalog

All Superinterfaces:

GomElement, GomFormElement, GomHideable, GomLangInfoProvider, Serializable

@NonExtendable
public interface GomCatalog
extends GomFormElement

Definition of the GOM descriptor for the FirstSpirit catalog gadget.

Since:

5.2.23

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TAG	The tag of this component

Method Summary

Modifier and Type	Method	Description
boolean	forbidsPolyglotDataHierarchy()	Indicates, whether it is forbidden to have language dependent inner forms on multiple levels in this catalog's child hierarchy.
default @NotNull GomTypeRestrictedTemplates	getTemplates()	Provides a container defining templates allowed for items being catalogued
int	height()	Provides the defined height for this component or its default, if unset.
Set<String>	templates()	Provides a set of template UIDs as defined eligible for this catalog.
IDProvider.UidType	templatesUidType()	Provides the UID type for templates allowed for this catalog.
ViewMode	viewMode()	Provides the initial view mode for displaying index entries.

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

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

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

allowsEmpty, breaks, convertEntities, fillsHorizontally, getAllowEmpty, getDefaultValue, getHidden, getName, getPreset, name, preset, setAllowEmpty, setDefaultValue, setHidden, setName, setPreset, usesLanguages

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

isHidden

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

description, getLangInfos, label

Field Details

TAG

static final String TAG

The tag of this component

Since:

5.2.241303

See Also:

• Constant Field Values

Method Details

height

int height()

Provides the defined height for this component or its default, if unset.

Returns:

The desired initial height.

Since:

5.2.23

viewMode

ViewMode viewMode()

Provides the initial view mode for displaying index entries.

Returns:

The initial view mode.

Since:

5.2.23

templates

Set<String> templates()

Provides a set of template UIDs as defined eligible for this catalog.

Returns:

The allowed templates.

Since:

5.2.23

templatesUidType

IDProvider.UidType templatesUidType()

Provides the UID type for templates allowed for this catalog.

Returns:

The templates' UID type.

Since:

5.2.23

forbidsPolyglotDataHierarchy

boolean forbidsPolyglotDataHierarchy()

Indicates, whether it is forbidden to have language dependent inner forms on multiple levels in this catalog's child hierarchy.

Returns:

true, if forbidden.

Since:

5.2.510

getTemplates

@NotNull
default @NotNull GomTypeRestrictedTemplates getTemplates()

Provides a container defining templates allowed for items being catalogued

Returns:

The templates definition container, never null

Since:

5.2.241303