org.openstreetmap.josm.gui.tagging.ac

Class AutoCompletingTextField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

org.openstreetmap.josm.gui.widgets.JosmTextField

org.openstreetmap.josm.gui.tagging.ac.AutoCompletingTextField

All Implemented Interfaces:

java.awt.event.FocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.CellEditor, javax.swing.ComboBoxEditor, javax.swing.Scrollable, javax.swing.SwingConstants, javax.swing.table.TableCellEditor, Destroyable

public class AutoCompletingTextField
extends JosmTextField
implements javax.swing.ComboBoxEditor, javax.swing.table.TableCellEditor

AutoCompletingTextField is a text field with autocompletion behaviour. It can be used as table cell editor in JTables. Autocompletion is controlled by a list of AutoCompletionItems managed in a AutoCompletionList.

Since:

1762

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	AutoCompletingTextField.AutoCompletionDocument The document model for the editor

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

javax.swing.JTextField.AccessibleJTextField

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding

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
protected AutoCompletionList	autoCompletionList the auto completion list user input is matched against
private java.lang.Integer	maxChars
protected java.lang.String	noAutoCompletionString a string which should not be auto completed
private java.lang.String	originalValue
private CellEditorSupport	tableCellEditorSupport

Fields inherited from class javax.swing.JTextField

notifyAction

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
AutoCompletingTextField() Constructs a new AutoCompletingTextField.
AutoCompletingTextField(int columns) Constructs a new AutoCompletingTextField.
AutoCompletingTextField(int columns, boolean undoRedo) Constructs a new AutoCompletingTextField.

Method Summary

Modifier and Type	Method and Description
void	addCellEditorListener(javax.swing.event.CellEditorListener l)
protected void	applyFilter(java.lang.String filter)
void	cancelCellEditing()
protected javax.swing.text.Document	createDefaultModel()
AutoCompletionList	getAutoCompletionList() Returns the auto completion list.
java.lang.Object	getCellEditorValue()
java.awt.Component	getEditorComponent()
java.lang.Object	getItem()
java.awt.Component	getTableCellEditorComponent(javax.swing.JTable table, java.lang.Object value, boolean isSelected, int row, int column)
protected void	init()
boolean	isCellEditable(java.util.EventObject anEvent)
protected void	rememberOriginalValue(java.lang.String value)
void	removeCellEditorListener(javax.swing.event.CellEditorListener l)
protected void	restoreOriginalValue()
void	setAutoCompletionList(AutoCompletionList autoCompletionList) Sets the auto completion list.
void	setItem(java.lang.Object anObject)
void	setMaxChars(java.lang.Integer max) Sets the maximum number of characters allowed.
void	setText(java.lang.String t)
boolean	shouldSelectCell(java.util.EventObject anEvent)
boolean	stopCellEditing()

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

destroy, discardAllUndoableEdits, focusGained, focusLost, getHint, paint, setHint

Methods inherited from class javax.swing.JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, setFont, setHorizontalAlignment, setScrollOffset

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, 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, 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, getInputContext, getInputMethodListeners, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, 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

Methods inherited from interface javax.swing.ComboBoxEditor

addActionListener, removeActionListener, selectAll

Field Detail

maxChars

private java.lang.Integer maxChars

autoCompletionList

protected AutoCompletionList autoCompletionList

the auto completion list user input is matched against

noAutoCompletionString

protected java.lang.String noAutoCompletionString

a string which should not be auto completed

tableCellEditorSupport

private transient CellEditorSupport tableCellEditorSupport

originalValue

private java.lang.String originalValue

Constructor Detail

AutoCompletingTextField

public AutoCompletingTextField()

Constructs a new AutoCompletingTextField.

AutoCompletingTextField

public AutoCompletingTextField(int columns)

Constructs a new AutoCompletingTextField.

Parameters:

columns - the number of columns to use to calculate the preferred width; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation

AutoCompletingTextField

public AutoCompletingTextField(int columns,
                               boolean undoRedo)

Constructs a new AutoCompletingTextField.

Parameters:

columns - the number of columns to use to calculate the preferred width; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation

undoRedo - Enables or not Undo/Redo feature. Not recommended for table cell editors, unless each cell provides its own editor

Method Detail

createDefaultModel

protected javax.swing.text.Document createDefaultModel()

Overrides:

createDefaultModel in class javax.swing.JTextField

init

protected final void init()

applyFilter

protected void applyFilter(java.lang.String filter)

getAutoCompletionList

public AutoCompletionList getAutoCompletionList()

Returns the auto completion list.

Returns:

the auto completion list; may be null, if no auto completion list is set

setAutoCompletionList

public void setAutoCompletionList(AutoCompletionList autoCompletionList)

Sets the auto completion list.

Parameters:

autoCompletionList - the auto completion list; if null, auto completion is disabled

getEditorComponent

public java.awt.Component getEditorComponent()

Specified by:

getEditorComponent in interface javax.swing.ComboBoxEditor

getItem

public java.lang.Object getItem()

Specified by:

getItem in interface javax.swing.ComboBoxEditor

setItem

public void setItem(java.lang.Object anObject)

Specified by:

setItem in interface javax.swing.ComboBoxEditor

setText

public void setText(java.lang.String t)

Overrides:

setText in class javax.swing.text.JTextComponent

setMaxChars

public void setMaxChars(java.lang.Integer max)

Sets the maximum number of characters allowed.

Parameters:

max - maximum number of characters allowed

Since:

5579

addCellEditorListener

public void addCellEditorListener(javax.swing.event.CellEditorListener l)

Specified by:

addCellEditorListener in interface javax.swing.CellEditor

rememberOriginalValue

protected void rememberOriginalValue(java.lang.String value)

restoreOriginalValue

protected void restoreOriginalValue()

removeCellEditorListener

public void removeCellEditorListener(javax.swing.event.CellEditorListener l)

Specified by:

removeCellEditorListener in interface javax.swing.CellEditor

cancelCellEditing

public void cancelCellEditing()

Specified by:

cancelCellEditing in interface javax.swing.CellEditor

getCellEditorValue

public java.lang.Object getCellEditorValue()

Specified by:

getCellEditorValue in interface javax.swing.CellEditor

isCellEditable

public boolean isCellEditable(java.util.EventObject anEvent)

Specified by:

isCellEditable in interface javax.swing.CellEditor

shouldSelectCell

public boolean shouldSelectCell(java.util.EventObject anEvent)

Specified by:

shouldSelectCell in interface javax.swing.CellEditor

stopCellEditing

public boolean stopCellEditing()

Specified by:

stopCellEditing in interface javax.swing.CellEditor

getTableCellEditorComponent

public java.awt.Component getTableCellEditorComponent(javax.swing.JTable table,
                                                      java.lang.Object value,
                                                      boolean isSelected,
                                                      int row,
                                                      int column)

Specified by:

getTableCellEditorComponent in interface javax.swing.table.TableCellEditor