File	Doc	Category	Size	Date	Package
JPasswordField.java	API Doc	Java SE 6 API	24263	Tue Jun 10 00:26:38 BST 2008	javax.swing

JPasswordField

• java.lang.Object
  • java.awt.Component
    • java.awt.Container
      • javax.swing.JComponent
        • javax.swing.text.JTextComponent
          • javax.swing.JTextField

Fields Summary
private static final String	uiClassID
private char	echoChar
private boolean	echoCharSet

Constructors Summary
public JPasswordField() Constructs a new JPasswordField, with a default document, null starting text string, and 0 column width. this(null,null,0);
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. param text the text to be displayed, null if none this(null, text, 0);
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. param columns the number of columns >= 0 this(null, null, columns);
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. param text the text to be displayed, null if none param columns the number of columns >= 0 this(null, text, columns);
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 '*', but may be changed by the current Look and Feel. If the document model is null, a default one will be created. param doc the text storage to use param txt the text to be displayed, null if none param 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 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);

Methods Summary
public void	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. if (getClientProperty("JPasswordField.cutCopyAllowed") != Boolean.TRUE) { UIManager.getLookAndFeel().provideErrorFeedback(this); } else { super.copy(); }
boolean	customSetUIProperty(java.lang.String propertyName, java.lang.Object value) 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. if (propertyName == "echoChar") { if (!echoCharSet) { setEchoChar((Character)value); echoCharSet = false; } return true; } return false;
public void	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. if (getClientProperty("JPasswordField.cutCopyAllowed") != Boolean.TRUE) { UIManager.getLookAndFeel().provideErrorFeedback(this); } else { super.cut(); }
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. return true if a character is set for echoing see #setEchoChar see #getEchoChar return echoChar != 0;
public javax.accessibility.AccessibleContext	getAccessibleContext() 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. return an AccessibleJPasswordField that serves as the AccessibleContext of this JPasswordField if (accessibleContext == null) { accessibleContext = new AccessibleJPasswordField(); } return accessibleContext;
public char	getEchoChar() 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. return the echo character, 0 if unset see #setEchoChar see #echoCharIsSet return echoChar;
public char[]	getPassword() 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. return the text 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;
public java.lang.String	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. deprecated As of Java 2 platform v1.2, replaced by getPassword. return the text return super.getText();
public java.lang.String	getText(int offs, int 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. deprecated As of Java 2 platform v1.2, replaced by getPassword. param offs the offset >= 0 param len the length >= 0 return the text exception BadLocationException if the offset or length are invalid return super.getText(offs, len);
public java.lang.String	getUIClassID() Returns the name of the L&F class that renders this component. return the string "PasswordFieldUI" see JComponent#getUIClassID see UIDefaults#getUI return uiClassID;
protected java.lang.String	paramString() 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. return a string representation of this JPasswordField return super.paramString() + ",echoChar=" + echoChar;
public void	setEchoChar(char c) 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. param c the echo character to display see #echoCharIsSet see #getEchoChar beaninfo description: character to display in place of the real characters attribute: visualUpdate true echoChar = c; echoCharSet = true; repaint(); revalidate();
public void	updateUI() {@inheritDoc} since 1.6 if(!echoCharSet) { echoChar = '*"; } super.updateUI();
private void	writeObject(java.io.ObjectOutputStream s) See readObject() and writeObject() in JComponent for more information about serialization in Swing. s.defaultWriteObject(); if (getUIClassID().equals(uiClassID)) { byte count = JComponent.getWriteObjCounter(this); JComponent.setWriteObjCounter(this, --count); if (count == 0 && ui != null) { ui.installUI(this); } }