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

Interface GomElement

All Superinterfaces:
Serializable
All Known Subinterfaces:
GomCatalog, GomEditorProvider, GomFormElement, GomIncludeConfiguration, GomIndex, GomIndexSource, GomLangInfo, GomLangInfoProvider, GomLangInfos, GomList<T>
All Known Implementing Classes:
AbstractGomElement, AbstractGomFormElement, AbstractGomLangInfoProvider, AbstractGomList, DefaultGomLangInfo, DefaultGomLangInfos, GomLabeledValueEntry
public interface GomElement extends Serializable
Tag for marking a class to implement a GOM element. Requires two methods to be implemented being used for keeping track of the GOM TAG-name an instance was created for.
Since:
4.0

  • Method Details

    • setGomElementTag

      void setGomElementTag(@NotNull @NotNull String name)
      Sets the tag name, the instance gets produced for.
      Parameters:
      name - The name of the tag.
      Since:
      4.0

    • getGomElementTag

      String getGomElementTag()
      Get the tag name, the instance was produced for.
      Returns:
      The name of the tag.
      Since:
      4.0

    • getIncludeConfiguration

      @Nullable @Nullable GomIncludeConfiguration getIncludeConfiguration()
      Get the configuration, if this is an included element.
      Returns:
      The configuration for including the element.
      Since:
      4.0

    • setIncludeConfiguration

      void setIncludeConfiguration(@Nullable @Nullable GomIncludeConfiguration configuration)
      Set the configuration for an included element.
      Parameters:
      configuration - The configuration to set.
      Since:
      4.0

    • hasRepresentation

      boolean hasRepresentation()
      Indicates, that the element has a representation to be displayed in a form.
      A representation usually corresponds to a registered editor component.
      Returns:
      true, if a representation is available.
      Since:
      4.1.10