io.jmix.ui.component.filter.registration

Class FilterComponentRegistrationBuilder<C extends FilterComponent,M extends FilterCondition>

java.lang.Object

io.jmix.ui.component.filter.registration.FilterComponentRegistrationBuilder<C,M>

Type Parameters:

C - UI filter component type

M - model type

public class FilterComponentRegistrationBuilder<C extends FilterComponent,M extends FilterCondition>
extends java.lang.Object

Builds registration object that is used for adding or overriding UI filter components in the framework

For instance:

 @Configuration
 public class FilterComponentConfiguration {

      @Bean
      public FilterComponentRegistration registerPropertyFilterComponent() {
          return FilterComponentRegistrationBuilder.create(PropertyFilter.class,
          PropertyFilterCondition.class,
          PropertyFilterConverter.class)
          .build();
      }
 }
 

See Also:

FilterComponentRegistration, FilterComponents

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<C>	componentClass
protected java.lang.Class<? extends FilterConverter<C,M>>	converterClass
protected java.lang.String	editScreenId
protected java.lang.Class<M>	modelClass

Constructor Summary

Constructors

Constructor and Description
FilterComponentRegistrationBuilder(java.lang.Class<C> componentClass, java.lang.Class<M> modelClass, java.lang.Class<? extends FilterConverter<C,M>> converterClass)

Method Summary

Modifier and Type	Method and Description
FilterComponentRegistration	build()
static <C extends FilterComponent,M extends FilterCondition> FilterComponentRegistrationBuilder<C,M>	create(java.lang.Class<C> componentClass, java.lang.Class<M> modelClass, java.lang.Class<? extends FilterConverter<C,M>> converterClass)
FilterComponentRegistrationBuilder<C,M>	withEditScreenId(java.lang.String editScreenId) Sets an id of the model edit screen.

Methods inherited from class java.lang.Object

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

Field Detail

componentClass

protected java.lang.Class<C extends FilterComponent> componentClass

modelClass

protected java.lang.Class<M extends FilterCondition> modelClass

converterClass

protected java.lang.Class<? extends FilterConverter<C extends FilterComponent,M extends FilterCondition>> converterClass

editScreenId

protected java.lang.String editScreenId

Constructor Detail

FilterComponentRegistrationBuilder

public FilterComponentRegistrationBuilder(java.lang.Class<C> componentClass,
                                          java.lang.Class<M> modelClass,
                                          java.lang.Class<? extends FilterConverter<C,M>> converterClass)

Parameters:

componentClass - a UI filter component class

modelClass - a model class

converterClass - a converter class

Method Detail

create

public static <C extends FilterComponent,M extends FilterCondition> FilterComponentRegistrationBuilder<C,M> create(java.lang.Class<C> componentClass,
                                                                                                                   java.lang.Class<M> modelClass,
                                                                                                                   java.lang.Class<? extends FilterConverter<C,M>> converterClass)

Type Parameters:

C - UI filter component type

M - model type

Parameters:

componentClass - a UI filter component class

modelClass - a model class

converterClass - a converter class

Returns:

builder instance

withEditScreenId

public FilterComponentRegistrationBuilder<C,M> withEditScreenId(java.lang.String editScreenId)

Sets an id of the model edit screen. If no identifier is specified then the identifier will be equal to the model name obtained from the JmixEntity, with Window.EDITOR_WINDOW_SUFFIX.

Parameters:

editScreenId - id of the model edit screen

Returns:

builder instance

build

public FilterComponentRegistration build()

Returns:

instance of registration object