io.jmix.ui.sys.registration

Class ComponentRegistrationBuilder

java.lang.Object

io.jmix.ui.sys.registration.ComponentRegistrationBuilder

public class ComponentRegistrationBuilder
extends java.lang.Object

Builds registration object that is used for adding or overriding UI components 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:

ComponentRegistration, CustomComponentsRegistry

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<? extends Component>	componentClass
protected java.lang.Class<? extends ComponentLoader>	componentClassLoader
protected java.lang.String	name
protected java.lang.String	tag

Constructor Summary

Constructors

Constructor and Description
ComponentRegistrationBuilder(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
ComponentRegistration	build()
static ComponentRegistrationBuilder	create(java.lang.String name)
ComponentRegistrationBuilder	withComponentClass(java.lang.Class<? extends Component> componentClass) Sets component class.
ComponentRegistrationBuilder	withComponentLoaderClass(java.lang.Class<? extends ComponentLoader> componentClassLoader) Sets component loader class.
ComponentRegistrationBuilder	withTag(java.lang.String tag) Sets component name in the screen descriptor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected java.lang.String name

tag

protected java.lang.String tag

componentClass

protected java.lang.Class<? extends Component> componentClass

componentClassLoader

protected java.lang.Class<? extends ComponentLoader> componentClassLoader

Constructor Detail

ComponentRegistrationBuilder

public ComponentRegistrationBuilder(java.lang.String name)

Parameters:

name - component name

Method Detail

create

public static ComponentRegistrationBuilder create(java.lang.String name)

Parameters:

name - component name

Returns:

builder instance

withTag

public ComponentRegistrationBuilder withTag(java.lang.String tag)

Sets component name in the screen descriptor. If tag is null or empty registration object will set tag = name.

Parameters:

tag - element name

Returns:

builder instance

withComponentClass

public ComponentRegistrationBuilder withComponentClass(java.lang.Class<? extends Component> componentClass)

Sets component class.

Parameters:

componentClass - component class

Returns:

builder instance

withComponentLoaderClass

public ComponentRegistrationBuilder withComponentLoaderClass(java.lang.Class<? extends ComponentLoader> componentClassLoader)

Sets component loader class.

Parameters:

componentClassLoader - component loader class

Returns:

builder instance

build

public ComponentRegistration build()

Returns:

instance of registration object