Interface Layout


public interface Layout
Layout
  • Method Details

    • getId

      Integer getId()
      Get the id of the layout.
      Returns:
      the id of the layout
    • getName

      String getName()
      Get the name of the layout.
      Returns:
      the name of the layout
    • setName

      void setName(String name)
      Set the name of the layout.
      Parameters:
      name - the name of the layout
    • getDescription

      String getDescription()
      Get the description of the layout.
      Returns:
      the description of the layout
    • setDescription

      void setDescription(String description)
      Set the description of the layout.
      Parameters:
      description - the description of the layout
    • getSections

      List<SectionView> getSections()
      Get the unmodified stored structure of the layout.
      Returns:
      the stored structure of the layout
    • setSectionViewBuilders

      void setSectionViewBuilders(List<SectionViewBuilder> sectionViewBuilders)
      Set the new structure of the layout. This needs to persist to take effect.
      Parameters:
      sectionViewBuilders - the structure of the layout
    • addSectionViewBuilder

      void addSectionViewBuilder(SectionViewBuilder sectionViewBuilder)
      Add the new section in the new structure of the layout. This needs to persist to take effect.
      Parameters:
      sectionViewBuilder - the structure of the layout
    • removeSectionViewBuilder

      void removeSectionViewBuilder(SectionViewBuilder sectionViewBuilder)
      Remove the sectionViewBuilder in the new structure of the layout. This needs to persist to take effect
      Parameters:
      sectionViewBuilder - the section builder of the layout
    • removeAllSectionViewBuilders

      void removeAllSectionViewBuilders()
      Remove all new structure of the layout. This needs to persist to take effect.
    • getModifiedStructure

      List<SectionViewBuilder> getModifiedStructure()
      Get all new structure of the layout. This structure needs to persist to take effect.
      Returns:
      List of section view builder
    • isModifiedStructure

      boolean isModifiedStructure()
      Get true or false if there are new structure that needs to persist.
      Returns:
      true or false
    • getFields

      List<Field> getFields()
      Get all fields in the structure in the current layout
      Returns:
      List of field
    • getFieldsInModifiedStructure

      List<Field> getFieldsInModifiedStructure()
      Get all fields in the modified structure of layout
      Returns:
      List of field