org.openstreetmap.josm.gui.tagging

Class TagTable

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTable

org.openstreetmap.josm.gui.widgets.JosmTable

org.openstreetmap.josm.gui.tagging.TagTable

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.CellEditorListener, javax.swing.event.ListSelectionListener, javax.swing.event.RowSorterListener, javax.swing.event.TableColumnModelListener, javax.swing.event.TableModelListener, javax.swing.Scrollable

public class TagTable
extends JosmTable

This is the tabular editor component for OSM tags.

Since:

1762

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	TagTable.AddAction Action to be run when the user adds a new tag.
(package private) class	TagTable.CellEditorRemover This is a custom implementation of the CellEditorRemover used in JTable to handle the client property terminateEditOnFocusLost.
(package private) class	TagTable.DeleteAction Action to be run when the user invokes a delete action on the table, for instance by pressing DEL.
(package private) class	TagTable.PasteAction Action to be run when the user wants to paste tags from buffer
(package private) class	TagTable.SelectNextColumnCellAction Action to be run when the user navigates to the next cell in the table, for instance by pressing TAB or ENTER.
(package private) class	TagTable.SelectPreviousColumnCellAction Action to be run when the user navigates to the previous cell in the table, for instance by pressing Shift-TAB

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

javax.swing.JTable.AccessibleJTable, javax.swing.JTable.DropLocation, javax.swing.JTable.PrintMode

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 TagTable.AddAction	addAction the add action
private TagTable.DeleteAction	deleteAction the delete action
private java.util.concurrent.CopyOnWriteArrayList<java.awt.Component>	doNotStopCellEditingWhenFocused a list of components to which focus can be transferred without stopping cell editing this table.
private TagCellEditor	editor the table cell editor used by this table
private TagTable.CellEditorRemover	editorRemover
private TagEditorModel	model
private java.awt.Component	nextFocusComponent
private TagTable.PasteAction	pasteAction the tag paste action

Fields inherited from class org.openstreetmap.josm.gui.widgets.JosmTable

selectNextColumnCellAction, selectPreviousColumnCellAction

Fields inherited from class javax.swing.JTable

AUTO_RESIZE_ALL_COLUMNS, AUTO_RESIZE_LAST_COLUMN, AUTO_RESIZE_NEXT_COLUMN, AUTO_RESIZE_OFF, AUTO_RESIZE_SUBSEQUENT_COLUMNS, autoCreateColumnsFromModel, autoResizeMode, cellEditor, cellSelectionEnabled, columnModel, dataModel, defaultEditorsByColumnClass, defaultRenderersByColumnClass, editingColumn, editingRow, editorComp, gridColor, preferredViewportSize, rowHeight, rowMargin, rowSelectionAllowed, selectionBackground, selectionForeground, selectionModel, showHorizontalLines, showVerticalLines, tableHeader

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
TagTable(TagEditorModel model, int maxCharacters) Creates a new tag table

Method Summary

Modifier and Type	Method and Description
void	addComponentNotStoppingCellEditing(java.awt.Component component)
boolean	editCellAt(int row, int column, java.util.EventObject e)
TagTable.AddAction	getAddAction() Returns the add action.
AutoCompletionList	getAutoCompletionList()
TagTable.DeleteAction	getDeleteAction() Returns the delete action.
TagTable.PasteAction	getPasteAction() Returns the paste action.
java.awt.Dimension	getPreferredSize()
TagCellEditor	getTableCellEditor()
protected void	init(int maxCharacters) initialize the table
protected boolean	processKeyBinding(javax.swing.KeyStroke ks, java.awt.event.KeyEvent e, int condition, boolean pressed)
void	removeComponentNotStoppingCellEditing(java.awt.Component component)
void	removeEditor()
void	removeNotify()
void	requestFocusInCell(int row, int col)
void	setAutoCompletionList(AutoCompletionList autoCompletionList) Sets the editor autocompletion list
void	setAutoCompletionManager(AutoCompletionManager autocomplete)
void	setNextFocusComponent(java.awt.Component nextFocusComponent) Sets the next component to request focus after navigation (with tab or enter).
void	setTagCellEditor(TagCellEditor editor) Inject a tag cell editor in the tag table

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

getPreferredFullWidthSize, installCustomNavigation

Methods inherited from class javax.swing.JTable

addColumn, addColumnSelectionInterval, addNotify, addRowSelectionInterval, changeSelection, clearSelection, columnAdded, columnAtPoint, columnMarginChanged, columnMoved, columnRemoved, columnSelectionChanged, configureEnclosingScrollPane, convertColumnIndexToModel, convertColumnIndexToView, convertRowIndexToModel, convertRowIndexToView, createDefaultColumnModel, createDefaultColumnsFromModel, createDefaultDataModel, createDefaultEditors, createDefaultRenderers, createDefaultSelectionModel, createDefaultTableHeader, createScrollPaneForTable, doLayout, editCellAt, editingCanceled, editingStopped, getAccessibleContext, getAutoCreateColumnsFromModel, getAutoCreateRowSorter, getAutoResizeMode, getCellEditor, getCellEditor, getCellRect, getCellRenderer, getCellSelectionEnabled, getColumn, getColumnClass, getColumnCount, getColumnModel, getColumnName, getColumnSelectionAllowed, getDefaultEditor, getDefaultRenderer, getDragEnabled, getDropLocation, getDropMode, getEditingColumn, getEditingRow, getEditorComponent, getFillsViewportHeight, getGridColor, getIntercellSpacing, getModel, getPreferredScrollableViewportSize, getPrintable, getRowCount, getRowHeight, getRowHeight, getRowMargin, getRowSelectionAllowed, getRowSorter, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedColumn, getSelectedColumnCount, getSelectedColumns, getSelectedRow, getSelectedRowCount, getSelectedRows, getSelectionBackground, getSelectionForeground, getSelectionModel, getShowHorizontalLines, getShowVerticalLines, getSurrendersFocusOnKeystroke, getTableHeader, getToolTipText, getUI, getUIClassID, getUpdateSelectionOnSort, getValueAt, initializeLocalVars, isCellEditable, isCellSelected, isColumnSelected, isEditing, isRowSelected, moveColumn, paramString, prepareEditor, prepareRenderer, print, print, print, print, print, removeColumn, removeColumnSelectionInterval, removeRowSelectionInterval, resizeAndRepaint, rowAtPoint, selectAll, setAutoCreateColumnsFromModel, setAutoCreateRowSorter, setAutoResizeMode, setCellEditor, setCellSelectionEnabled, setColumnModel, setColumnSelectionAllowed, setColumnSelectionInterval, setDefaultEditor, setDefaultRenderer, setDragEnabled, setDropMode, setEditingColumn, setEditingRow, setFillsViewportHeight, setGridColor, setIntercellSpacing, setModel, setPreferredScrollableViewportSize, setRowHeight, setRowHeight, setRowMargin, setRowSelectionAllowed, setRowSelectionInterval, setRowSorter, setSelectionBackground, setSelectionForeground, setSelectionMode, setSelectionModel, setShowGrid, setShowHorizontalLines, setShowVerticalLines, setSurrendersFocusOnKeystroke, setTableHeader, setUI, setUpdateSelectionOnSort, setValueAt, sizeColumnsToFit, sizeColumnsToFit, sorterChanged, tableChanged, unconfigureEnclosingScrollPane, updateUI, valueChanged

Methods inherited from class javax.swing.JComponent

addAncestorListener, 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, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, 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, 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, getInputContext, 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

editor

private TagCellEditor editor

the table cell editor used by this table

model

private final TagEditorModel model

nextFocusComponent

private java.awt.Component nextFocusComponent

doNotStopCellEditingWhenFocused

private final java.util.concurrent.CopyOnWriteArrayList<java.awt.Component> doNotStopCellEditingWhenFocused

a list of components to which focus can be transferred without stopping cell editing this table.

editorRemover

private transient TagTable.CellEditorRemover editorRemover

deleteAction

private TagTable.DeleteAction deleteAction

the delete action

addAction

private TagTable.AddAction addAction

the add action

pasteAction

private TagTable.PasteAction pasteAction

the tag paste action

Constructor Detail

TagTable

public TagTable(TagEditorModel model,
                int maxCharacters)

Creates a new tag table

Parameters:

model - the tag editor model

maxCharacters - maximum number of characters allowed for keys and values, 0 for unlimited

Method Detail

getDeleteAction

public TagTable.DeleteAction getDeleteAction()

Returns the delete action.

Returns:

the delete action used by this table

getAddAction

public TagTable.AddAction getAddAction()

Returns the add action.

Returns:

the add action used by this table

getPasteAction

public TagTable.PasteAction getPasteAction()

Returns the paste action.

Returns:

the paste action used by this table

init

protected final void init(int maxCharacters)

initialize the table

Parameters:

maxCharacters - maximum number of characters allowed for keys and values, 0 for unlimited

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

processKeyBinding

protected boolean processKeyBinding(javax.swing.KeyStroke ks,
                                    java.awt.event.KeyEvent e,
                                    int condition,
                                    boolean pressed)

Overrides:

processKeyBinding in class javax.swing.JTable

setAutoCompletionList

public void setAutoCompletionList(AutoCompletionList autoCompletionList)

Sets the editor autocompletion list

Parameters:

autoCompletionList - autocompletion list

setAutoCompletionManager

public void setAutoCompletionManager(AutoCompletionManager autocomplete)

getAutoCompletionList

public AutoCompletionList getAutoCompletionList()

setNextFocusComponent

public void setNextFocusComponent(java.awt.Component nextFocusComponent)

Sets the next component to request focus after navigation (with tab or enter).

Parameters:

nextFocusComponent - next component to request focus after navigation (with tab or enter)

getTableCellEditor

public TagCellEditor getTableCellEditor()

setTagCellEditor

public void setTagCellEditor(TagCellEditor editor)

Inject a tag cell editor in the tag table

Parameters:

editor - tag cell editor

requestFocusInCell

public void requestFocusInCell(int row,
                               int col)

addComponentNotStoppingCellEditing

public void addComponentNotStoppingCellEditing(java.awt.Component component)

removeComponentNotStoppingCellEditing

public void removeComponentNotStoppingCellEditing(java.awt.Component component)

editCellAt

public boolean editCellAt(int row,
                          int column,
                          java.util.EventObject e)

Overrides:

editCellAt in class javax.swing.JTable

removeEditor

public void removeEditor()

Overrides:

removeEditor in class javax.swing.JTable

removeNotify

public void removeNotify()

Overrides:

removeNotify in class javax.swing.JTable