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:

ComponentRegistrationBuilder, CustomComponentsRegistry

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends Component>	getComponentClass()
java.lang.Class<? extends ComponentLoader>	getComponentLoaderClass()
java.lang.String	getName()
java.lang.String	getTag()

Method Detail

getName

java.lang.String getName()

Returns:

component name

getTag

java.lang.String getTag()

Returns:

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

getComponentClass

@Nullable
java.lang.Class<? extends Component> getComponentClass()

Returns:

component class

getComponentLoaderClass

@Nullable
java.lang.Class<? extends ComponentLoader> getComponentLoaderClass()

Returns:

component loader class