Package io.jmix.flowui.component.filter

Interface SingleFilterComponent<V>

Type Parameters:

V - value type

All Superinterfaces:

FilterComponent, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasStyle, Serializable

All Known Implementing Classes:

JpqlFilter, PropertyFilter, SingleFilterComponentBase

public interface SingleFilterComponent<V>
extends FilterComponent

Component which cannot contain other filter component but can be used for filtering entities returned by the DataLoader.

See Also:

• PropertyFilter
• JpqlFilter
• LogicalFilterComponent

Method Summary

Modifier and Type	Method	Description
String	getLabelWidth()
String	getParameterName()
com.vaadin.flow.component.HasValueAndElement<?,V>	getValueComponent()
boolean	isLabelVisible()
void	setLabelVisible(boolean labelVisible)	Sets label visibility.
void	setLabelWidth(String labelWidth)	Sets the label width.
void	setParameterName(String parameterName)	Sets the name of the associated query parameter name.
void	setValueComponent(com.vaadin.flow.component.HasValueAndElement<?,V> valueComponent)	Sets the field for editing a property value.

Methods inherited from interface io.jmix.flowui.component.filter.FilterComponent

apply, getDataLoader, getQueryCondition, isAutoApply, isConditionModificationDelegated, setAutoApply, setConditionModificationDelegated, setDataLoader

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Method Details

getParameterName

String getParameterName()

Returns:

the name of the associated query parameter name

setParameterName

void setParameterName(String parameterName)

Sets the name of the associated query parameter name.

Parameters:

parameterName - a name of the associated query parameter name

getValueComponent

com.vaadin.flow.component.HasValueAndElement<?,V> getValueComponent()

Returns:

a field for editing a property value

setValueComponent

void setValueComponent(com.vaadin.flow.component.HasValueAndElement<?,V> valueComponent)

Sets the field for editing a property value.

Parameters:

valueComponent - a field for editing a property value

getLabelWidth

@Nullable
String getLabelWidth()

Returns:

the width which has been set for the label

setLabelWidth

void setLabelWidth(@Nullable
 String labelWidth)

Sets the label width.

The width should be in a format understood by the browser, e.g. "100px" or "2.5em".

If the provided width value is null then width is removed.

Parameters:

labelWidth - the width to set, may be null

isLabelVisible

boolean isLabelVisible()

Returns:

true if label is visible

setLabelVisible

void setLabelVisible(boolean labelVisible)

Sets label visibility. Default value is true.

Parameters:

labelVisible - whether to show label or not