Package io.jmix.flowui.sys.registration

Class FacetRegistrationBuilder

java.lang.Object
io.jmix.flowui.sys.registration.FacetRegistrationBuilder
public class FacetRegistrationBuilder extends Object
Builds registration object used for adding new facets registration or overriding UI facets in the framework.

For example: 


 @Configuration
 public class FacetConfiguration {

     @Bean
     public FacetRegistration extTimerFacet() {
         return FacetRegistrationBuilder.create(ExtTimerFacetImpl.class)
                 .replaceFacet(Timer.class)
                 .withFacetLoader("timer", ExtTimerFacetLoader.class)
                 .build();
     }
 }
See Also:

  • Field Details

  • Constructor Details

    • FacetRegistrationBuilder

      protected FacetRegistrationBuilder(Class<? extends Facet> facet)

  • Method Details

    • create

      public static FacetRegistrationBuilder create(Class<? extends Facet> facet)
      Creates a builder instance.
      Parameters:
      facet - facet class to register
      Returns:
      builder instance

    • replaceFacet

      public FacetRegistrationBuilder replaceFacet(Class<? extends Facet> facet)
      Sets the facet class that should be replaced.
      Parameters:
      facet - facet class to replace
      Returns:
      builder instance

    • withFacetLoader

      public FacetRegistrationBuilder withFacetLoader(String tag, Class<? extends FacetLoader<?>> facetLoader)
      Sets facet loader class.
      Parameters:
      tag - facet name in the view XML descriptor
      facetLoader - component loader class
      Returns:
      builder instance

    • build

      public FacetRegistration build()
      Returns:
      instance of a registration object