com.haulmont.cuba.desktop.gui.components

Class DesktopLookupField

java.lang.Object

com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent<C>

com.haulmont.cuba.desktop.gui.components.DesktopAbstractField<C>

com.haulmont.cuba.desktop.gui.components.DesktopAbstractOptionsField<javax.swing.JComponent>

com.haulmont.cuba.desktop.gui.components.DesktopLookupField

All Implemented Interfaces:

DesktopComponent, com.haulmont.cuba.desktop.sys.vcl.UserSelectionHandler, Component, Component.BelongToFrame, Component.Buffered, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasIcon, Component.HasInputPrompt, Component.HasValue, Component.HasXmlDescriptor, Component.Validatable, Component.Wrapper, DatasourceComponent, Field, LookupComponent, LookupField, OptionsField

Direct Known Subclasses:

DesktopLookupPickerField

public class DesktopLookupField
extends DesktopAbstractOptionsField<javax.swing.JComponent>
implements LookupField, com.haulmont.cuba.desktop.sys.vcl.UserSelectionHandler

Nested Class Summary

Nested classes/interfaces inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractOptionsField

DesktopAbstractOptionsField.CaptionFormatter<T>, DesktopAbstractOptionsField.EntityWrapper, DesktopAbstractOptionsField.MapKeyWrapper, DesktopAbstractOptionsField.ObjectWrapper, DesktopAbstractOptionsField.ValueWrapper<T>

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

LookupField.FilterMode, LookupField.NewOptionHandler, LookupField.OptionIconProvider<T>

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.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, 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

Nested classes/interfaces inherited from interface com.haulmont.cuba.desktop.sys.vcl.UserSelectionHandler

com.haulmont.cuba.desktop.sys.vcl.UserSelectionHandler.UserSelectionListener

Field Summary

Fields inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent

SWING_PROPERTY_CLASS, SWING_PROPERTY_ID

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

NAME

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

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
DesktopLookupField()

Method Summary

Modifier and Type	Method and Description
void	addUserSelectionListener(com.haulmont.cuba.desktop.sys.vcl.UserSelectionHandler.UserSelectionListener listener)
void	commit() Updates all changes since the previous commit to the data source.
void	discard() Discards all changes since last commit.
javax.swing.JComponent	getComposition()
java.lang.String	getDescription()
LookupField.FilterMode	getFilterMode()
java.lang.String	getInputPrompt()
java.util.Collection	getLookupSelectedItems()
LookupField.NewOptionHandler	getNewOptionHandler()
java.lang.Object	getNullOption()
LookupField.OptionIconProvider<?>	getOptionIconProvider()
int	getPageLength()
<T> T	getValue()
boolean	isBuffered()
boolean	isModified() Tests if the value stored in the object has been modified since it was last updated from the data source.
boolean	isMultiSelect()
boolean	isNewOptionAllowed()
boolean	isNullOptionVisible()
boolean	isTextInputAllowed()
void	removeUserSelectionListener(com.haulmont.cuba.desktop.sys.vcl.UserSelectionHandler.UserSelectionListener listener)
void	setBuffered(boolean buffered) Sets the buffered mode.
void	setCaptionProperty(java.lang.String captionProperty)
void	setDescription(java.lang.String description)
void	setFilterMode(LookupField.FilterMode mode)
void	setInputPrompt(java.lang.String inputPrompt) Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.
void	setLookupSelectHandler(java.lang.Runnable selectHandler)
void	setMultiSelect(boolean multiselect)
void	setNewOptionAllowed(boolean newOptionAllowed) Makes the component handle new options entered by user.
void	setNewOptionHandler(LookupField.NewOptionHandler newOptionHandler) Set handler.
void	setNullOption(java.lang.Object nullOption)
void	setNullOptionVisible(boolean nullOptionVisible) Sets visibility for first null element in suggestion popup.
<T> void	setOptionIconProvider(java.lang.Class<T> optionClass, LookupField.OptionIconProvider<T> optionIconProvider) Set the icon provider for LookupField.
void	setOptionIconProvider(LookupField.OptionIconProvider<?> optionIconProvider) Set the icon provider for the LookupField.
void	setOptionsEnum(java.lang.Class<? extends EnumClass> optionsEnum)
void	setOptionsList(java.util.List optionsList)
void	setOptionsMap(java.util.Map<java.lang.String,?> map)
void	setPageLength(int pageLength) Sets the page length for the suggestion popup.
void	setTextInputAllowed(boolean textInputAllowed) Sets whether it is possible to input text into the field or whether the field area of the component is just used to show what is selected.
void	setValue(java.lang.Object value)
void	updateEnabled()
void	updateMissingValueState()

Methods inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractOptionsField

getCaptionMode, getCaptionProperty, getDatasource, getDescriptionProperty, getMetaProperty, getMetaPropertyPath, getOptionsDatasource, getOptionsEnum, getOptionsList, getOptionsMap, setCaptionFormatter, setCaptionMode, setDatasource, setDescriptionProperty, setOptionsDatasource

Methods inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractField

addListener, addValidator, addValueChangeListener, getRequiredMessage, getValidators, isEditable, isRequired, isValid, removeListener, removeValidator, removeValueChangeListener, setEditable, setParent, setRequired, setRequiredMessage, validate

Methods inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent

addStyleName, assignAutoDebugId, getAlignment, getCaption, getComponent, getDebugId, getFrame, getHeight, getHeightUnits, getIcon, getId, getParent, getStyleName, getTabIndex, getWidth, getWidthUnits, getXmlDescriptor, isComponentVisible, isEnabled, isEnabledItself, isParentEnabled, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setCaption, setContainer, setDebugId, setEnabled, setExpanded, setFrame, setHeight, setIcon, setId, setParentEnabled, setResponsive, setStyleName, setTabIndex, setVisible, setWidth, setXmlDescriptor, unwrap, unwrapComposition

Methods inherited from class java.lang.Object

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

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

getCaptionMode, getCaptionProperty, getDescriptionProperty, getOptionsDatasource, getOptionsEnum, getOptionsList, getOptionsMap, setCaptionMode, setDescriptionProperty, setOptionsDatasource

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, removeListener, removeValueChangeListener

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, setCaption

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

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

getTabIndex, isFocusable, setFocusable, setTabIndex

Constructor Detail

DesktopLookupField

public DesktopLookupField()

Method Detail

getComposition

public javax.swing.JComponent getComposition()

Specified by:

getComposition in interface Component.Wrapper

Overrides:

getComposition in class DesktopAbstractComponent<javax.swing.JComponent>

getNullOption

public java.lang.Object getNullOption()

Specified by:

getNullOption in interface LookupField

setNullOption

public void setNullOption(java.lang.Object nullOption)

Specified by:

setNullOption in interface LookupField

getFilterMode

public LookupField.FilterMode getFilterMode()

Specified by:

getFilterMode in interface LookupField

setFilterMode

public void setFilterMode(LookupField.FilterMode mode)

Specified by:

setFilterMode in interface LookupField

isNewOptionAllowed

public boolean isNewOptionAllowed()

Specified by:

isNewOptionAllowed in interface LookupField

Returns:

true if the component handles new options entered by user.

See Also:

LookupField.NewOptionHandler

setNewOptionAllowed

public void setNewOptionAllowed(boolean newOptionAllowed)

Description copied from interface: LookupField

Makes the component handle new options entered by user.

Specified by:

setNewOptionAllowed in interface LookupField

See Also:

LookupField.NewOptionHandler

isTextInputAllowed

public boolean isTextInputAllowed()

Specified by:

isTextInputAllowed in interface LookupField

Returns:

true if text input allowed

setTextInputAllowed

public void setTextInputAllowed(boolean textInputAllowed)

Description copied from interface: LookupField

Sets whether it is possible to input text into the field or whether the field area of the component is just used to show what is selected.

Specified by:

setTextInputAllowed in interface LookupField

getNewOptionHandler

public LookupField.NewOptionHandler getNewOptionHandler()

Specified by:

getNewOptionHandler in interface LookupField

Returns:

current handler

setNewOptionHandler

public void setNewOptionHandler(LookupField.NewOptionHandler newOptionHandler)

Description copied from interface: LookupField

Set handler.

Specified by:

setNewOptionHandler in interface LookupField

Parameters:

newOptionHandler - handler instance

getPageLength

public int getPageLength()

Specified by:

getPageLength in interface LookupField

Returns:

the page length of the suggestion popup.

setPageLength

public void setPageLength(int pageLength)

Description copied from interface: LookupField

Sets the page length for the suggestion popup. Setting the page length to 0 will disable suggestion popup paging (all items visible).

Specified by:

setPageLength in interface LookupField

Parameters:

pageLength - the pageLength to set

setNullOptionVisible

public void setNullOptionVisible(boolean nullOptionVisible)

Description copied from interface: LookupField

Sets visibility for first null element in suggestion popup.

Specified by:

setNullOptionVisible in interface LookupField

isNullOptionVisible

public boolean isNullOptionVisible()

Specified by:

isNullOptionVisible in interface LookupField

Returns:

true if first null element is visible.

setOptionIconProvider

public void setOptionIconProvider(LookupField.OptionIconProvider<?> optionIconProvider)

Description copied from interface: LookupField

Set the icon provider for the LookupField.

Specified by:

setOptionIconProvider in interface LookupField

Parameters:

optionIconProvider - provider which provides icons for options

setOptionIconProvider

public <T> void setOptionIconProvider(java.lang.Class<T> optionClass,
                                      LookupField.OptionIconProvider<T> optionIconProvider)

Description copied from interface: LookupField

Set the icon provider for LookupField.

Specified by:

setOptionIconProvider in interface LookupField

Parameters:

optionClass - class of the option

optionIconProvider - provider which provides icons for options

getOptionIconProvider

public LookupField.OptionIconProvider<?> getOptionIconProvider()

Specified by:

getOptionIconProvider in interface LookupField

Returns:

icon provider of the LookupField.

getInputPrompt

public java.lang.String getInputPrompt()

Specified by:

getInputPrompt in interface Component.HasInputPrompt

Returns:

current input prompt.

setInputPrompt

public void setInputPrompt(java.lang.String inputPrompt)

Description copied from interface: Component.HasInputPrompt

Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.

Specified by:

setInputPrompt in interface Component.HasInputPrompt

Parameters:

inputPrompt - input prompt

isMultiSelect

public boolean isMultiSelect()

Specified by:

isMultiSelect in interface OptionsField

setMultiSelect

public void setMultiSelect(boolean multiselect)

Specified by:

setMultiSelect in interface OptionsField

setOptionsList

public void setOptionsList(java.util.List optionsList)

Specified by:

setOptionsList in interface OptionsField

Overrides:

setOptionsList in class DesktopAbstractOptionsField<javax.swing.JComponent>

setOptionsMap

public void setOptionsMap(java.util.Map<java.lang.String,?> map)

Specified by:

setOptionsMap in interface OptionsField

Overrides:

setOptionsMap in class DesktopAbstractOptionsField<javax.swing.JComponent>

setOptionsEnum

public void setOptionsEnum(java.lang.Class<? extends EnumClass> optionsEnum)

Specified by:

setOptionsEnum in interface OptionsField

Overrides:

setOptionsEnum in class DesktopAbstractOptionsField<javax.swing.JComponent>

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Component.HasCaption

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in interface Component.HasCaption

updateMissingValueState

public void updateMissingValueState()

Overrides:

updateMissingValueState in class DesktopAbstractField<javax.swing.JComponent>

setValue

public void setValue(java.lang.Object value)

Specified by:

setValue in interface Component.HasValue

Overrides:

setValue in class DesktopAbstractOptionsField<javax.swing.JComponent>

getValue

public <T> T getValue()

Specified by:

getValue in interface Component.HasValue

Overrides:

getValue in class DesktopAbstractOptionsField<javax.swing.JComponent>

updateEnabled

public void updateEnabled()

setCaptionProperty

public void setCaptionProperty(java.lang.String captionProperty)

Specified by:

setCaptionProperty in interface OptionsField

Overrides:

setCaptionProperty in class DesktopAbstractOptionsField<javax.swing.JComponent>

addUserSelectionListener

public void addUserSelectionListener(com.haulmont.cuba.desktop.sys.vcl.UserSelectionHandler.UserSelectionListener listener)

Specified by:

addUserSelectionListener in interface com.haulmont.cuba.desktop.sys.vcl.UserSelectionHandler

removeUserSelectionListener

public void removeUserSelectionListener(com.haulmont.cuba.desktop.sys.vcl.UserSelectionHandler.UserSelectionListener listener)

Specified by:

removeUserSelectionListener in interface com.haulmont.cuba.desktop.sys.vcl.UserSelectionHandler

setLookupSelectHandler

public void setLookupSelectHandler(java.lang.Runnable selectHandler)

Specified by:

setLookupSelectHandler in interface LookupComponent

Parameters:

selectHandler - handler that should be executed when a user select an item in the lookup screen

getLookupSelectedItems

public java.util.Collection getLookupSelectedItems()

Specified by:

getLookupSelectedItems in interface LookupComponent

Returns:

items selected in lookup component

commit

public void commit()

Description copied from interface: Component.Buffered

Updates all changes since the previous commit to the data source.

Specified by:

commit in interface Component.Buffered

discard

public void discard()

Description copied from interface: Component.Buffered

Discards all changes since last commit. The object updates its value from the data source.

Specified by:

discard in interface Component.Buffered

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Component.Buffered

Returns:

true if buffered mode is on, false otherwise

setBuffered

public void setBuffered(boolean buffered)

Description copied from interface: Component.Buffered

Sets the buffered mode.

When in buffered mode, an internal buffer will be used to store changes until Component.Buffered.commit() is called. Calling Component.Buffered.discard() will revert the internal buffer to the value of the data source.

When in non-buffered mode both read and write operations will be done directly on the data source. In this mode the Component.Buffered.commit() and Component.Buffered.discard() methods serve no purpose.

Specified by:

setBuffered in interface Component.Buffered

Parameters:

buffered - true if buffered mode should be turned on, false otherwise

isModified

public boolean isModified()

Description copied from interface: Component.Buffered

Tests if the value stored in the object has been modified since it was last updated from the data source.

Specified by:

isModified in interface Component.Buffered

Returns:

true if the value in the object has been modified since the last data source update, false if not.