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

Interface GomEditorProvider

All Superinterfaces:

Collection<GomElement>, GomElement, GomList<GomElement>, Iterable<GomElement>, List<GomElement>, Serializable

All Known Implementing Classes:

GomGroup, GomModule

public interface GomEditorProvider
extends GomList<GomElement>

Tag for GOM elements acting as group, i.e., a container for a list of GOM elements.

Since:

4.0

Method Summary

Modifier and Type	Method	Description
@NotNull List<String>	appendEditorNames(@Nullable List<String> names)	Append the names of all local and children's editors to the given list of names and return the list.
@Nullable GomFormElement	findEditor(String name)	Look up a GOM editor element within this provider.
@NotNull Iterable<GomFormElement>	forms()	Returns an iterable on all form elements within this provider.
@Nullable GomElement	get(int index)	Getter for GomElements.
@Nullable String	getUid()	Get the unique identifier of this provider.
void	setDefaults(Data data)	Deprecated. since 5.2.20, use setFormDefaults(FormData).
void	setFormDefaults(@Nullable FormData formData)	Set the default values for all editors based on the given form data.
void	setUid(String uid)	Set the unique identifier for this provider.

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

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.GomList

getGomElementMappings

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Method Details

getUid

@Nullable
@Nullable String getUid()

Get the unique identifier of this provider.

Returns:

The provider's UID.

Since:

4.0

setUid

void setUid(String uid)

Set the unique identifier for this provider.

Parameters:

uid - The identifier to be used for this provider.

Since:

4.0

get

@Nullable
@Nullable GomElement get(int index)

Getter for GomElements.

Specified by:

get in interface List<GomElement>

Since:

4.0

findEditor

@Nullable
@Nullable GomFormElement findEditor(String name)

Look up a GOM editor element within this provider.

Parameters:

name - The name of the editor.

Returns:

The matching editor or null.

Since:

4.0

appendEditorNames

@NotNull
@NotNull List<String> appendEditorNames(@Nullable
 @Nullable List<String> names)

Append the names of all local and children's editors to the given list of names and return the list. If names is null, returns a new list.

Parameters:

names - A list of names or null.

Returns:

The list of editor names, maybe empty.

Since:

4.0

forms

@NotNull
@NotNull Iterable<GomFormElement> forms()

Returns an iterable on all form elements within this provider.

Returns:

A list of form elements, maybe empty.

Since:

4.0

setDefaults

@Deprecated
void setDefaults(Data data)

Deprecated.

since 5.2.20, use setFormDefaults(FormData).

Set the default values for all editors based on the given data.

Parameters:

data - The data providing default values.

Since:

4.0.45

setFormDefaults

void setFormDefaults(@Nullable
 @Nullable FormData formData)

Set the default values for all editors based on the given form data.

Parameters:

formData - The form data providing default values.

Since:

5.2.20