Interface Component

All Superinterfaces:
Cloneable
All Known Subinterfaces:
Action, ActionBar, ActionGroup, AddressField, AvailabilityField, BaseAction, CodeField, Column, ComponentContainer, CompositeComponent, DataComponent, Description, Display, DocumentField, Field, FieldSet, Form, FormatField, FulltextSearch, GeosearchField, HtmlField, Layout, LocationField, RangeField, RelationField, RemoteField, Report, SearchFilter, SelectBox, SubTable, Table, TermsComponent
All Known Implementing Classes:
AbstractAction, AbstractComponent, AbstractComponentContainer, AbstractCompositeComponent, ActionBarImpl, ActionGroupImpl, ActionImpl, AddressFieldImpl, AvailabilityFieldImpl, CodeFieldImpl, ColumnImpl, DescriptionImpl, DisplayImpl, DocumentFieldImpl, FieldImpl, FieldSetImpl, FormatFieldImpl, FormImpl, FulltextSearchImpl, GeosearchFieldImpl, HtmlFieldImpl, LayoutImpl, LocationFieldImpl, RangeFieldImpl, RelationFieldImpl, RemoteFieldImpl, ReportImpl, SearchFilterImpl, SelectBoxImpl, SubTableImpl, TableImpl, TermsComponentImpl
public interface Component extends Cloneable

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    Component.Configuration
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    accept(ComponentVisitor visitor)
    Implement method (and add new method to ComponentVisitor), if during traversing the form something should happen with this specific component type
    default Optional<Form>
    getForm()
     
    String
    getId()
    Optional id of the component.
    String
    getLabel()
    Returns the label of a component.
    Optional<Component>
    getParent()
     
    @Nullable String
    getPosition()
    Returns the position of the component within the parent ("top", "bottom", "after:...", or "before: ...").
    default void
    validate()
    Will be called when the form has been built completely.

  • Method Details

    • getId

      String getId()
      Optional id of the component. Can be useful if a component should be referenced.

    • getLabel

      String getLabel()
      Returns the label of a component.

    • getParent

      Optional<Component> getParent()

    • getPosition

      @Nullable @Nullable String getPosition()
      Returns the position of the component within the parent ("top", "bottom", "after:...", or "before: ...").

    • getForm

      default Optional<Form> getForm()

    • validate

      default void validate() throws ModelBuildException
      Will be called when the form has been built completely. Can be used to validate values (and throw ModelBuildException) or the fill in default value.
      Throws:
      ModelBuildException

    • accept

      default void accept(ComponentVisitor visitor)
      Implement method (and add new method to ComponentVisitor), if during traversing the form something should happen with this specific component type