io.jmix.ui.component

Interface SingleFilterComponent<V>

Type Parameters:

V - value type

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, FilterComponent, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValue<V>, Requirable, SupportsCaptionPosition, Validatable

All Known Subinterfaces:

JpqlFilter<V>, PropertyFilter<V>

All Known Implementing Classes:

AbstractSingleFilterComponent, JpqlFilterImpl, PropertyFilterImpl

public interface SingleFilterComponent<V>
extends FilterComponent, Component.BelongToFrame, HasValue<V>, Component.HasCaption, Component.HasIcon, Component.Focusable, Component.Editable, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, SupportsCaptionPosition, Requirable, Validatable, HasContextHelp

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

See Also:

PropertyFilter, JpqlFilter, LogicalFilterComponent

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.SupportsCaptionPosition

SupportsCaptionPosition.CaptionPosition

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
float	getCaptionWidth()
SizeUnit	getCaptionWidthSizeUnit()
java.lang.String	getParameterName()
HasValue<V>	getValueComponent()
boolean	isCaptionVisible()
void	setCaptionVisible(boolean captionVisible) Sets caption visibility.
void	setCaptionWidth(java.lang.String captionWidth) Sets the caption width.
void	setParameterName(java.lang.String parameterName) Sets the name of the associated query parameter name.
void	setValueComponent(HasValue<V> valueComponent) Sets the field for editing a property value.

Methods inherited from interface io.jmix.ui.component.FilterComponent

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

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.SupportsCaptionPosition

getCaptionPosition, setCaptionPosition

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Method Detail

getParameterName

java.lang.String getParameterName()

Returns:

the name of the associated query parameter name

setParameterName

@StudioProperty(type=STRING)
void setParameterName(java.lang.String parameterName)

Sets the name of the associated query parameter name.

Parameters:

parameterName - a name of the associated query parameter name

getValueComponent

HasValue<V> getValueComponent()

Returns:

a field for editing a property value

setValueComponent

void setValueComponent(HasValue<V> valueComponent)

Sets the field for editing a property value.

Parameters:

valueComponent - a field for editing a property value

getCaptionWidth

float getCaptionWidth()

Returns:

a caption width value in Component.getWidthSizeUnit()

getCaptionWidthSizeUnit

SizeUnit getCaptionWidthSizeUnit()

Returns:

units used in the caption width property

setCaptionWidth

@StudioProperty(type=SIZE,
                defaultValue="100%")
void setCaptionWidth(java.lang.String captionWidth)

Sets the caption width.

Parameters:

captionWidth - a string width representation

isCaptionVisible

boolean isCaptionVisible()

Returns:

true if caption is visible

setCaptionVisible

@StudioProperty(type=BOOLEAN,
                defaultValue="true")
void setCaptionVisible(boolean captionVisible)

Sets caption visibility. Default value is true.

Parameters:

captionVisible - whether to show caption or not