org.openstreetmap.josm.gui.widgets

Class TextContextualPopupMenu

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPopupMenu

org.openstreetmap.josm.gui.widgets.TextContextualPopupMenu

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.MenuElement

public class TextContextualPopupMenu
extends javax.swing.JPopupMenu

A popup menu designed for text components. It displays the following actions:

• Undo
• Redo
• Cut
• Copy
• Paste
• Delete
• Select All

Since:

5886

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TextContextualPopupMenu.RedoAction
protected class	TextContextualPopupMenu.UndoAction

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

javax.swing.JPopupMenu.AccessibleJPopupMenu, javax.swing.JPopupMenu.Separator

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 javax.swing.text.JTextComponent	component
private static java.lang.String	EDITABLE
private static java.util.Map<java.lang.String,javax.swing.ImageIcon>	iconCache
protected java.beans.PropertyChangeListener	propertyChangeListener
protected TextContextualPopupMenu.RedoAction	redoAction
protected javax.swing.undo.UndoManager	undo
protected TextContextualPopupMenu.UndoAction	undoAction
protected javax.swing.event.UndoableEditListener	undoEditListener
protected boolean	undoRedo

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

Modifier	Constructor and Description
protected	TextContextualPopupMenu() Creates a new TextContextualPopupMenu.

Method Summary

Modifier and Type	Method and Description
private void	addMenuEntries()
protected void	addMenuEntry(javax.swing.text.JTextComponent component, java.lang.String label, java.lang.String actionName, java.lang.String iconName)
protected TextContextualPopupMenu	attach(javax.swing.text.JTextComponent component, boolean undoRedo) Attaches this contextual menu to the given text component.
protected TextContextualPopupMenu	detach() Detaches this contextual menu from its text component.
static void	disableMenuFor(javax.swing.text.JTextComponent component, PopupMenuLauncher launcher) Disables the TextContextualPopupMenu attached to the given popup menu launcher and text component.
private void	disableUndoRedo()
void	discardAllUndoableEdits() Empties the internal undo manager.
static PopupMenuLauncher	enableMenuFor(javax.swing.text.JTextComponent component, boolean undoRedo) Creates a new TextContextualPopupMenu and enables it for the given text component.
private void	enableUndoRedo()
boolean	isAttached() Determines if this popup is currently attached to a component.
private static javax.swing.ImageIcon	loadIcon(java.lang.String iconName)
private void	updateUndoRedoState()

Methods inherited from class javax.swing.JPopupMenu

add, add, add, addMenuKeyListener, addPopupMenuListener, addSeparator, createActionChangeListener, createActionComponent, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getComponent, getComponentAtIndex, getComponentIndex, getDefaultLightWeightPopupEnabled, getInvoker, getLabel, getMargin, getMenuKeyListeners, getPopupMenuListeners, getSelectionModel, getSubElements, getUI, getUIClassID, insert, insert, isBorderPainted, isLightWeightPopupEnabled, isPopupTrigger, isVisible, menuSelectionChanged, pack, paintBorder, paramString, processFocusEvent, processKeyEvent, processKeyEvent, processMouseEvent, remove, removeMenuKeyListener, removePopupMenuListener, setBorderPainted, setDefaultLightWeightPopupEnabled, setInvoker, setLabel, setLightWeightPopupEnabled, setLocation, setPopupSize, setPopupSize, setSelected, setSelectionModel, setUI, setVisible, show, 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, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, 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, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, 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, 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, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, 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, 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

EDITABLE

private static final java.lang.String EDITABLE

See Also:

Constant Field Values

iconCache

private static final java.util.Map<java.lang.String,javax.swing.ImageIcon> iconCache

component

protected javax.swing.text.JTextComponent component

undoRedo

protected boolean undoRedo

undoAction

protected final TextContextualPopupMenu.UndoAction undoAction

redoAction

protected final TextContextualPopupMenu.RedoAction redoAction

undo

protected final javax.swing.undo.UndoManager undo

undoEditListener

protected final transient javax.swing.event.UndoableEditListener undoEditListener

propertyChangeListener

protected final transient java.beans.PropertyChangeListener propertyChangeListener

Constructor Detail

TextContextualPopupMenu

protected TextContextualPopupMenu()

Creates a new TextContextualPopupMenu.

Method Detail

loadIcon

private static javax.swing.ImageIcon loadIcon(java.lang.String iconName)

updateUndoRedoState

private void updateUndoRedoState()

attach

protected TextContextualPopupMenu attach(javax.swing.text.JTextComponent component,
                                         boolean undoRedo)

Attaches this contextual menu to the given text component. A menu can only be attached to a single component.

Parameters:

component - The text component that will display the menu and handle its actions.

undoRedo - true if undo/redo must be supported

Returns:

this

See Also:

detach()

enableUndoRedo

private void enableUndoRedo()

disableUndoRedo

private void disableUndoRedo()

addMenuEntries

private void addMenuEntries()

detach

protected TextContextualPopupMenu detach()

Detaches this contextual menu from its text component.

Returns:

this

See Also:

attach(JTextComponent, boolean)

enableMenuFor

public static PopupMenuLauncher enableMenuFor(javax.swing.text.JTextComponent component,
                                              boolean undoRedo)

Creates a new TextContextualPopupMenu and enables it for the given text component.

Parameters:

component - The component that will display the menu and handle its actions.

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

Returns:

The PopupMenuLauncher responsible of displaying the popup menu. Call disableMenuFor(javax.swing.text.JTextComponent, org.openstreetmap.josm.gui.widgets.PopupMenuLauncher) with this object if you want to disable the menu later.

See Also:

disableMenuFor(javax.swing.text.JTextComponent, org.openstreetmap.josm.gui.widgets.PopupMenuLauncher)

disableMenuFor

public static void disableMenuFor(javax.swing.text.JTextComponent component,
                                  PopupMenuLauncher launcher)

Disables the TextContextualPopupMenu attached to the given popup menu launcher and text component.

Parameters:

component - The component that currently displays the menu and handles its actions.

launcher - The PopupMenuLauncher obtained via enableMenuFor(javax.swing.text.JTextComponent, boolean).

See Also:

enableMenuFor(javax.swing.text.JTextComponent, boolean)

discardAllUndoableEdits

public void discardAllUndoableEdits()

Empties the internal undo manager.

Since:

14977

isAttached

public final boolean isAttached()

Determines if this popup is currently attached to a component.

Returns:

true if this popup is currently attached to a component, false otherwise.

addMenuEntry

protected void addMenuEntry(javax.swing.text.JTextComponent component,
                            java.lang.String label,
                            java.lang.String actionName,
                            java.lang.String iconName)