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 java.lang.Object
implements FilterComponentRegistration

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends FilterComponent>	getComponentClass() Returns a class of the UI filter component.
java.lang.Class<? extends FilterConverter<? extends FilterComponent,? extends FilterCondition>>	getConverterClass() Returns a converter class.
java.lang.String	getEditScreenId() Returns an id of the model edit screen.
java.lang.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 Detail

componentClass

protected final java.lang.Class<? extends FilterComponent> componentClass

modelClass

protected final java.lang.Class<? extends FilterCondition> modelClass

converterClass

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

editScreenId

protected final java.lang.String editScreenId

Constructor Detail

FilterComponentRegistrationImpl

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

Method Detail

getComponentClass

public java.lang.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 java.lang.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 java.lang.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 java.lang.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.