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 applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}. 

 public JPasswordField() 
{
        this(null,null,0);
}

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

 public JPasswordField(String text) 
{
        this(null, text, 0);
}

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

 public JPasswordField(int columns) 
{
        this(null, null, 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

 public JPasswordField(String text,
    int columns) 
{
        this(null, text, 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

 public JPasswordField(Document doc,
    String txt,
    int columns) 
{
        super(doc, txt, columns);
        // We could either leave this on, which wouldn't be secure,
        // or obscure the composted text, which essentially makes displaying
        // it useless. Therefore, we turn off input methods.
        enableInputMethods(false);
}

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 '*', but may be changed by the current Look and Feel. 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

 public  void copy() 
{
        if (getClientProperty("JPasswordField.cutCopyAllowed") != Boolean.TRUE) {
            UIManager.getLookAndFeel().provideErrorFeedback(this);
        } else {
            super.copy();
        }
}

Invokes provideErrorFeedback on the current look and feel, which typically initiates an error beep. The normal behavior of transferring the currently selected range in the associated text model to the system clipboard, and leaving the contents from the model, is not acceptable for a password field.

 boolean customSetUIProperty(String propertyName,
    Object value) 
{
        if (propertyName == "echoChar") {
            if (!echoCharSet) {
                setEchoChar((Character)value);
                echoCharSet = false;
            }
            return true;
        }
        return false;
}

This method is a hack to get around the fact that we cannot directly override setUIProperty because part of the inheritance heirarchy goes outside of the javax.swing package, and therefore calling a package private method isn't allowed. This method should return true if the property was handled, and false otherwise.

 public  void cut() 
{
        if (getClientProperty("JPasswordField.cutCopyAllowed") != Boolean.TRUE) {
            UIManager.getLookAndFeel().provideErrorFeedback(this);
        } else {
            super.cut();
        }
}

Invokes provideErrorFeedback on the current look and feel, which typically initiates an error beep. The normal behavior of transferring the currently selected range in the associated text model to the system clipboard, and removing the contents from the model, is not acceptable for a password field.

 public boolean echoCharIsSet() 
{
        return echoChar != 0;
}

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.

 public AccessibleContext getAccessibleContext() 
{
        if (accessibleContext == null) {
            accessibleContext = new AccessibleJPasswordField();
        }
        return accessibleContext;
}

Returns the AccessibleContext associated with this JPasswordField. For password fields, the AccessibleContext takes the form of an AccessibleJPasswordField. A new AccessibleJPasswordField instance is created if necessary.

 public char getEchoChar() 
{
        return echoChar;
}

Returns the character to be used for echoing. The default is '*'. The default may be different depending on the currently running Look and Feel. For example, Metal/Ocean's default is a bullet character.

 public char[] getPassword() 
{
        Document doc = getDocument();
        Segment txt = new Segment();
        try {
            doc.getText(0, doc.getLength(), txt); // use the non-String API
        } catch (BadLocationException e) {
            return null;
        }
        char[] retValue = new char[txt.count];
        System.arraycopy(txt.array, txt.offset, retValue, 0, txt.count);
        return retValue;
}

Returns the text contained in this TextComponent. If the underlying document is null, will give a NullPointerException. For stronger security, it is recommended that the returned character array be cleared after use by setting each character to zero.

 public String getText() 
{
        return super.getText();
}

Returns the text contained in this TextComponent. If the underlying document is null, will give a NullPointerException.

For security reasons, this method is deprecated. Use the * getPassword method instead.

 public String getText(int offs,
    int len) throws BadLocationException 
{
        return super.getText(offs, len);
}

Fetches a portion of the text represented by the component. Returns an empty string if length is 0.

For security reasons, this method is deprecated. Use the getPassword method instead.

 public String getUIClassID() 
{
        return uiClassID;
}

Returns the name of the L&F class that renders this component.

 protected String paramString() 
{
        return super.paramString() +
        ",echoChar=" + echoChar;
}

Returns a string representation of this JPasswordField. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

 public  void setEchoChar(char c) 
{
        echoChar = c;
        echoCharSet = true;
        repaint();
        revalidate();
}

Sets the echo character for this JPasswordField. 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 standard JTextField.

 public  void updateUI() 
{
        if(!echoCharSet) {
            echoChar = '*';
        }
        super.updateUI();
}

{@inheritDoc}