com.haulmont.cuba.gui.components

Interface PickerField

All Superinterfaces:

Component, Component.ActionsHolder, Component.BelongToFrame, Component.Buffered, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasContextHelp, Component.HasIcon, Component.HasValue, Component.Validatable, DatasourceComponent, Field, LookupComponent

All Known Subinterfaces:

LookupPickerField, SearchPickerField, SuggestionPickerField

public interface PickerField
extends Field, Component.ActionsHolder, Component.Buffered, LookupComponent, Component.Focusable

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 Enumerates standard picker action types.
static interface	PickerField.AfterLookupCloseHandler
static interface	PickerField.AfterLookupSelectionHandler
static class	PickerField.ClearAction Action to clear the PickerField content.
static interface	PickerField.FieldListener
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 class	PickerField.StandardAction

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

Field.Validator

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

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

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

LookupComponent.LookupSelectionChangeEvent, LookupComponent.LookupSelectionChangeListener, LookupComponent.LookupSelectionChangeNotifier

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, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
PickerField.ClearAction	addClearAction() Adds ClearAction to the component.
void	addFieldListener(PickerField.FieldListener listener)
PickerField.LookupAction	addLookupAction() Adds LookupAction to the component.
PickerField.OpenAction	addOpenAction() Adds OpenAction to the component.
CaptionMode	getCaptionMode()
java.lang.String	getCaptionProperty()
default PickerField.ClearAction	getClearAction()
default PickerField.LookupAction	getLookupAction()
MetaClass	getMetaClass()
default PickerField.OpenAction	getOpenAction()
void	setCaptionMode(CaptionMode captionMode)
void	setCaptionProperty(java.lang.String captionProperty)
void	setFieldEditable(boolean editable)
void	setMetaClass(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.Component.HasValue

addListener, addValueChangeListener, getValue, removeListener, removeValueChangeListener, setValue

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

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, 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.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.Component.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.Component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

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

Methods inherited from interface com.haulmont.cuba.gui.components.Component.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

getTabIndex, isFocusable, setFocusable, setTabIndex

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getCaptionMode

CaptionMode getCaptionMode()

setCaptionMode

void setCaptionMode(CaptionMode captionMode)

getCaptionProperty

java.lang.String getCaptionProperty()

setCaptionProperty

void setCaptionProperty(java.lang.String captionProperty)

getMetaClass

MetaClass getMetaClass()

setMetaClass

void setMetaClass(MetaClass metaClass)

addLookupAction

PickerField.LookupAction addLookupAction()

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

Returns:

added action

getLookupAction

default PickerField.LookupAction getLookupAction()

Returns:

LookupAction instance

Throws:

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

addClearAction

PickerField.ClearAction addClearAction()

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

Returns:

added action

getClearAction

default PickerField.ClearAction getClearAction()

Returns:

ClearAction instance

Throws:

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

addOpenAction

PickerField.OpenAction addOpenAction()

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

Returns:

added action

getOpenAction

default PickerField.OpenAction getOpenAction()

Returns:

OpenAction instance

Throws:

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

addFieldListener

void addFieldListener(PickerField.FieldListener listener)

setFieldEditable

void setFieldEditable(boolean editable)