Package io.jmix.ui.presentation.facet

Interface PresentationsFacet

All Superinterfaces:
Facet
All Known Implementing Classes:
PresentationsFacetImpl
@StudioFacet(xmlElement="presentations", caption="Presentations", category="Facets", description="Provides the ability to apply and save presentations for components", defaultProperty="auto", documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/facets/presentations-facet.html", icon="io/jmix/ui/icon/facet/presentations.svg") public interface PresentationsFacet extends Facet
Provides the ability to apply and save presentations for components.

  • Method Details

    • isAuto

      boolean isAuto()
      Returns:
      true if facet should apply and save presentations for all supported component in the screen. False by default.

    • setAuto

      @StudioProperty(defaultValue="false", initialValue="true") void setAuto(boolean auto)
      Set to true if facet should apply and save presentations for all supported component in the screen. False by default.
      Parameters:
      auto - whether facet should include all components for applying/saving presentations

    • addComponentIds

      void addComponentIds(String... ids)
      Adds component ids that should be handled when isAuto() returns false.

      Note, component must be attached to the Window, otherwise it will be ignored.

      Parameters:
      ids - component ids

    • getComponentIds

      Set<String> getComponentIds()
      Returns:
      list of component ids that should be handled when isAuto() returns false.

    • getComponents

      Collection<Component> getComponents()
      Collection depends on isAuto() property. If isAuto() returns true collection will be filled by Window's components, otherwise collection will be filled by components were added by addComponentIds(String...).
      Returns:
      components collection that is used for applying and saving presentations.