Liking cljdoc? Tell your friends :D

javax.swing.JPasswordField

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. You can find further information and examples in How to Use Text Fields, a section in The Java Tutorial.

JPasswordField is intended to be source-compatible with java.awt.TextField used with echoChar set. It is provided separately to make it easier to safely change the UI for the JTextField without affecting password entries.

NOTE: By default, JPasswordField disables input methods; otherwise, input characters could be visible while they were composed using input methods. If an application needs the input methods support, please use the inherited method, enableInputMethods(true).

Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

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™ has been added to the java.beans package. Please see XMLEncoder.

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.
You can find further information and examples in
How to Use Text Fields,
a section in The Java Tutorial.

JPasswordField is intended
to be source-compatible with java.awt.TextField
used with echoChar set.  It is provided separately
to make it easier to safely change the UI for the
JTextField without affecting password entries.

NOTE:
By default, JPasswordField disables input methods; otherwise, input
characters could be visible while they were composed using input methods.
If an application needs the input methods support, please use the
inherited method, enableInputMethods(true).

Warning: Swing is not thread safe. For more
information see Swing's Threading
Policy.

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™
has been added to the java.beans package.
Please see XMLEncoder.
raw docstring

->j-password-fieldclj

(->j-password-field)
(->j-password-field text)
(->j-password-field text columns)
(->j-password-field doc txt columns)

Constructor.

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.

doc - the text storage to use - javax.swing.text.Document txt - the text to be displayed, null if none - java.lang.String 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 - int

Constructor.

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.

doc - the text storage to use - `javax.swing.text.Document`
txt - the text to be displayed, null if none - `java.lang.String`
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 - `int`
raw docstring

copyclj

(copy this)

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.

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.
raw docstring

cutclj

(cut this)

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.

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.
raw docstring

echo-char-is-setclj

(echo-char-is-set this)

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 - boolean

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 - `boolean`
raw docstring

get-accessible-contextclj

(get-accessible-context this)

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.

returns: an AccessibleJPasswordField that serves as the AccessibleContext of this JPasswordField - javax.accessibility.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.

returns: an AccessibleJPasswordField that serves as the
         AccessibleContext of this
         JPasswordField - `javax.accessibility.AccessibleContext`
raw docstring

get-echo-charclj

(get-echo-char this)

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.

returns: the echo character, 0 if unset - char

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.

returns: the echo character, 0 if unset - `char`
raw docstring

get-passwordclj

(get-password this)

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.

returns: the text - char[]

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.

returns: the text - `char[]`
raw docstring

get-textclj

(get-text this)
(get-text this offs len)

Deprecated. As of Java 2 platform v1.2, replaced by getPassword.

offs - the offset >= 0 - int len - the length >= 0 - int

returns: the text - java.lang.String

throws: javax.swing.text.BadLocationException - if the offset or length are invalid

Deprecated. As of Java 2 platform v1.2,
 replaced by getPassword.

offs - the offset >= 0 - `int`
len - the length >= 0 - `int`

returns: the text - `java.lang.String`

throws: javax.swing.text.BadLocationException - if the offset or length are invalid
raw docstring

get-ui-class-idclj

(get-ui-class-id this)

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

returns: the string "PasswordFieldUI" - java.lang.String

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

returns: the string "PasswordFieldUI" - `java.lang.String`
raw docstring

set-echo-charclj

(set-echo-char this 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.

c - the echo character to display - char

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.

c - the echo character to display - `char`
raw docstring

update-uiclj

(update-ui this)

Reloads the pluggable UI. The key used to fetch the new interface is getUIClassID(). The type of the UI is TextUI. invalidate is called after setting the UI.

Reloads the pluggable UI.  The key used to fetch the
new interface is getUIClassID().  The type of
the UI is TextUI.  invalidate
is called after setting the UI.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close