Class FilterComponentRegistrationBuilder<C extends FilterComponent,M extends FilterCondition>
java.lang.Object
io.jmix.flowui.component.genericfilter.registration.FilterComponentRegistrationBuilder<C,M>
- Type Parameters:
C
- UI filter component typeM
- model type
public class FilterComponentRegistrationBuilder<C extends FilterComponent,M extends FilterCondition>
extends 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:
-
Field Summary
Modifier and TypeFieldDescriptionprotected Class<? extends FilterConverter<C,
M>> protected String
-
Constructor Summary
ConstructorDescriptionFilterComponentRegistrationBuilder
(Class<C> componentClass, Class<M> modelClass, Class<? extends FilterConverter<C, M>> converterClass) -
Method Summary
Modifier and TypeMethodDescriptionbuild()
static <C extends FilterComponent,
M extends FilterCondition>
FilterComponentRegistrationBuilder<C,M> create
(Class<C> componentClass, Class<M> modelClass, Class<? extends FilterConverter<C, M>> converterClass) withDetailViewId
(String detailViewId) Sets an id of the model detail view.
-
Field Details
-
componentClass
-
modelClass
-
converterClass
protected Class<? extends FilterConverter<C extends FilterComponent,M extends FilterCondition>> converterClass -
detailViewId
-
-
Constructor Details
-
Method Details
-
create
public static <C extends FilterComponent,M extends FilterCondition> FilterComponentRegistrationBuilder<C,M> create(Class<C> componentClass, Class<M> modelClass, Class<? extends FilterConverter<C, M>> converterClass) - Type Parameters:
C
- UI filter component typeM
- model type- Parameters:
componentClass
- a UI filter component classmodelClass
- a model classconverterClass
- a converter class- Returns:
- builder instance
-
withDetailViewId
Sets an id of the model detail view. If no identifier is specified then the identifier will be equal to the model name obtained from theJmixEntity
, withViewRegistry.DETAIL_VIEW_SUFFIX
.- Parameters:
detailViewId
- id of the model detail view- Returns:
- builder instance
-
build
- Returns:
- instance of registration object
-