Package adams.gui.core
Class BasePasswordField
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.text.JTextComponent
-
- javax.swing.JTextField
-
- javax.swing.JPasswordField
-
- adams.gui.core.BasePasswordField
-
- All Implemented Interfaces:
AnyChangeListenerSupporter
,ImageObserver
,MenuContainer
,Serializable
,Accessible
,Scrollable
,SwingConstants
public class BasePasswordField extends JPasswordField implements AnyChangeListenerSupporter
Extended JPasswordField component.- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JPasswordField
JPasswordField.AccessibleJPasswordField
-
Nested classes/interfaces inherited from class javax.swing.JTextField
JTextField.AccessibleJTextField
-
Nested classes/interfaces inherited from class javax.swing.text.JTextComponent
JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding
-
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
-
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
-
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
-
Field Summary
Fields Modifier and Type Field Description protected Set<ChangeListener>
m_AnyChangeListeners
the listeners for any changes to the text.protected char
m_EchoChar
the echo character in use.protected Set<ChangeListener>
m_EchoCharChangeListeners
the listener for any changes to the echo char.protected boolean
m_ShowPopupMenu
whether to show the popup menu.-
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 java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
-
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
-
-
Constructor Summary
Constructors Constructor Description BasePasswordField()
Constructs a newTextField
.BasePasswordField(int columns)
Constructs a new emptyTextField
with the specified number of columns.BasePasswordField(String text)
Constructs a newTextField
initialized with the specified text.BasePasswordField(String text, int columns)
Constructs a newTextField
initialized with the specified text and columns.BasePasswordField(Document doc, String text, int columns)
Constructs a newBaseTextField
that uses the given text storage model and the given number of columns.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAnyChangeListener(ChangeListener l)
Adds the listener for listening to any text changes.void
addEchoCharChangeListener(ChangeListener l)
Adds the listener for listening to echo char changes.protected JPopupMenu
createPopupMenu()
Creates the popup menu.BasePassword
getBasePassword()
Return the password.boolean
getShowPopupMenu()
Returns whether the popup menu is shown.protected void
initTextField()
Initializes members.boolean
isPasswordVisible()
Returns whether the password is shown or hidden.protected void
notifyAnyChangeListeners()
Notifies all listeners that some change to the text occurred.protected void
notifyEchoCharChangeListeners()
Notifies all listeners that the echo char changed.void
removeAnyChangeListener(ChangeListener l)
Removes the listener from listening to any text changes.void
removeEchoCharChangeListener(ChangeListener l)
Removes the listener from listening to echo char changes.void
setBasePassword(BasePassword value)
Sets the password.void
setEchoChar(char c)
Sets the echo character for thisJPasswordField
.void
setPasswordVisible(boolean value)
Shows or hides the password.void
setShowPopupMenu(boolean value)
Sets whether to show the popup menu.-
Methods inherited from class javax.swing.JPasswordField
copy, cut, echoCharIsSet, getAccessibleContext, getEchoChar, getPassword, getText, getText, getUIClassID, paramString, setText, updateUI
-
Methods inherited from class javax.swing.JTextField
actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, isValidateRoot, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, setFont, setHorizontalAlignment, setScrollOffset
-
Methods inherited from class javax.swing.text.JTextComponent
addCaretListener, addInputMethodListener, addKeymap, 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, getToolTipText, getUI, isEditable, loadKeymap, modelToView, modelToView2D, 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, viewToModel, viewToModel2D, 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, paint, 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, 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 Detail
-
m_AnyChangeListeners
protected Set<ChangeListener> m_AnyChangeListeners
the listeners for any changes to the text.
-
m_EchoCharChangeListeners
protected Set<ChangeListener> m_EchoCharChangeListeners
the listener for any changes to the echo char.
-
m_ShowPopupMenu
protected boolean m_ShowPopupMenu
whether to show the popup menu.
-
m_EchoChar
protected char m_EchoChar
the echo character in use.
-
-
Constructor Detail
-
BasePasswordField
public BasePasswordField()
Constructs a newTextField
. A default model is created, the initial string isnull
, and the number of columns is set to 0.
-
BasePasswordField
public BasePasswordField(String text)
Constructs a newTextField
initialized with the specified text. A default model is created and the number of columns is 0.- Parameters:
text
- the text to be displayed, ornull
-
BasePasswordField
public BasePasswordField(int columns)
Constructs a new emptyTextField
with 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
-
BasePasswordField
public BasePasswordField(String text, int columns)
Constructs a newTextField
initialized with the specified text and columns. A default model is created.- Parameters:
text
- the text to be displayed, ornull
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
-
BasePasswordField
public BasePasswordField(Document doc, String text, int columns)
Constructs a newBaseTextField
that 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 thecreateDefaultModel
methodtext
- the initial string to display, ornull
columns
- the number of columns to use to calculate the preferred width >= 0; ifcolumns
is set to zero, the preferred width will be whatever naturally results from the component implementation- Throws:
IllegalArgumentException
- ifcolumns
< 0
-
-
Method Detail
-
initTextField
protected void initTextField()
Initializes members.
-
addAnyChangeListener
public void addAnyChangeListener(ChangeListener l)
Adds the listener for listening to any text changes.- Specified by:
addAnyChangeListener
in interfaceAnyChangeListenerSupporter
- Parameters:
l
- the listener to add
-
removeAnyChangeListener
public void removeAnyChangeListener(ChangeListener l)
Removes the listener from listening to any text changes.- Specified by:
removeAnyChangeListener
in interfaceAnyChangeListenerSupporter
- Parameters:
l
- the listener to remove
-
notifyAnyChangeListeners
protected void notifyAnyChangeListeners()
Notifies all listeners that some change to the text occurred.
-
addEchoCharChangeListener
public void addEchoCharChangeListener(ChangeListener l)
Adds the listener for listening to echo char changes.- Parameters:
l
- the listener to add
-
removeEchoCharChangeListener
public void removeEchoCharChangeListener(ChangeListener l)
Removes the listener from listening to echo char changes.- Parameters:
l
- the listener to remove
-
notifyEchoCharChangeListeners
protected void notifyEchoCharChangeListeners()
Notifies all listeners that the echo char changed.
-
createPopupMenu
protected JPopupMenu createPopupMenu()
Creates the popup menu.- Returns:
- the popup menu, null if none created
-
setEchoChar
public void setEchoChar(char c)
Sets the echo character for thisJPasswordField
. Note that this is largely a suggestion, since the view that gets installed can use whatever graphic techniques it desires to represent the field. Setting a value of 0 indicates that you wish to see the text as it is typed, similar to the behavior of a standardJTextField
. Notifies all echochar change listeners.- Overrides:
setEchoChar
in classJPasswordField
- Parameters:
c
- the echo character to display
-
setShowPopupMenu
public void setShowPopupMenu(boolean value)
Sets whether to show the popup menu.- Parameters:
value
- true if to show
-
getShowPopupMenu
public boolean getShowPopupMenu()
Returns whether the popup menu is shown.- Returns:
- true if shown
-
setBasePassword
public void setBasePassword(BasePassword value)
Sets the password.- Parameters:
value
- the password
-
getBasePassword
public BasePassword getBasePassword()
Return the password.- Returns:
- the password
-
setPasswordVisible
public void setPasswordVisible(boolean value)
Shows or hides the password.- Parameters:
value
- true if to show
-
isPasswordVisible
public boolean isPasswordVisible()
Returns whether the password is shown or hidden.- Returns:
- true if shown
-
-