All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.JPasswordField 

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----com.sun.java.swing.JComponent
                           |
                           +----com.sun.java.swing.text.JTextComponent
                                   |
                                   +----com.sun.java.swing.JTextField
                                           |
                                           +----com.sun.java.swing.JPasswordField
public class JPasswordField
extends JTextField
JPasswordField is a lightweight component that allows the editing of a single line of text where the view indicates something was typed, but does not show the original characters. It is intended to be source-compatible with java.awt.TextField used with echoChar set. It is provided seperately to make it easier to safely change the ui for the JTextField without affecting password entries.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JPasswordField key assignments.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

Constructor Index

o JPasswordField()
Constructs a new JPasswordField, with a default document, null starting text string, and 0 column width.
o JPasswordField(Document, String, int)
Constructs a new JPasswordField that uses the given text storage model and the given number of columns.
o JPasswordField(int)
Constructs a new empty JPasswordField with the specified number of columns.
o JPasswordField(String)
Constructs a new JPasswordField initialized with the specified text.
o JPasswordField(String, int)
Constructs a new JPasswordField initialized with the specified text and columns.

Method Index

o copy()
Normally transfers the currently selected range in the associated text model to the system clipboard, leaving the contents in the text model.
o cut()
Normally transfers the currently selected range in the associated text model to the system clipboard, removing the contents from the model.
o echoCharIsSet()
Returns true if this JPasswordField has a character set for echoing.
o getAccessibleContext()
Gets the AccessibleContext associated with this JPasswordField.
o getEchoChar()
Returns the character to be used for echoing.
o getUIClassID()
Returns the name of the L&F class that renders this component.
o setEchoChar(char)
Sets the echo character for this JPasswordField.

Constructors

o JPasswordField 
 public JPasswordField()
Constructs a new JPasswordField, with a default document, null starting text string, and 0 column width.

o JPasswordField 
 public JPasswordField(String text)
Constructs a new JPasswordField initialized with the specified text. The document model is set to the default, and the number of columns to 0.

Parameters:
text - the text to be displayed, null if none
o JPasswordField 
 public JPasswordField(int columns)
Constructs a new empty JPasswordField with the specified number of columns. A default model is created, and the initial string is set to null.

Parameters:
columns - the number of columns >= 0
o JPasswordField 
 public JPasswordField(String text,
                       int columns)
Constructs a new JPasswordField initialized with the specified text and columns. The document model is set to the default.

Parameters:
text - the text to be displayed, null if none
columns - the number of columns >= 0
o JPasswordField 
 public JPasswordField(Document doc,
                       String txt,
                       int columns)
Constructs a new JPasswordField that uses the given text storage model and the given number of columns. This is the constructor through which the other constructors feed. The echo character is set to '*'. If the document model is null, a default one will be created.

Parameters:
doc - the text storage to use
txt - the text to be displayed, null if none
columns - the number of columns to use to calculate the preferred width >= 0. If columns is set to zero, the preferred width will be whatever naturally results from the component implementation.

Methods

o getUIClassID 
 public String getUIClassID()
Returns the name of the L&F class that renders this component.

Returns:
"PasswordFieldUI"
Overrides:
getUIClassID in class JTextField
See Also:
getUIClassID, getUI
o getEchoChar 
 public char getEchoChar()
Returns the character to be used for echoing. The default is '*'.

Returns:
the echo character, 0 if unset
See Also:
setEchoChar, echoCharIsSet
o setEchoChar 
 public void setEchoChar(char c)
Sets the echo character for this JPasswordField. Note that this is largely a suggestion to the view as the view that gets installed can use whatever graphic techniques it desires to represent the field. Setting a value of 0 unsets the echo character.

Parameters:
c - the echo character to display
See Also:
echoCharIsSet, getEchoChar
o echoCharIsSet 
 public boolean echoCharIsSet()
Returns true if this JPasswordField has a character set for echoing. A character is considered to be set if the echo character is not 0.

Returns:
true if a character is set for echoing
See Also:
setEchoChar, getEchoChar
o cut 
 public void cut()
Normally transfers the currently selected range in the associated text model to the system clipboard, removing the contents from the model. This is not a good thing for a password field and is reimplemented to simply beep.

Overrides:
cut in class JTextComponent
o copy 
 public void copy()
Normally transfers the currently selected range in the associated text model to the system clipboard, leaving the contents in the text model. This is not a good thing for a password field and is reimplemented to simply beep.

Overrides:
copy in class JTextComponent
o getAccessibleContext 
 public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JPasswordField. A new context is created as necessary.

Returns:
the AccessibleContext of this JPasswordField
Overrides:
getAccessibleContext in class JTextField 
All Packages  Class Hierarchy  This Package  Previous  Next  Index