org.openstreetmap.josm.gui.tagging.ac

Class AutoCompletingComboBox

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JComboBox<E>

org.openstreetmap.josm.gui.widgets.JosmComboBox<AutoCompletionItem>

org.openstreetmap.josm.gui.tagging.ac.AutoCompletingComboBox

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ListDataListener

Direct Known Subclasses:

HistoryComboBox

public class AutoCompletingComboBox
extends JosmComboBox<AutoCompletionItem>

Auto-completing ComboBox.

Since:

272

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoCompletingComboBox.AutoCompleteListCellRenderer ListCellRenderer for AutoCompletingComboBox renders an AutoCompletionListItem by showing only the string value part
(package private) class	AutoCompletingComboBox.AutoCompletingComboBoxDocument Auto-complete a JosmComboBox.
(package private) static class	AutoCompletingComboBox.InnerFocusListener

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.widgets.JosmComboBox

JosmComboBox.ContextMenuHandler

Nested classes/interfaces inherited from class javax.swing.JComboBox

javax.swing.JComboBox.AccessibleJComboBox, javax.swing.JComboBox.KeySelectionManager

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	autocompleteEnabled
private int	maxTextLength
private java.awt.im.InputContext	privateInputContext
private boolean	useFixedLocale

Fields inherited from class javax.swing.JComboBox

actionCommand, dataModel, editor, isEditable, keySelectionManager, lightWeightPopupEnabled, maximumRowCount, renderer, selectedItemReminder

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
AutoCompletingComboBox() Creates a AutoCompletingComboBox with a default prototype display value.
AutoCompletingComboBox(java.lang.String prototype) Creates a AutoCompletingComboBox with the specified prototype display value.

Method Summary

Modifier and Type	Method and Description
void	configureEditor(javax.swing.ComboBoxEditor cbEditor, java.lang.Object item) Convert the selected item into a String that can be edited in the editor component.
java.awt.im.InputContext	getInputContext()
boolean	isAutocompleteEnabled() Determines if autocompletion is enabled.
void	setAutocompleteEnabled(boolean autocompleteEnabled) Sets whether the autocompletion is enabled
void	setFixedLocale(boolean f) If the locale is fixed, English keyboard layout will be used by default for this combobox all other components can still have different keyboard layout selected
void	setMaxTextLength(int length) Sets the maximum text length.
void	setPossibleAcItems(java.util.Collection<AutoCompletionItem> elems) Sets the items of the combobox to the given AutoCompletionItems.
void	setPossibleItems(java.util.Collection<java.lang.String> elems) Sets the items of the combobox to the given Strings in reversed order (last element first).
void	setPossibleItemsTopDown(java.util.Collection<java.lang.String> elems) Sets the items of the combobox to the given Strings in top down order.
void	setSelectedItem(java.lang.Object item) Selects a given item in the ComboBox model

Methods inherited from class org.openstreetmap.josm.gui.widgets.JosmComboBox

discardAllUndoableEdits, findPrototypeDisplayValue, getEditorComponent, getList, init, init, reinitialize

Methods inherited from class javax.swing.JComboBox

actionPerformed, actionPropertyChanged, addActionListener, addItem, addItemListener, addPopupMenuListener, configurePropertiesFromAction, contentsChanged, createActionPropertyChangeListener, createDefaultKeySelectionManager, fireActionEvent, fireItemStateChanged, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getAction, getActionCommand, getActionListeners, getEditor, getItemAt, getItemCount, getItemListeners, getKeySelectionManager, getMaximumRowCount, getModel, getPopupMenuListeners, getPrototypeDisplayValue, getRenderer, getSelectedIndex, getSelectedItem, getSelectedObjects, getUI, getUIClassID, hidePopup, insertItemAt, installAncestorListener, intervalAdded, intervalRemoved, isEditable, isLightWeightPopupEnabled, isPopupVisible, paramString, processKeyBinding, processKeyEvent, removeActionListener, removeAllItems, removeItem, removeItemAt, removeItemListener, removePopupMenuListener, selectedItemChanged, selectWithKeyChar, setAction, setActionCommand, setEditable, setEditor, setEnabled, setKeySelectionManager, setLightWeightPopupEnabled, setMaximumRowCount, setModel, setPopupVisible, setPrototypeDisplayValue, setRenderer, setSelectedIndex, setUI, showPopup, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

autocompleteEnabled

private boolean autocompleteEnabled

maxTextLength

private int maxTextLength

useFixedLocale

private boolean useFixedLocale

privateInputContext

private final transient java.awt.im.InputContext privateInputContext

Constructor Detail

AutoCompletingComboBox

public AutoCompletingComboBox()

Creates a AutoCompletingComboBox with a default prototype display value.

AutoCompletingComboBox

public AutoCompletingComboBox(java.lang.String prototype)

Creates a AutoCompletingComboBox with the specified prototype display value.

Parameters:

prototype - the Object used to compute the maximum number of elements to be displayed at once before displaying a scroll bar. It also affects the initial width of the combo box.

Since:

5520

Method Detail

setMaxTextLength

public void setMaxTextLength(int length)

Sets the maximum text length.

Parameters:

length - the maximum text length in number of characters

configureEditor

public void configureEditor(javax.swing.ComboBoxEditor cbEditor,
                            java.lang.Object item)

Convert the selected item into a String that can be edited in the editor component.

Overrides:

configureEditor in class javax.swing.JComboBox<AutoCompletionItem>

Parameters:

cbEditor - the editor

item - excepts AutoCompletionListItem, String and null

setSelectedItem

public void setSelectedItem(java.lang.Object item)

Selects a given item in the ComboBox model

Overrides:

setSelectedItem in class javax.swing.JComboBox<AutoCompletionItem>

Parameters:

item - excepts AutoCompletionItem, String and null

setPossibleItems

public void setPossibleItems(java.util.Collection<java.lang.String> elems)

Sets the items of the combobox to the given Strings in reversed order (last element first).

Parameters:

elems - String items

setPossibleItemsTopDown

public void setPossibleItemsTopDown(java.util.Collection<java.lang.String> elems)

Sets the items of the combobox to the given Strings in top down order.

Parameters:

elems - Collection of String items (is not changed)

Since:

15011

setPossibleAcItems

public void setPossibleAcItems(java.util.Collection<AutoCompletionItem> elems)

Sets the items of the combobox to the given AutoCompletionItems.

Parameters:

elems - AutoCompletionItem items

Since:

12859

isAutocompleteEnabled

public final boolean isAutocompleteEnabled()

Determines if autocompletion is enabled.

Returns:

true if autocompletion is enabled, false otherwise.

setAutocompleteEnabled

public void setAutocompleteEnabled(boolean autocompleteEnabled)

Sets whether the autocompletion is enabled

Parameters:

autocompleteEnabled - true to enable autocompletion

Since:

15567 (visibility)

setFixedLocale

public void setFixedLocale(boolean f)

If the locale is fixed, English keyboard layout will be used by default for this combobox all other components can still have different keyboard layout selected

Parameters:

f - fixed locale

getInputContext

public java.awt.im.InputContext getInputContext()

Overrides:

getInputContext in class java.awt.Component