public class AutoCompletingTextField extends JosmTextField implements javax.swing.ComboBoxEditor, javax.swing.table.TableCellEditor
JTable
s.
Autocompletion is controlled by a list of AutoCompletionListItem
s
managed in a AutoCompletionList
.Modifier and Type | Class and Description |
---|---|
(package private) class |
AutoCompletingTextField.AutoCompletionDocument
The document model for the editor
|
javax.swing.JTextField.AccessibleJTextField
javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding
javax.swing.JComponent.AccessibleJComponent
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 |
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Constructor and Description |
---|
AutoCompletingTextField()
Constructs a new
AutoCompletingTextField . |
AutoCompletingTextField(int columns)
Constructs a new
AutoCompletingTextField . |
AutoCompletingTextField(int columns,
boolean undoRedo)
Constructs a new
AutoCompletingTextField . |
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() |
focusGained, focusLost, getHint, paint, setHint
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
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
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
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
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
private java.lang.Integer maxChars
protected AutoCompletionList autoCompletionList
protected java.lang.String noAutoCompletionString
private transient CellEditorSupport tableCellEditorSupport
private java.lang.String originalValue
public AutoCompletingTextField()
AutoCompletingTextField
.public AutoCompletingTextField(int columns)
AutoCompletingTextField
.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 implementationpublic AutoCompletingTextField(int columns, boolean undoRedo)
AutoCompletingTextField
.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 implementationundoRedo
- Enables or not Undo/Redo feature. Not recommended for table cell editors, unless each cell provides its own editorprotected javax.swing.text.Document createDefaultModel()
createDefaultModel
in class javax.swing.JTextField
protected final void init()
protected void applyFilter(java.lang.String filter)
public AutoCompletionList getAutoCompletionList()
public void setAutoCompletionList(AutoCompletionList autoCompletionList)
autoCompletionList
- the auto completion list; if null, auto completion is
disabledpublic java.awt.Component getEditorComponent()
getEditorComponent
in interface javax.swing.ComboBoxEditor
public java.lang.Object getItem()
getItem
in interface javax.swing.ComboBoxEditor
public void setItem(java.lang.Object anObject)
setItem
in interface javax.swing.ComboBoxEditor
public void setText(java.lang.String t)
setText
in class javax.swing.text.JTextComponent
public void setMaxChars(java.lang.Integer max)
max
- maximum number of characters allowedpublic void addCellEditorListener(javax.swing.event.CellEditorListener l)
addCellEditorListener
in interface javax.swing.CellEditor
protected void rememberOriginalValue(java.lang.String value)
protected void restoreOriginalValue()
public void removeCellEditorListener(javax.swing.event.CellEditorListener l)
removeCellEditorListener
in interface javax.swing.CellEditor
public void cancelCellEditing()
cancelCellEditing
in interface javax.swing.CellEditor
public java.lang.Object getCellEditorValue()
getCellEditorValue
in interface javax.swing.CellEditor
public boolean isCellEditable(java.util.EventObject anEvent)
isCellEditable
in interface javax.swing.CellEditor
public boolean shouldSelectCell(java.util.EventObject anEvent)
shouldSelectCell
in interface javax.swing.CellEditor
public boolean stopCellEditing()
stopCellEditing
in interface javax.swing.CellEditor
public java.awt.Component getTableCellEditorComponent(javax.swing.JTable table, java.lang.Object value, boolean isSelected, int row, int column)
getTableCellEditorComponent
in interface javax.swing.table.TableCellEditor