1 /* JPasswordField.java --
2 Copyright (C) 2002, 2004 Free Software Foundation, Inc.
4 This file is part of GNU Classpath.
6 GNU Classpath is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library. Thus, the terms and
23 conditions of the GNU General Public License cover the whole
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module. An independent module is a module which is not derived from
33 or based on this library. If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so. If you do not wish to do so, delete this
36 exception statement from your version. */
41 import java
.io
.IOException
;
42 import java
.io
.ObjectOutputStream
;
44 import javax
.accessibility
.AccessibleContext
;
45 import javax
.accessibility
.AccessibleRole
;
46 import javax
.swing
.text
.BadLocationException
;
47 import javax
.swing
.text
.Document
;
50 * class JPasswordField
52 * @author Andrew Selkirk
55 public class JPasswordField
extends JTextField
58 * AccessibleJPasswordField
60 protected class AccessibleJPasswordField
extends AccessibleJTextField
62 private static final long serialVersionUID
= -8477039424200681086L;
65 * Constructor AccessibleJPasswordField
67 protected AccessibleJPasswordField()
74 * @return AccessibleRole
76 public AccessibleRole
getAccessibleRole()
78 return AccessibleRole
.PASSWORD_TEXT
;
83 * echoChar. Default is 0.
85 private char echoChar
= 0;
88 * Creates a <code>JPasswordField</code> object.
90 public JPasswordField()
96 * Creates a <code>JPasswordField</code> object.
98 * @param text the initial text
100 public JPasswordField(String text
)
106 * Creates a <code>JPasswordField</code> object.
108 * @param columns the number of columns
110 public JPasswordField(int columns
)
112 this(null, null, columns
);
116 * Creates a <code>JPasswordField</code> object.
118 * @param text the initial text
119 * @param columns the number of columns
121 public JPasswordField(String text
, int columns
)
123 this(null, text
, columns
);
127 * Creates a <code>JPasswordField</code> object.
129 * @param document the document to use
130 * @param text the initial text
131 * @param columns the number of columns
133 public JPasswordField(Document document
, String text
, int columns
)
135 super(document
, text
, columns
);
141 * @param stream the stream to write to
143 * @exception IOException if an error occurs
145 private void writeObject(ObjectOutputStream stream
) throws IOException
147 // TODO: Implement me.
151 * Returns the <code>UIClassID</code>
153 * @return the string "PasswordFieldUI"
155 public String
getUIClassID()
157 return "PasswordFieldUI";
163 * @return the echo char
165 public char getEchoChar()
173 * @param echo the echo char
175 public void setEchoChar(char echo
)
177 this.echoChar
= echo
;
183 * @return <code>true</code> if the echo char is set,
184 * <code>false</code> otherwise.
186 public boolean echoCharIsSet()
188 return echoChar
== 0;
192 * Copies the selected text into the clipboard. This operation is not
193 * allowed in a password input field.
197 UIManager
.getLookAndFeel().provideErrorFeedback(this);
201 * Cuts the selected text and puts it into the clipboard. This operation
202 * is not allowed in a password input field.
206 UIManager
.getLookAndFeel().provideErrorFeedback(this);
216 public String
getText()
229 * @exception BadLocationException TODO
233 public String
getText(int offset
, int length
) throws BadLocationException
243 public char[] getPassword()
245 return new char[0]; // TODO
253 protected String
paramString()
259 * getAccessibleContext
261 * @return the <code>AccessibleContext</code> object
263 public AccessibleContext
getAccessibleContext()
265 if (accessibleContext
== null)
266 accessibleContext
= new AccessibleJPasswordField();
268 return accessibleContext
;