V
- value typepublic interface PropertyFilter<V> extends SingleFilterComponent<V>
DataLoader
. The component is
related to entity property and can automatically render proper layout for setting a condition value. In general case
a PropertyFilter layout contains a label with entity property caption, operation label or selector (=, contains,
>, etc.) and a field for editing a property value.Modifier and Type | Interface and Description |
---|---|
static class |
PropertyFilter.Operation
Operation representing corresponding filtering condition.
|
static class |
PropertyFilter.OperationChangeEvent
Event sent when the
operation property is changed. |
HasValue.ValueChangeEvent<V>
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper
SupportsCaptionPosition.CaptionPosition
HasContextHelp.ContextHelpIconClickEvent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE
Modifier and Type | Method and Description |
---|---|
io.jmix.core.common.event.Subscription |
addOperationChangeListener(java.util.function.Consumer<PropertyFilter.OperationChangeEvent> listener)
Adds a listener that is invoked when the
operation property changes. |
PropertyFilter.Operation |
getOperation() |
java.lang.String |
getProperty() |
io.jmix.core.querycondition.PropertyCondition |
getQueryCondition() |
boolean |
isOperationCaptionVisible() |
boolean |
isOperationEditable() |
void |
setOperation(PropertyFilter.Operation operation)
Sets a filtering operation.
|
void |
setOperationCaptionVisible(boolean operationCaptionVisible)
Sets whether to show operation caption.
|
void |
setOperationEditable(boolean operationEditable)
Sets whether an operation selector is visible.
|
void |
setProperty(java.lang.String property)
Sets related entity property name.
|
getCaptionWidth, getCaptionWidthSizeUnit, getParameterName, getValueComponent, setCaptionWidth, setParameterName, setValueComponent
apply, getDataLoader, isAutoApply, isConditionModificationDelegated, setAutoApply, setConditionModificationDelegated, setDataLoader
getFrame, setFrame
addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue
getIcon, setIcon, setIconFromSet
focus, getTabIndex, isFocusable, setFocusable, setTabIndex
isEditable, isEditableWithParent, setEditable
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
isCaptionAsHtml, setCaptionAsHtml
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled
getCaptionPosition, setCaptionPosition
getRequiredMessage, isRequired, setRequired, setRequiredMessage
isValid, isValidateOnCommit, validate
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
static final java.lang.String NAME
io.jmix.core.querycondition.PropertyCondition getQueryCondition()
getQueryCondition
in interface FilterComponent
PropertyCondition
related to the current property filterjava.lang.String getProperty()
void setProperty(java.lang.String property)
property
- entity property namePropertyFilter.Operation getOperation()
void setOperation(PropertyFilter.Operation operation)
operation
- a filtering operationboolean isOperationEditable()
void setOperationEditable(boolean operationEditable)
operationEditable
- whether an operation selector is visibleboolean isOperationCaptionVisible()
void setOperationCaptionVisible(boolean operationCaptionVisible)
operationCaptionVisible
- whether to show operation captionio.jmix.core.common.event.Subscription addOperationChangeListener(java.util.function.Consumer<PropertyFilter.OperationChangeEvent> listener)
operation
property changes.listener
- a listener to add