com.haulmont.cuba.web.gui.components

Class WebPickerField<V extends io.jmix.core.Entity>

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<T>

io.jmix.ui.component.impl.AbstractValueComponent<T,P,V>

io.jmix.ui.component.impl.AbstractField<io.jmix.ui.widget.JmixPickerField<V>,V,V>

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

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

com.haulmont.cuba.web.gui.components.WebPickerField<V>

All Implemented Interfaces:

DatasourceComponent<V>, HasCaptionMode, PickerField<V>, io.jmix.ui.component.ActionsHolder, io.jmix.ui.component.AttachNotifier, io.jmix.ui.component.Buffered, io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper, io.jmix.ui.component.data.HasValueSource<V>, io.jmix.ui.component.EntityPicker<V>, io.jmix.ui.component.Field<V>, io.jmix.ui.component.HasContextHelp, io.jmix.ui.component.HasDebugId, io.jmix.ui.component.HasFormatter<V>, io.jmix.ui.component.HasHtmlCaption, io.jmix.ui.component.HasHtmlDescription, io.jmix.ui.component.HasHtmlSanitizer, io.jmix.ui.component.HasOptionCaptionProvider<V>, io.jmix.ui.component.HasOptionIconProvider<V>, io.jmix.ui.component.HasSubParts, io.jmix.ui.component.HasValidator<V>, io.jmix.ui.component.HasValue<V>, io.jmix.ui.component.LookupComponent<V>, io.jmix.ui.component.Requirable, io.jmix.ui.component.SecuredActionsHolder, io.jmix.ui.component.SupportsUserAction<V>, io.jmix.ui.component.Validatable, io.jmix.ui.component.ValuePicker<V>, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

WebSearchPickerField

public class WebPickerField<V extends io.jmix.core.Entity>
extends io.jmix.ui.component.impl.EntityPickerImpl<V>
implements PickerField<V>

Nested Class Summary

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

io.jmix.ui.component.impl.ValuePickerImpl.WebValuePickerActionHandler

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.PickerField

PickerField.ActionType, PickerField.AfterLookupCloseHandler, PickerField.AfterLookupSelectionHandler, PickerField.ClearAction, PickerField.FieldListener, PickerField.LookupAction, PickerField.OpenAction, PickerField.PickerFieldAction, PickerField.StandardAction

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Field

Field.Validator<T>

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

io.jmix.ui.component.EntityPicker.EntityPickerAction

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

io.jmix.ui.component.ValuePicker.FieldValueChangeEvent<V>, io.jmix.ui.component.ValuePicker.ValuePickerAction

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

io.jmix.ui.component.HasValue.ValueChangeEvent<V>

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

io.jmix.ui.component.Component.Alignment, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Disposable, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper

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

io.jmix.ui.component.HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.LookupComponent

LookupComponent.LookupSelectionChangeNotifier<T>

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

io.jmix.ui.component.LookupComponent.LookupSelectionChangeEvent<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Function<? super V,java.lang.String>	iconProvider
protected java.util.function.Function<? super V,java.lang.String>	optionCaptionProvider

Fields inherited from class io.jmix.ui.component.impl.EntityPickerImpl

metaClass, metadata

Fields inherited from class io.jmix.ui.component.impl.ValuePickerImpl

actionButtons, actionHandler, actionPropertyChangeListener, actions, actionsPermissions, fieldIconProvider, fieldListenerRegistration, formatter, metadataTools

Fields inherited from class io.jmix.ui.component.impl.AbstractField

editable, parentEditableChangeListener, validators, VALIDATORS_LIST_INITIAL_CAPACITY

Fields inherited from class io.jmix.ui.component.impl.AbstractValueComponent

internalValue, uiTestIdsSupport, valueBinding

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

Fields inherited from interface com.haulmont.cuba.gui.components.PickerField

NAME

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

TYPE_STRING

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
WebPickerField()

Method Summary

Modifier and Type	Method and Description
PickerField.ClearAction	addClearAction() Deprecated.
PickerField.LookupAction	addLookupAction() Deprecated.
PickerField.OpenAction	addOpenAction() Deprecated.
void	addValidator(java.util.function.Consumer<? super V> validator)
protected java.lang.String	formatValue(V value)
protected com.vaadin.server.Resource	generateOptionIcon(V item)
java.util.function.Function<? super V,java.lang.String>	getFieldIconProvider()
java.util.function.Function<? super V,java.lang.String>	getOptionCaptionProvider()
java.util.function.Function<? super V,java.lang.String>	getOptionIconProvider()
void	removeValidator(java.util.function.Consumer<V> validator)
void	setFieldIconProvider(java.util.function.Function<? super V,java.lang.String> iconProvider)
void	setOptionCaptionProvider(java.util.function.Function<? super V,java.lang.String> optionCaptionProvider)
void	setOptionIconProvider(java.util.function.Function<? super V,java.lang.String> optionIconProvider)

Methods inherited from class io.jmix.ui.component.impl.EntityPickerImpl

checkValueType, createComponent, getLookupSelectedItems, getMetaClass, setLookupSelectHandler, setMetaClass, setMetadata, setValue, setValueFromUser

Methods inherited from class io.jmix.ui.component.impl.ValuePickerImpl

actionPropertyChanged, addAction, addAction, addFieldValueChangeListener, afterPropertiesSet, applyDefaultValueFormat, commit, discard, focus, getAction, getActions, getActionsPermissions, getFormatter, getTabIndex, initComponent, isBuffered, isFieldEditable, isModified, onFieldValueChange, refreshActionsState, removeAction, removeAction, removeAllActions, setBuffered, setButtonIcon, setDebugId, setEditableToComponent, setFieldEditable, setFormatter, setFrame, setMetadataTools, setTabIndex, setUiComponentProperties, setupButtonAction

Methods inherited from class io.jmix.ui.component.impl.AbstractField

addValidator, attachValueChangeListener, getDatatypeConversionErrorMsg, getErrorMessage, getRequiredMessage, getValidators, isEditable, isRequired, isValid, removeValidator, setEditable, setParent, setRequired, setRequiredMessage, setupComponentErrorProvider, triggerValidators, validate

Methods inherited from class io.jmix.ui.component.impl.AbstractValueComponent

addValueChangeListener, componentValueChanged, convertToModel, convertToPresentation, fieldValueEquals, getValue, getValueSource, setUiTestId, setUiTestIdsSupport, setValueSource, setValueToPresentation, valueBindingActivated, valueBindingConnected

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDescription, setDescriptionAsHtml, setEnabled, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.haulmont.cuba.gui.components.PickerField

addFieldListener, getClearAction, getLookupAction, getOpenAction, of

Methods inherited from interface com.haulmont.cuba.gui.components.Field

addValidators, getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

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

getMetaClass, setMetaClass

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

addFieldValueChangeListener, isFieldEditable, setFieldEditable

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

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

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

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

isEditable, isEditableWithParent, setEditable

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

getFrame, setFrame

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

isValid, isValidateOnCommit, validate

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

getIcon, setIcon, setIconFromSet

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

addValidator, addValidators, getValidators, removeValidator

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

getRequiredMessage, isRequired, setRequired, setRequiredMessage

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

getFormatter, setFormatter

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

addAction, addAction, getAction, getActionNN, getActions, getSubPart, removeAction, removeAction, removeAllActions

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

commit, discard, isBuffered, isModified, setBuffered

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

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

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

setValueFromUser

Methods inherited from interface com.haulmont.cuba.gui.components.HasCaptionMode

getCaptionMode, getCaptionProperty, setCaptionMode, setCaptionProperty

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

getLookupSelectedItems, setLookupSelectHandler

Field Detail

optionCaptionProvider

protected java.util.function.Function<? super V extends io.jmix.core.Entity,java.lang.String> optionCaptionProvider

iconProvider

protected java.util.function.Function<? super V extends io.jmix.core.Entity,java.lang.String> iconProvider

Constructor Detail

WebPickerField

public WebPickerField()

Method Detail

addLookupAction

@Deprecated
public PickerField.LookupAction addLookupAction()

Deprecated.

Description copied from interface: PickerField

Adds LookupAction to the component. If the LookupAction already exists, it will be replaced with the new instance.

Specified by:

addLookupAction in interface PickerField<V extends io.jmix.core.Entity>

Returns:

added action

addClearAction

@Deprecated
public PickerField.ClearAction addClearAction()

Deprecated.

Description copied from interface: PickerField

Adds ClearAction to the component. If the ClearAction already exists, it will be replaced with the new instance.

Specified by:

addClearAction in interface PickerField<V extends io.jmix.core.Entity>

Returns:

added action

addOpenAction

@Deprecated
public PickerField.OpenAction addOpenAction()

Deprecated.

Description copied from interface: PickerField

Adds OpenAction to the component. If the OpenAction already exists, it will be replaced with the new instance.

Specified by:

addOpenAction in interface PickerField<V extends io.jmix.core.Entity>

Returns:

added action

addValidator

public void addValidator(java.util.function.Consumer<? super V> validator)

removeValidator

public void removeValidator(java.util.function.Consumer<V> validator)

formatValue

protected java.lang.String formatValue(@Nullable
                                       V value)

Overrides:

formatValue in class io.jmix.ui.component.impl.ValuePickerImpl<V extends io.jmix.core.Entity>

setOptionCaptionProvider

public void setOptionCaptionProvider(java.util.function.Function<? super V,java.lang.String> optionCaptionProvider)

Specified by:

setOptionCaptionProvider in interface io.jmix.ui.component.HasOptionCaptionProvider<V extends io.jmix.core.Entity>

getOptionCaptionProvider

public java.util.function.Function<? super V,java.lang.String> getOptionCaptionProvider()

Specified by:

getOptionCaptionProvider in interface io.jmix.ui.component.HasOptionCaptionProvider<V extends io.jmix.core.Entity>

setOptionIconProvider

public void setOptionIconProvider(java.util.function.Function<? super V,java.lang.String> optionIconProvider)

Specified by:

setOptionIconProvider in interface io.jmix.ui.component.HasOptionIconProvider<V extends io.jmix.core.Entity>

generateOptionIcon

protected com.vaadin.server.Resource generateOptionIcon(V item)

Overrides:

generateOptionIcon in class io.jmix.ui.component.impl.ValuePickerImpl<V extends io.jmix.core.Entity>

getOptionIconProvider

public java.util.function.Function<? super V,java.lang.String> getOptionIconProvider()

Specified by:

getOptionIconProvider in interface io.jmix.ui.component.HasOptionIconProvider<V extends io.jmix.core.Entity>

setFieldIconProvider

public void setFieldIconProvider(@Nullable
                                 java.util.function.Function<? super V,java.lang.String> iconProvider)

Specified by:

setFieldIconProvider in interface io.jmix.ui.component.ValuePicker<V extends io.jmix.core.Entity>

Overrides:

setFieldIconProvider in class io.jmix.ui.component.impl.ValuePickerImpl<V extends io.jmix.core.Entity>

getFieldIconProvider

@Nullable
public java.util.function.Function<? super V,java.lang.String> getFieldIconProvider()

Specified by:

getFieldIconProvider in interface io.jmix.ui.component.ValuePicker<V extends io.jmix.core.Entity>

Overrides:

getFieldIconProvider in class io.jmix.ui.component.impl.ValuePickerImpl<V extends io.jmix.core.Entity>