Package io.jmix.ui.sys.registration

Interface ComponentRegistration

All Known Implementing Classes:
ComponentRegistrationImpl
public interface ComponentRegistration
Registers a UI component in the framework. For instance: 
 @Configuration
 public class ComponentConfiguration {

     @Bean
     public ComponentRegistration extButton() {
         return ComponentRegistrationBuilder.create(ExtButton.NAME)
                 .withComponentClass(ExtWebButton.class)
                 .withComponentLoaderClass(ExtButtonLoader.class)
                 .build();
     }
 }
See Also:

  • Method Details

    • getName

      String getName()
      Returns:
      component name

    • getTag

      String getTag()
      Returns:
      component name in the screen descriptor. If it was not explicitly set returns the same value as getName().

    • getComponentClass

      @Nullable Class<? extends Component> getComponentClass()
      Returns:
      component class

    • getComponentLoaderClass

      @Nullable Class<? extends ComponentLoader> getComponentLoaderClass()
      Returns:
      component loader class