モジュール java.desktop
パッケージ javax.swing

クラスJPasswordField

  • すべての実装されたインタフェース:
    ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, SwingConstants

    @JavaBean(description="Allows the editing of a line of text but doesn\'t show the characters.")
public class JPasswordField
extends JTextField
    JPasswordFieldは、1行のテキストの編集を可能にする軽量コンポーネントです。何かが入力されたことはビューに示されますが、元の文字は表示されません。 詳細や使用例は、「The Java Tutorial」の「How to Use Text Fields」を参照してください。

    JPasswordFieldは、echoCharのセットとともに使用されるjava.awt.TextFieldとのソース互換のために用意されています。 個別に提供されているのは、パスワードの入力に影響を与えることなしに、JTextFieldのUIを安全に、および簡単に変更できるようにするためです。

    注意: デフォルトでは、JPasswordFieldはインプット・メソッドを無効にします。そうでない場合、入力文字はインプット・メソッドを使用して構成されている間に可視だった可能性があります。 アプリケーションでインプット・メソッドのサポートが必要な場合は、継承されたenableInputMethods(true)メソッドを使用してください。

    警告: Swingはスレッドに対して安全ではありません。 詳細は、「Swing's Threading Policy」を参照してください。

    警告: このクラスの直列化されたオブジェクトは、今後のSwingリリースと互換ではなくなる予定です。 現在の直列化のサポートは、短期間の格納や、同じバージョンのSwingを実行するアプリケーション間のRMIに適しています。 1.4以降、すべてのJavaBeans™用の長期間の格納サポートがjava.beansパッケージに追加されています。 XMLEncoderを参照してください。

    導入されたバージョン:
    1.2
    関連項目:
    直列化された形式

    • コンストラクタの詳細

      • JPasswordField

        public JPasswordField​()
        新しいJPasswordFieldを構築します。デフォルトのドキュメントを使用し、テキスト文字列はnullで開始します。列の幅は0です。

      • JPasswordField

        public JPasswordField​(String text)
        指定されたテキストで初期化された新しいJPasswordFieldを構築します。 ドキュメント・モデルがデフォルトに設定され、列数は0です。
        パラメータ:
        text - 表示されるテキスト。ない場合はnull

      • JPasswordField

        public JPasswordField​(int columns)
        指定された列数で新規の空のJPasswordFieldを構築します。 デフォルト・モデルが作成され、初期文字列はnullに設定されます。
        パラメータ:
        columns - 列数>= 0

      • JPasswordField

        public JPasswordField​(String text,
                      int columns)
        指定されたテキストおよび列で初期化される新規JPasswordFieldを構築します。 ドキュメント・モデルがデフォルトに設定されます。
        パラメータ:
        text - 表示されるテキスト。ない場合はnull
        columns - 列数>= 0

      • JPasswordField

        public JPasswordField​(Document doc,
                      String txt,
                      int columns)
        指定されたテキスト・ストレージ・モデルと列数を使用する新規のJPasswordFieldを構築します。 これは、ほかのコンストラクタが入力するコンストラクタです。 エコー文字はアスタリスク(*)に設定されていますが、現在のLook & Feelを使って変更可能です。 ドキュメント・モデルがnullの場合はデフォルト・モデルが作成されます。
        パラメータ:
        doc - 使用するテキスト・ストレージ
        txt - 表示されるテキスト。ない場合はnull
        columns - 適切な幅の計算に使用する列数。0以上。列数を0に設定すると、適切な幅はコンポーネントの実装から自然に得られる値になる

    • メソッドの詳細

      • getEchoChar

        public char getEchoChar​()
        エコーに使用する文字を返します。 デフォルトは「*」です。 デフォルトは現在実行中のLook & Feelによって異なる可能性があります。 たとえば、Metal/Oceanのデフォルトは箇条書きシンボルです。
        戻り値:
        エコー文字。設定がない場合は0
        関連項目:
        setEchoChar(char), echoCharIsSet()

      • setEchoChar

        @BeanProperty(bound=false,
              visualUpdate=true,
              description="character to display in place of the real characters")
public void setEchoChar​(char c)
        JPasswordFieldのエコー文字を設定します。 インストールされるビューは任意のグラフィック手法を使用してフィールドを表示できるため、これは提案にすぎません。 値0に設定すると、標準のJTextFieldの動作と同様に、テキストが入力したとおりに表示されます。
        パラメータ:
        c - 表示するエコー文字
        関連項目:
        echoCharIsSet(), getEchoChar()

      • echoCharIsSet

        public boolean echoCharIsSet​()
        JPasswordFieldにエコー表示に使用する文字セットが用意されている場合にtrueを返します。 エコー文字が0でなければ、エコー文字が設定されていると解釈されます。
        戻り値:
        エコー表示に使用する文字が設定されている場合はtrue
        関連項目:
        setEchoChar(char), getEchoChar()

      • cut

        public void cut​()
        現在のLook & FeelでprovideErrorFeedbackを呼び出します。通常これは、エラー・ビープ音を起動します。 パスワード・フィールドでは、関連したテキスト・モデル内の現在選択されている範囲をシステム・クリップボードに転送して、モデルからコンテンツを削除するという通常の動作は、受け入れられません。
        オーバーライド:
        cut 、クラス:  JTextComponent
        関連項目:
        Toolkit.getSystemClipboard(), Clipboard

      • copy

        public void copy​()
        現在のLook & FeelでprovideErrorFeedbackを呼び出します。通常これは、エラー・ビープ音を起動します。 パスワード・フィールドでは、関連したテキスト・モデル内の現在選択されている範囲をシステム・クリップボードに転送して、モデルにコンテンツを残すという通常の動作は、受け入れられません。
        オーバーライド:
        copy 、クラス:  JTextComponent
        関連項目:
        Toolkit.getSystemClipboard(), Clipboard

      • getText

        @Deprecated
public String getText​()
        非推奨。 Java 2プラットフォームv1.2以降は、getPasswordに置き換えられています。
        このTextComponentに格納されたテキストを返します。 ベースとなるドキュメントがnullの場合は、NullPointerExceptionを返します。

        セキュリティ上の理由から、このメソッドは非推奨です。 代わりに* getPasswordメソッドを使用してください。

        オーバーライド:
        getText 、クラス:  JTextComponent
        戻り値:
        テキスト
        関連項目:
        JTextComponent.setText(java.lang.String)

      • getText

        @Deprecated
public String getText​(int offs,
                      int len)
               throws BadLocationException
        非推奨。 Java 2プラットフォームv1.2以降は、getPasswordに置き換えられています。
        コンポーネントが表すテキストの一部を取り出します。 長さが0の場合は、空の文字列を返します。

        セキュリティ上の理由から、このメソッドは非推奨です。 代わりにgetPasswordメソッドを使用してください。

        オーバーライド:
        getText 、クラス:  JTextComponent
        パラメータ:
        offs - オフセット>= 0
        len - 長さ>= 0
        戻り値:
        テキスト
        例外:
        BadLocationException - オフセットまたは長さが無効な場合

      • getPassword

        @BeanProperty(bound=false)
public char[] getPassword​()
        このTextComponentに格納されたテキストを返します。 ベースとなるドキュメントがnullの場合は、NullPointerExceptionを返します。 セキュリティ強化のために、返された文字の配列を使用したあとは、各文字をゼロに設定してクリアすることをお勧めします。
        戻り値:
        テキスト

      • paramString

        protected String paramString​()
        このJPasswordFieldの文字列表現を返します。 このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なります。 返される文字列は空の場合がありますが、nullにはなりません。
        オーバーライド:
        paramString 、クラス:  JTextField
        戻り値:
        このJPasswordFieldの文字列表現

      • getAccessibleContext

        @BeanProperty(bound=false)
public AccessibleContext getAccessibleContext​()
        このJPasswordFieldに関連付けられたAccessibleContextを返します。 パスワード・フィールドの場合、AccessibleContextはAccessibleJPasswordFieldの形式を取ります。 必要に応じて、新しいAccessibleJPasswordFieldインスタンスが作成されます。
        定義:
        getAccessibleContext 、インタフェース: Accessible
        オーバーライド:
        getAccessibleContext 、クラス:  JTextField
        戻り値:
        このJPasswordFieldのAccessibleContextとして機能するAccessibleJPasswordField