com.haulmont.cuba.gui.components

Interface PickerField<V extends Entity>

All Superinterfaces:

ActionsHolder, Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, DatasourceComponent<V>, Field<V>, HasCaptionMode, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasOptionCaptionProvider<V>, HasSubParts, HasValue<V>, HasValueSource<V>, LookupComponent, SupportsUserAction<V>, Validatable

All Known Subinterfaces:

LookupPickerField<V>, SearchPickerField<V>, SuggestionPickerField<V>

public interface PickerField<V extends Entity>
extends Field<V>, ActionsHolder, Buffered, LookupComponent, Component.Focusable, HasOptionCaptionProvider<V>, SupportsUserAction<V>, HasCaptionMode

Generic UI component designed to select and display an entity instance. Consists of the text field and the set of buttons defined by actions.

See Also:

PickerField.LookupAction, PickerField.OpenAction, PickerField.ClearAction, LookupPickerField

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PickerField.ActionType Deprecated.
static interface	PickerField.AfterLookupCloseHandler
static interface	PickerField.AfterLookupSelectionHandler
static class	PickerField.ClearAction Action to clear the PickerField content.
static interface	PickerField.FieldListener Deprecated. Use addFieldValueChangeListener(Consumer) instead
static class	PickerField.FieldValueChangeEvent<V extends Entity>
static class	PickerField.LookupAction Action to select an entity instance through the entity lookup screen.
static class	PickerField.OpenAction Action to open an edit screen for entity instance which is currently set in the PickerField.
static interface	PickerField.PickerFieldAction
static class	PickerField.StandardAction

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

Field.Validator<T>

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

HasValue.ValueChangeEvent<V>

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

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

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

HasContextHelp.ContextHelpIconClickEvent

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

LookupComponent.LookupSelectionChangeEvent<T extends Entity>, LookupComponent.LookupSelectionChangeNotifier<T extends Entity>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
PickerField.ClearAction	addClearAction() Deprecated.
default void	addFieldListener(PickerField.FieldListener listener) Deprecated. Use addFieldValueChangeListener(Consumer) instead
com.haulmont.bali.events.Subscription	addFieldValueChangeListener(java.util.function.Consumer<PickerField.FieldValueChangeEvent<V>> listener) Adds a listener that will be fired in case field is editable.
PickerField.LookupAction	addLookupAction() Deprecated.
PickerField.OpenAction	addOpenAction() Deprecated.
default PickerField.ClearAction	getClearAction() Deprecated.
default PickerField.LookupAction	getLookupAction() Deprecated.
com.haulmont.chile.core.model.MetaClass	getMetaClass()
default PickerField.OpenAction	getOpenAction() Deprecated.
static <T extends Entity> com.google.common.reflect.TypeToken<PickerField<T>>	of(java.lang.Class<T> valueClass)
void	setFieldEditable(boolean editable)
void	setMetaClass(com.haulmont.chile.core.model.MetaClass metaClass)

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

addValidator, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage

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

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

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

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, removeValueChangeListener, setValue

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

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

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

isValid, isValidateOnCommit, validate

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

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

isDescriptionAsHtml, setDescriptionAsHtml

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

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

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

commit, discard, isBuffered, isModified, setBuffered

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

getLookupSelectedItems, setLookupSelectHandler

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

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

getOptionCaptionProvider, setOptionCaptionProvider

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

setValueFromUser

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

getCaptionMode, getCaptionProperty, setCaptionMode, setCaptionProperty

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

of

static <T extends Entity> com.google.common.reflect.TypeToken<PickerField<T>> of(java.lang.Class<T> valueClass)

getMetaClass

com.haulmont.chile.core.model.MetaClass getMetaClass()

setMetaClass

void setMetaClass(com.haulmont.chile.core.model.MetaClass metaClass)

addLookupAction

@Deprecated
PickerField.LookupAction addLookupAction()

Deprecated.

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

Returns:

added action

getLookupAction

@Deprecated
default PickerField.LookupAction getLookupAction()

Deprecated.

Returns:

LookupAction instance

Throws:

java.lang.IllegalArgumentException - if the LookupAction does not exist in the component

addClearAction

@Deprecated
PickerField.ClearAction addClearAction()

Deprecated.

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

Returns:

added action

getClearAction

@Deprecated
default PickerField.ClearAction getClearAction()

Deprecated.

Returns:

ClearAction instance

Throws:

java.lang.IllegalArgumentException - if the ClearAction does not exist in the component

addOpenAction

@Deprecated
PickerField.OpenAction addOpenAction()

Deprecated.

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

Returns:

added action

getOpenAction

@Deprecated
default PickerField.OpenAction getOpenAction()

Deprecated.

Returns:

OpenAction instance

Throws:

java.lang.IllegalArgumentException - if the OpenAction does not exist in the component

addFieldListener

@Deprecated
default void addFieldListener(PickerField.FieldListener listener)

Deprecated. Use addFieldValueChangeListener(Consumer) instead

setFieldEditable

void setFieldEditable(boolean editable)

addFieldValueChangeListener

com.haulmont.bali.events.Subscription addFieldValueChangeListener(java.util.function.Consumer<PickerField.FieldValueChangeEvent<V>> listener)

Adds a listener that will be fired in case field is editable.

Parameters:

listener - a listener to add

Returns:

a Subscription object

See Also:

setFieldEditable(boolean)