Package io.jmix.ui.component.filter.registration

Class FilterComponentRegistrationImpl

java.lang.Object

io.jmix.ui.component.filter.registration.FilterComponentRegistrationImpl

All Implemented Interfaces:

FilterComponentRegistration

public class FilterComponentRegistrationImpl
extends Object
implements FilterComponentRegistration

Field Summary

Fields

Modifier and Type	Field	Description
protected final Class<? extends FilterComponent>	componentClass
protected final Class<? extends FilterConverter<? extends FilterComponent,? extends FilterCondition>>	converterClass
protected final String	editScreenId
protected final Class<? extends FilterCondition>	modelClass

Constructor Summary

Constructors

Constructor	Description
FilterComponentRegistrationImpl(Class<? extends FilterComponent> componentClass, Class<? extends FilterCondition> modelClass, Class<? extends FilterConverter<? extends FilterComponent,? extends FilterCondition>> converterClass, String editScreenId)

Method Summary

Modifier and Type	Method	Description
Class<? extends FilterComponent>	getComponentClass()	Returns a class of the UI filter component.
Class<? extends FilterConverter<? extends FilterComponent,? extends FilterCondition>>	getConverterClass()	Returns a converter class.
String	getEditScreenId()	Returns an id of the model edit screen.
Class<? extends FilterCondition>	getModelClass()	Returns a class of non-persistent entity that stores the state of the UI filter component.

Methods inherited from class java.lang.Object

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

Field Details

componentClass

protected final Class<? extends FilterComponent> componentClass

modelClass

protected final Class<? extends FilterCondition> modelClass

converterClass

protected final Class<? extends FilterConverter<? extends FilterComponent,? extends FilterCondition>> converterClass

editScreenId

protected final String editScreenId

Constructor Details

FilterComponentRegistrationImpl

public FilterComponentRegistrationImpl(Class<? extends FilterComponent> componentClass,
 Class<? extends FilterCondition> modelClass,
 Class<? extends FilterConverter<? extends FilterComponent,? extends FilterCondition>> converterClass,
 @Nullable
 String editScreenId)

Method Details

getComponentClass

public Class<? extends FilterComponent> getComponentClass()

Description copied from interface: FilterComponentRegistration

Returns a class of the UI filter component.

Specified by:

getComponentClass in interface FilterComponentRegistration

Returns:

a class of the UI filter component

getModelClass

public Class<? extends FilterCondition> getModelClass()

Description copied from interface: FilterComponentRegistration

Returns a class of non-persistent entity that stores the state of the UI filter component. The model class is used to save filter component state in DB and is used to display and change the state of the filter component at runtime.

Specified by:

getModelClass in interface FilterComponentRegistration

Returns:

a model class

getConverterClass

public Class<? extends FilterConverter<? extends FilterComponent,? extends FilterCondition>> getConverterClass()

Description copied from interface: FilterComponentRegistration

Returns a converter class. The converter is used to convert between a UI filter component and model classes.

Specified by:

getConverterClass in interface FilterComponentRegistration

Returns:

a converter class

getEditScreenId

public String getEditScreenId()

Description copied from interface: FilterComponentRegistration

Returns an id of the model edit screen.

Specified by:

getEditScreenId in interface FilterComponentRegistration

Returns:

an id of the model edit screen.