Class JosmTextField
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
- All Implemented Interfaces:
ComponentListener,FocusListener,ImageObserver,MenuContainer,PropertyChangeListener,Serializable,EventListener,Accessible,Scrollable,SwingConstants,Destroyable
- Direct Known Subclasses:
AutoCompletingTextField,AutoCompTextField,DisableShortcutsOnFocusGainedTextField
public class JosmTextField
extends JTextField
implements Destroyable, ComponentListener, FocusListener, PropertyChangeListener
Subclass of
This class must be used everywhere in core and plugins instead of
JTextField that:- adds a "native" context menu (undo/redo/cut/copy/paste/select all)
- adds an optional "hint" displayed when no text has been entered
- disables the global advanced key press detector when focused
- implements a workaround to JDK bug 6322854
This class must be used everywhere in core and plugins instead of
JTextField.- Since:
- 5886
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JTextField
JTextField.AccessibleJTextFieldNested classes/interfaces inherited from class javax.swing.text.JTextComponent
JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBindingNested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Stringprivate Iconprivate Pointprivate final PopupMenuLauncherprivate OrientationActionprivate InsetsFields inherited from class javax.swing.JTextField
notifyActionFields inherited from class javax.swing.text.JTextComponent
DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEYFields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields 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 -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a newJosmTextField.JosmTextField(int columns) Constructs a new emptyJosmTextFieldwith the specified number of columns.JosmTextField(String text) Constructs a newJosmTextFieldinitialized with the specified text.JosmTextField(String text, int columns) Constructs a newJosmTextFieldinitialized with the specified text and columns.JosmTextField(Document doc, String text, int columns) Constructs a newJosmTextFieldthat uses the given text storage model and the given number of columns.JosmTextField(Document doc, String text, int columns, boolean undoRedo) Constructs a newJosmTextFieldthat uses the given text storage model and the given number of columns. -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidvoidvoidvoiddestroy()Called when the object has been destroyed.final voidEmpties the internal undo manager.booleanReturn true if the textfield should display the hint text.voidDraws the hint text over the editor component.voidvoidfinal StringgetHint()Replies the hint displayed when no text has been entered.static FontReturns the font for hint texts.static ColorReturns the color for hint texts.getIcon()Returns the icon to displayvoidprivate voidvoidvoidSets the hint to display when no text has been entered.voidSets the icon to displayMethods inherited from class javax.swing.JTextField
actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, setFont, setHorizontalAlignment, setScrollOffsetMethods 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, modelToView2D, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, viewToModel2D, writeMethods 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, paint, paintBorder, paintChildren, 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, updateMethods 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, validateTreeMethods 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Field Details
-
launcher
-
hint
-
icon
-
iconPos
-
originalMargin
-
orientationAction
-
-
Constructor Details
-
JosmTextField
Constructs a newJosmTextFieldthat uses the given text storage model and the given number of columns. This is the constructor through which the other constructors feed. If the document isnull, a default model is created.- Parameters:
doc- the text storage to use; if this isnull, a default will be provided by calling thecreateDefaultModelmethodtext- the initial string to display, ornullcolumns- the number of columns to use to calculate the preferred width >= 0; ifcolumnsis set to zero, the preferred width will be whatever naturally results from the component implementation- Throws:
IllegalArgumentException- ifcolumns< 0
-
JosmTextField
Constructs a newJosmTextFieldthat uses the given text storage model and the given number of columns. This is the constructor through which the other constructors feed. If the document isnull, a default model is created.- Parameters:
doc- the text storage to use; if this isnull, a default will be provided by calling thecreateDefaultModelmethodtext- the initial string to display, ornullcolumns- the number of columns to use to calculate the preferred width >= 0; ifcolumnsis 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 editor- Throws:
IllegalArgumentException- ifcolumns< 0
-
JosmTextField
Constructs a newJosmTextFieldinitialized with the specified text and columns. A default model is created.- Parameters:
text- the text to be displayed, ornullcolumns- 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
-
JosmTextField
Constructs a newJosmTextFieldinitialized with the specified text. A default model is created and the number of columns is 0.- Parameters:
text- the text to be displayed, ornull
-
JosmTextField
Constructs a new emptyJosmTextFieldwith the specified number of columns. A default model is created and the initial string is set tonull.- 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
-
JosmTextField
public JosmTextField()Constructs a newJosmTextField. A default model is created, the initial string isnull, and the number of columns is set to 0.
-
-
Method Details
-
getHint
Replies the hint displayed when no text has been entered.- Returns:
- the hint
- Since:
- 7505
-
setHint
Sets the hint to display when no text has been entered.- Parameters:
hint- the hint to set- Returns:
- the old hint
- Since:
- 18221 (signature)
-
displayHint
Return true if the textfield should display the hint text.- Returns:
- whether to display the hint text
- Since:
- 18221
-
getIcon
Returns the icon to display- Returns:
- the icon to display
- Since:
- 17768
-
setIcon
Sets the icon to display- Parameters:
icon- the icon to set- Since:
- 17768
-
positionIcon
-
setComponentOrientation
- Overrides:
setComponentOrientationin classJTextComponent
-
discardAllUndoableEdits
Empties the internal undo manager.- Since:
- 14977
-
getHintTextColor
Returns the color for hint texts.- Returns:
- the Color for hint texts
-
getHintFont
Returns the font for hint texts.- Returns:
- the font for hint texts
-
paintComponent
- Overrides:
paintComponentin classJComponent
-
drawHint
Draws the hint text over the editor component.- Parameters:
g- the graphics context
-
focusGained
- Specified by:
focusGainedin interfaceFocusListener
-
focusLost
- Specified by:
focusLostin interfaceFocusListener
-
destroy
Description copied from interface:DestroyableCalled when the object has been destroyed.- Specified by:
destroyin interfaceDestroyable
-
componentResized
- Specified by:
componentResizedin interfaceComponentListener
-
componentMoved
- Specified by:
componentMovedin interfaceComponentListener
-
componentShown
- Specified by:
componentShownin interfaceComponentListener
-
componentHidden
- Specified by:
componentHiddenin interfaceComponentListener
-
propertyChange
- Specified by:
propertyChangein interfacePropertyChangeListener
-