com.haulmont.cuba.desktop.gui.components

Class DesktopLookupPickerField

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

com.haulmont.cuba.desktop.gui.components.DesktopLookupPickerField

All Implemented Interfaces:

DesktopComponent, com.haulmont.cuba.desktop.sys.vcl.UserSelectionHandler, Component, Component.ActionsHolder, 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, LookupPickerField, OptionsField, PickerField

public class DesktopLookupPickerField
extends DesktopLookupField
implements LookupPickerField

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

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

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

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
DesktopLookupPickerField()

Method Summary

Modifier and Type	Method and Description
void	addAction(Action action) Add an action to the component
void	addAction(Action action, int index) Add an action to the component with index.
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.
Action	getAction(java.lang.String id)
java.util.Collection<Action>	getActions()
javax.swing.JComponent	getComposition()
MetaClass	getMetaClass()
boolean	isRefreshOptionsOnLookupClose()
void	removeAction(Action action) Remove the action from the component
void	removeAction(java.lang.String id) Remove the action by its ID.
void	removeAllActions() Remove all actions from the component
void	setDatasource(Datasource datasource, java.lang.String property) Set datasource and its property.
void	setFieldEditable(boolean editable)
void	setFrame(Frame frame)
void	setMetaClass(MetaClass metaClass)
void	setOptionsDatasource(CollectionDatasource datasource)
void	setRefreshOptionsOnLookupClose(boolean refresh) Use this method to enable items refreshing in component after closing lookup window
void	updateEnabled()

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

addUserSelectionListener, commit, discard, getDescription, getFilterMode, getInputPrompt, getLookupSelectedItems, getNewOptionHandler, getNullOption, getOptionIconProvider, getPageLength, getValue, isBuffered, isModified, isMultiSelect, isNewOptionAllowed, isNullOptionVisible, isTextInputAllowed, removeUserSelectionListener, setBuffered, setCaptionProperty, setDescription, setFilterMode, setInputPrompt, setLookupSelectHandler, setMultiSelect, setNewOptionAllowed, setNewOptionHandler, setNullOption, setNullOptionVisible, setOptionIconProvider, setOptionIconProvider, setOptionsEnum, setOptionsList, setOptionsMap, setPageLength, setTextInputAllowed, setValue, updateMissingValueState

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

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

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, 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.LookupField

getFilterMode, getNewOptionHandler, getNullOption, getOptionIconProvider, getPageLength, isNewOptionAllowed, isNullOptionVisible, isTextInputAllowed, setFilterMode, setNewOptionAllowed, setNewOptionHandler, setNullOption, setNullOptionVisible, setOptionIconProvider, setOptionIconProvider, setPageLength, setTextInputAllowed

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

getCaptionMode, getCaptionProperty, getDescriptionProperty, getOptionsDatasource, getOptionsEnum, getOptionsList, getOptionsMap, isMultiSelect, setCaptionMode, setCaptionProperty, setDescriptionProperty, setMultiSelect, setOptionsEnum, setOptionsList, setOptionsMap

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

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

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

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

getTabIndex, isFocusable, setFocusable, setTabIndex

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

getInputPrompt, setInputPrompt

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

getCaptionMode, getCaptionProperty, getClearAction, getLookupAction, getOpenAction, setCaptionMode, setCaptionProperty

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

getActionNN

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

Constructor Detail

DesktopLookupPickerField

public DesktopLookupPickerField()

Method Detail

getComposition

public javax.swing.JComponent getComposition()

Specified by:

getComposition in interface Component.Wrapper

Overrides:

getComposition in class DesktopLookupField

getMetaClass

public MetaClass getMetaClass()

Specified by:

getMetaClass in interface PickerField

setMetaClass

public void setMetaClass(MetaClass metaClass)

Specified by:

setMetaClass in interface PickerField

addLookupAction

public PickerField.LookupAction addLookupAction()

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

Returns:

added action

addClearAction

public PickerField.ClearAction addClearAction()

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

Returns:

added action

addOpenAction

public PickerField.OpenAction addOpenAction()

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

Returns:

added action

addFieldListener

public void addFieldListener(PickerField.FieldListener listener)

Specified by:

addFieldListener in interface PickerField

setFieldEditable

public void setFieldEditable(boolean editable)

Specified by:

setFieldEditable in interface PickerField

addAction

public void addAction(Action action)

Description copied from interface: Component.ActionsHolder

Add an action to the component

Specified by:

addAction in interface Component.ActionsHolder

addAction

public void addAction(Action action,
                      int index)

Description copied from interface: Component.ActionsHolder

Add an action to the component with index.

Specified by:

addAction in interface Component.ActionsHolder

removeAction

public void removeAction(@Nullable
                         Action action)

Description copied from interface: Component.ActionsHolder

Remove the action from the component

Specified by:

removeAction in interface Component.ActionsHolder

removeAction

public void removeAction(@Nullable
                         java.lang.String id)

Description copied from interface: Component.ActionsHolder

Remove the action by its ID. If there is no action with that ID, nothing happens.

Specified by:

removeAction in interface Component.ActionsHolder

removeAllActions

public void removeAllActions()

Description copied from interface: Component.ActionsHolder

Remove all actions from the component

Specified by:

removeAllActions in interface Component.ActionsHolder

getActions

public java.util.Collection<Action> getActions()

Specified by:

getActions in interface Component.ActionsHolder

Returns:

unmodifiable collection of actions

getAction

@Nullable
public Action getAction(java.lang.String id)

Specified by:

getAction in interface Component.ActionsHolder

Returns:

an action by its ID, or null if not found

setFrame

public void setFrame(Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

Overrides:

setFrame in class DesktopAbstractComponent<javax.swing.JComponent>

setDatasource

public void setDatasource(Datasource datasource,
                          java.lang.String property)

Description copied from interface: DatasourceComponent

Set datasource and its property.

Specified by:

setDatasource in interface DatasourceComponent

Overrides:

setDatasource in class DesktopAbstractOptionsField<javax.swing.JComponent>

setOptionsDatasource

public void setOptionsDatasource(CollectionDatasource datasource)

Specified by:

setOptionsDatasource in interface OptionsField

Overrides:

setOptionsDatasource in class DesktopAbstractOptionsField<javax.swing.JComponent>

updateEnabled

public void updateEnabled()

Overrides:

updateEnabled in class DesktopLookupField

isRefreshOptionsOnLookupClose

public boolean isRefreshOptionsOnLookupClose()

Specified by:

isRefreshOptionsOnLookupClose in interface LookupPickerField

setRefreshOptionsOnLookupClose

public void setRefreshOptionsOnLookupClose(boolean refresh)

Description copied from interface: LookupPickerField

Use this method to enable items refreshing in component after closing lookup window

Specified by:

setRefreshOptionsOnLookupClose in interface LookupPickerField