Package io.jmix.flowui.component.genericfilter

Class FilterUtils

java.lang.Object

io.jmix.flowui.component.genericfilter.FilterUtils

public class FilterUtils
extends Object

Constructor Summary

Constructors

Constructor	Description
FilterUtils()

Method Summary

Modifier and Type	Method	Description
static @Nullable com.vaadin.flow.component.Composite<?>	findCurrentOwner(GenericFilter genericFilter)	Finds and returns the current owner of the specified GenericFilter.
static String	generateConfigurationId(@Nullable String configurationName)
static String	generateFilterPath(GenericFilter filter)
static <T extends Facet> @Nullable T	getFacet(@Nullable com.vaadin.flow.component.Composite<?> currentOwner, Class<T> facetClass)	Retrieves a facet of the specified type from the given owner.
static <T extends Facet> @Nullable T	getFacet(GenericFilter genericFilter, Class<T> facetClass)	Retrieves a facet of the specified type from the current owner of the given GenericFilter.
static void	setCurrentConfiguration(GenericFilter filter, Configuration currentConfiguration, boolean fromClient)
static void	updateDataLoaderInitialCondition(GenericFilter genericFilter, @Nullable Condition condition)	Deprecated, for removal: This API element is subject to removal in a future version. no longer used internally; GenericFilter now captures the initial data loader condition lazily.

Methods inherited from class java.lang.Object

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

Constructor Details

FilterUtils

public FilterUtils()

Method Details

generateConfigurationId

public static String generateConfigurationId(@Nullable String configurationName)

generateFilterPath

public static String generateFilterPath(GenericFilter filter)

setCurrentConfiguration

public static void setCurrentConfiguration(GenericFilter filter,
 Configuration currentConfiguration,
 boolean fromClient)

updateDataLoaderInitialCondition

@Deprecated(since="3.0",
            forRemoval=true)
public static void updateDataLoaderInitialCondition(GenericFilter genericFilter,
 @Nullable Condition condition)

Deprecated, for removal: This API element is subject to removal in a future version.

no longer used internally; GenericFilter now captures the initial data loader condition lazily. Retained for backward compatibility.

findCurrentOwner

public static @Nullable com.vaadin.flow.component.Composite<?> findCurrentOwner(GenericFilter genericFilter)

Finds and returns the current owner of the specified GenericFilter. The owner is determined by checking if the GenericFilter attached to a fragment or a view.

Parameters:

genericFilter - the GenericFilter for which the current owner is to be found

Returns:

the current owner of the GenericFilter, or null if no owner is found

getFacet

public static <T extends Facet> @Nullable T getFacet(GenericFilter genericFilter,
 Class<T> facetClass)

Retrieves a facet of the specified type from the current owner of the given GenericFilter.

Type Parameters:

T - the type of the facet to be returned

Parameters:

genericFilter - the GenericFilter whose current owner is queried for the specified facet type

facetClass - the Class of the facet to be retrieved

Returns:

the facet of the specified type if found, or null if no such facet exists

getFacet

public static <T extends Facet> @Nullable T getFacet(@Nullable com.vaadin.flow.component.Composite<?> currentOwner,
 Class<T> facetClass)

Retrieves a facet of the specified type from the given owner.

Type Parameters:

T - the type of the facet to be returned

Parameters:

currentOwner - the current owning Composite instance from which to retrieve the facet (a Fragment or a View), or null if no owner is currently available

facetClass - the Class of the facet to be retrieved, must not be null

Returns:

the facet of the specified type if found, or null if no such facet exists