Interface GomEditorProvider

All Superinterfaces:
Collection<GomElement>, GomElement, GomList<GomElement>, Iterable<GomElement>, List<GomElement>, Serializable

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 Details

    • getUid

      @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 GomElement get(int index)
      Getter for GomElements.
      Specified by:
      get in interface List<GomElement>
      Since:
      4.0
    • findEditor

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

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