Package io.jmix.ui.component.impl

Class AbstractSingleFilterComponent<V>

java.lang.Object

io.jmix.ui.component.CompositeComponent<HBoxLayout>

io.jmix.ui.component.impl.AbstractSingleFilterComponent<V>

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, CompositeWithCaption, CompositeWithDescription, CompositeWithHtmlCaption, CompositeWithHtmlDescription, FilterComponent, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValue<V>, Requirable, SingleFilterComponent<V>, SupportsCaptionPosition, Validatable

Direct Known Subclasses:

FullTextFilterImpl, JpqlFilterImpl, PropertyFilterImpl

public abstract class AbstractSingleFilterComponent<V>
extends CompositeComponent<HBoxLayout>
implements SingleFilterComponent<V>, CompositeWithHtmlCaption, CompositeWithHtmlDescription

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.component.CompositeComponent

CompositeComponent.CreateEvent

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.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

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

HasValue.ValueChangeEvent<V>

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

SupportsCaptionPosition.CaptionPosition

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	autoApply
protected String	caption
protected Label<String>	captionLabel
protected SupportsCaptionPosition.CaptionPosition	captionPosition
protected boolean	captionVisible
protected String	captionWidth
protected boolean	conditionModificationDelegated
protected DataLoader	dataLoader
protected String	icon
protected Condition	queryCondition
protected UiComponents	uiComponents
protected HasValue<V>	valueComponent

Fields inherited from class io.jmix.ui.component.CompositeComponent

applicationContext, frame, id, prefixId, root

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor	Description
AbstractSingleFilterComponent()

Method Summary

Modifier and Type	Method	Description
Subscription	addValueChangeListener(Consumer<HasValue.ValueChangeEvent<V>> listener)
void	apply()	Applies the current filter component condition.
protected void	checkValueComponentState()
protected Label<String>	createCaptionLabel()
protected abstract Condition	createQueryCondition()
protected HBoxLayout	createRootComponent()
void	focus()	Sets focus to this component
String	getCaption()
SupportsCaptionPosition.CaptionPosition	getCaptionPosition()
float	getCaptionWidth()
SizeUnit	getCaptionWidthSizeUnit()
protected Component.Alignment	getChildAlignment()
Consumer<HasContextHelp.ContextHelpIconClickEvent>	getContextHelpIconClickHandler()
String	getContextHelpText()
DataLoader	getDataLoader()
String	getIcon()	Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
protected String	getIconName(Icons.Icon icon)
abstract String	getInnerComponentPrefix()
Condition	getQueryCondition()
String	getRequiredMessage()
int	getTabIndex()	Gets the tabulator index of the HasTabIndex component.
V	getValue()
HasValue<V>	getValueComponent()
protected void	initRootComponent(HBoxLayout root)
protected void	initValueComponent(HasValue<V> valueComponent)
boolean	isAutoApply()
boolean	isCaptionVisible()
boolean	isConditionModificationDelegated()
boolean	isContextHelpTextHtmlEnabled()
boolean	isEditable()
boolean	isRequired()
boolean	isValid()
protected void	onCreate(CompositeComponent.CreateEvent createEvent)
protected void	onValueChanged(HasValue.ValueChangeEvent<V> valueChangeEvent)
void	setAutoApply(boolean autoApply)	Sets whether the filter component should be automatically applied to the DataLoader when the value component value is changed.
void	setCaption(String caption)	Sets the component's caption.
void	setCaptionAsHtml(boolean captionAsHtml)	Sets whether the caption is rendered as HTML.
void	setCaptionPosition(SupportsCaptionPosition.CaptionPosition captionPosition)	Sets position of component caption.
void	setCaptionVisible(boolean captionVisible)	Sets caption visibility.
void	setCaptionWidth(String captionWidth)	Sets the caption width.
void	setConditionModificationDelegated(boolean conditionModificationDelegated)	Sets whether the modification of DataLoader condition is delegated to the owner FilterComponent or Filter.
void	setContextHelpIconClickHandler(Consumer<HasContextHelp.ContextHelpIconClickEvent> handler)	Sets a context help icon click handler.
void	setContextHelpText(String contextHelpText)	Sets context help text.
void	setContextHelpTextHtmlEnabled(boolean enabled)	Defines if context help text can be presented as HTML.
void	setDataLoader(DataLoader dataLoader)	Sets a DataLoader related to the current filter component.
void	setEditable(boolean editable)
void	setIcon(String icon)	Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
void	setIconFromSet(Icons.Icon icon)	Set an icon from an icon set.
void	setRequired(boolean required)	Sets whether the component must contain a non-null value.
void	setRequiredMessage(String msg)	Sets a message that will be displayed to user if the field is required but has null value.
void	setTabIndex(int tabIndex)	Sets the tabulator index of the Focusable component.
void	setUiComponentProperties(UiComponentProperties componentProperties)
void	setUiComponents(UiComponents uiComponents)
protected void	setupLoaderFirstResult()
void	setValue(V value)
void	setValueComponent(HasValue<V> valueComponent)	Sets the field for editing a property value.
void	setWidth(String width)	Set component width in Component.getWidthSizeUnit()}
protected void	updateCaption(String caption)
protected void	updateCaptionLayout()
protected void	updateChildAlignment()
protected void	updateDataLoaderCondition()
protected void	updateIcon()
protected abstract void	updateQueryCondition(V newValue)
void	validate()

Methods inherited from class io.jmix.ui.component.CompositeComponent

addAttachListener, addCreateListener, addDetachListener, addStyleName, assignDebugId, attached, detached, disableEventListeners, enableEventListeners, getAlignment, getComposition, getCompositionOrNull, getDebugId, getEventHub, getFrame, getFullId, getHeight, getHeightSizeUnit, getId, getInnerComponent, getInnerComponentOptional, getParent, getPrefixId, getStyleName, getUiEventListeners, getWidth, getWidthSizeUnit, hasSubscriptions, isAttached, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, publish, removeStyleName, setAlignment, setApplicationContext, setComposition, setDebugId, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setId, setParent, setResponsive, setStyleName, setUiEventListeners, setVisible, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, updateComponentIds, updateIdIfNeeded, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

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, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

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

getFrame, setFrame

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

isEditableWithParent

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

isFocusable, setFocusable

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

getDescription, setDescription

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

isCaptionAsHtml

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

isDescriptionAsHtml, setDescriptionAsHtml

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

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

clear, getEmptyValue, isEmpty

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

getParameterName, setParameterName

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

isValidateOnCommit

Field Details

uiComponents

protected UiComponents uiComponents

captionLabel

protected Label<String> captionLabel

valueComponent

protected HasValue<V> valueComponent

dataLoader

protected DataLoader dataLoader

autoApply

protected boolean autoApply

queryCondition

protected Condition queryCondition

captionVisible

protected boolean captionVisible

conditionModificationDelegated

protected boolean conditionModificationDelegated

caption

protected String caption

captionWidth

protected String captionWidth

icon

protected String icon

captionPosition

protected SupportsCaptionPosition.CaptionPosition captionPosition

Constructor Details

AbstractSingleFilterComponent

public AbstractSingleFilterComponent()

Method Details

setUiComponents

@Autowired
public void setUiComponents(UiComponents uiComponents)

setUiComponentProperties

@Autowired
public void setUiComponentProperties(UiComponentProperties componentProperties)

onCreate

protected void onCreate(CompositeComponent.CreateEvent createEvent)

createRootComponent

protected HBoxLayout createRootComponent()

createQueryCondition

protected abstract Condition createQueryCondition()

initRootComponent

protected void initRootComponent(HBoxLayout root)

createCaptionLabel

protected Label<String> createCaptionLabel()

getInnerComponentPrefix

public abstract String getInnerComponentPrefix()

getDataLoader

public DataLoader getDataLoader()

Specified by:

getDataLoader in interface FilterComponent

Returns:

a DataLoader related to the current filter component

setDataLoader

public void setDataLoader(DataLoader dataLoader)

Description copied from interface: FilterComponent

Sets a DataLoader related to the current filter component.

Specified by:

setDataLoader in interface FilterComponent

Parameters:

dataLoader - a DataLoader to set

updateDataLoaderCondition

protected void updateDataLoaderCondition()

isAutoApply

public boolean isAutoApply()

Specified by:

isAutoApply in interface FilterComponent

Returns:

true if the filter component should be automatically applied to the DataLoader when the value component value is changed

setAutoApply

public void setAutoApply(boolean autoApply)

Description copied from interface: FilterComponent

Sets whether the filter component should be automatically applied to the DataLoader when the value component value is changed.

Specified by:

setAutoApply in interface FilterComponent

Parameters:

autoApply - true if the filter component should be automatically applied to the DataLoader when the value component value is changed

isConditionModificationDelegated

public boolean isConditionModificationDelegated()

Specified by:

isConditionModificationDelegated in interface FilterComponent

Returns:

true if the filter component is located inside the Filter or LogicalFilterComponent and the modification of DataLoader condition is delegated to the owner FilterComponent or Filter, false otherwise

setConditionModificationDelegated

public void setConditionModificationDelegated(boolean conditionModificationDelegated)

Description copied from interface: FilterComponent

Sets whether the modification of DataLoader condition is delegated to the owner FilterComponent or Filter.

Specified by:

setConditionModificationDelegated in interface FilterComponent

Parameters:

conditionModificationDelegated - true if the filter component is located inside the Filter or LogicalFilterComponent and the modification of DataLoader condition is delegated to the owner FilterComponent or Filter, false otherwise

getQueryCondition

public Condition getQueryCondition()

Specified by:

getQueryCondition in interface FilterComponent

Returns:

a Condition related to the current filter component

getCaptionPosition

public SupportsCaptionPosition.CaptionPosition getCaptionPosition()

Specified by:

getCaptionPosition in interface SupportsCaptionPosition

Returns:

position of component caption

setCaptionPosition

public void setCaptionPosition(SupportsCaptionPosition.CaptionPosition captionPosition)

Description copied from interface: SupportsCaptionPosition

Sets position of component caption.

Specified by:

setCaptionPosition in interface SupportsCaptionPosition

Parameters:

captionPosition - component caption position

updateCaptionLayout

protected void updateCaptionLayout()

updateChildAlignment

protected void updateChildAlignment()

getChildAlignment

protected Component.Alignment getChildAlignment()

getCaption

@Nullable
public String getCaption()

Specified by:

getCaption in interface Component.HasCaption

Specified by:

getCaption in interface CompositeWithCaption

Returns:

the caption of the component

setCaption

public void setCaption(@Nullable
 String caption)

Description copied from interface: Component.HasCaption

Sets the component's caption.

Specified by:

setCaption in interface Component.HasCaption

Specified by:

setCaption in interface CompositeWithCaption

Parameters:

caption - the new component's caption

updateCaption

protected void updateCaption(@Nullable
 String caption)

setCaptionAsHtml

public void setCaptionAsHtml(boolean captionAsHtml)

Description copied from interface: HasHtmlCaption

Sets whether the caption is rendered as HTML.

Specified by:

setCaptionAsHtml in interface CompositeWithHtmlCaption

Specified by:

setCaptionAsHtml in interface HasHtmlCaption

Parameters:

captionAsHtml - true if the caption is rendered as HTML, false if rendered as plain text

See Also:

• Component.HasCaption.setCaption(String)

getCaptionWidth

public float getCaptionWidth()

Specified by:

getCaptionWidth in interface SingleFilterComponent<V>

Returns:

a caption width value in Component.getWidthSizeUnit()

getCaptionWidthSizeUnit

public SizeUnit getCaptionWidthSizeUnit()

Specified by:

getCaptionWidthSizeUnit in interface SingleFilterComponent<V>

Returns:

units used in the caption width property

setCaptionWidth

public void setCaptionWidth(String captionWidth)

Description copied from interface: SingleFilterComponent

Sets the caption width.

Specified by:

setCaptionWidth in interface SingleFilterComponent<V>

Parameters:

captionWidth - a string width representation

isCaptionVisible

public boolean isCaptionVisible()

Specified by:

isCaptionVisible in interface SingleFilterComponent<V>

Returns:

true if caption is visible

setCaptionVisible

public void setCaptionVisible(boolean captionVisible)

Description copied from interface: SingleFilterComponent

Sets caption visibility. Default value is true.

Specified by:

setCaptionVisible in interface SingleFilterComponent<V>

Parameters:

captionVisible - whether to show caption or not

setWidth

public void setWidth(@Nullable
 String width)

Description copied from interface: Component

Set component width in Component.getWidthSizeUnit()}

Specified by:

setWidth in interface Component

Overrides:

setWidth in class CompositeComponent<HBoxLayout>

getValueComponent

public HasValue<V> getValueComponent()

Specified by:

getValueComponent in interface SingleFilterComponent<V>

Returns:

a field for editing a property value

setValueComponent

public void setValueComponent(HasValue<V> valueComponent)

Description copied from interface: SingleFilterComponent

Sets the field for editing a property value.

Specified by:

setValueComponent in interface SingleFilterComponent<V>

Parameters:

valueComponent - a field for editing a property value

initValueComponent

protected void initValueComponent(HasValue<V> valueComponent)

onValueChanged

protected void onValueChanged(HasValue.ValueChangeEvent<V> valueChangeEvent)

apply

public void apply()

Description copied from interface: FilterComponent

Applies the current filter component condition.

Specified by:

apply in interface FilterComponent

updateQueryCondition

protected abstract void updateQueryCondition(@Nullable
 V newValue)

getValue

@Nullable
public V getValue()

Specified by:

getValue in interface HasValue<V>

setValue

public void setValue(@Nullable
 V value)

Specified by:

setValue in interface HasValue<V>

checkValueComponentState

protected void checkValueComponentState()

addValueChangeListener

public Subscription addValueChangeListener(Consumer<HasValue.ValueChangeEvent<V>> listener)

Specified by:

addValueChangeListener in interface HasValue<V>

getIcon

@Nullable
public String getIcon()

Description copied from interface: Component.HasIcon

Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

getIcon in interface Component.HasIcon

setIcon

public void setIcon(@Nullable
 String icon)

Description copied from interface: Component.HasIcon

Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

setIcon in interface Component.HasIcon

updateIcon

protected void updateIcon()

setIconFromSet

public void setIconFromSet(@Nullable
 Icons.Icon icon)

Description copied from interface: Component.HasIcon

Set an icon from an icon set.

Specified by:

setIconFromSet in interface Component.HasIcon

getIconName

@Nullable
protected String getIconName(@Nullable
 Icons.Icon icon)

isEditable

public boolean isEditable()

Specified by:

isEditable in interface Component.Editable

setEditable

public void setEditable(boolean editable)

Specified by:

setEditable in interface Component.Editable

focus

public void focus()

Description copied from interface: Component.Focusable

Sets focus to this component

Specified by:

focus in interface Component.Focusable

getTabIndex

public int getTabIndex()

Description copied from interface: Component.Focusable

Gets the tabulator index of the HasTabIndex component.

Specified by:

getTabIndex in interface Component.Focusable

Returns:

tab index set for the HasTabIndex component

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from interface: Component.Focusable

Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.

Specified by:

setTabIndex in interface Component.Focusable

Parameters:

tabIndex - tab index

getContextHelpText

@Nullable
public String getContextHelpText()

Specified by:

getContextHelpText in interface HasContextHelp

Returns:

context help text

setContextHelpText

public void setContextHelpText(@Nullable
 String contextHelpText)

Description copied from interface: HasContextHelp

Sets context help text. If set, then a special icon will be added for a field.

Specified by:

setContextHelpText in interface HasContextHelp

Parameters:

contextHelpText - context help text to be set

isContextHelpTextHtmlEnabled

public boolean isContextHelpTextHtmlEnabled()

Specified by:

isContextHelpTextHtmlEnabled in interface HasContextHelp

Returns:

true if field accepts context help text in HTML format, false otherwise

setContextHelpTextHtmlEnabled

public void setContextHelpTextHtmlEnabled(boolean enabled)

Description copied from interface: HasContextHelp

Defines if context help text can be presented as HTML.

Specified by:

setContextHelpTextHtmlEnabled in interface HasContextHelp

Parameters:

enabled - true if field accepts context help text in HTML format, false otherwise

getContextHelpIconClickHandler

@Nullable
public Consumer<HasContextHelp.ContextHelpIconClickEvent> getContextHelpIconClickHandler()

Specified by:

getContextHelpIconClickHandler in interface HasContextHelp

Returns:

a context help icon click handler

setContextHelpIconClickHandler

public void setContextHelpIconClickHandler(@Nullable
 Consumer<HasContextHelp.ContextHelpIconClickEvent> handler)

Description copied from interface: HasContextHelp

Sets a context help icon click handler. If set, then a special icon will be added for a field. Click handler has priority over context help text, i.e. no tooltip with context help text will be shown if click listener is set.

Specified by:

setContextHelpIconClickHandler in interface HasContextHelp

Parameters:

handler - the handler to set

isRequired

public boolean isRequired()

Specified by:

isRequired in interface Requirable

Returns:

whether the component must contain a non-null value

setRequired

public void setRequired(boolean required)

Description copied from interface: Requirable

Sets whether the component must contain a non-null value.

Specified by:

setRequired in interface Requirable

Parameters:

required - required

getRequiredMessage

@Nullable
public String getRequiredMessage()

Specified by:

getRequiredMessage in interface Requirable

Returns:

a message that will be displayed to user if the component is required but has null value

setRequiredMessage

public void setRequiredMessage(@Nullable
 String msg)

Description copied from interface: Requirable

Sets a message that will be displayed to user if the field is required but has null value.

Specified by:

setRequiredMessage in interface Requirable

Parameters:

msg - message

isValid

public boolean isValid()

Specified by:

isValid in interface Validatable

validate

public void validate()
              throws ValidationException

Specified by:

validate in interface Validatable

Throws:

ValidationException

setupLoaderFirstResult

protected void setupLoaderFirstResult()