JavaでJPasswordFieldの入力桁数を制限する方法（DocumentFilter活用）

JPasswordFieldとは

JPasswordFieldはJTextFieldのサブクラスで、ユーザーが入力した各文字をエコー文字（通常は「*」）に置き換えて表示するSwingコンポーネントです。この仕組みにより、パスワードやPINコードといった機密情報を画面上に露出させることなく安全に入力できます。代表的なメソッドとしては、getPassword()、getText()、getAccessibleContext()などが挙げられます。

デフォルトでは、JPasswordFieldには任意の文字数を入力できてしまいます。しかし実際のアプリケーション開発では、「PINコードは4桁まで」のように入力桁数を制限したいケースが多く存在します。こうした要件は、DocumentFilterクラスを実装し、replace()メソッドをオーバーライドすることで簡単に実現できます。

replace()メソッドの構文

public void replace(DocumentFilter.FilterBypass fb, int offset, int length, String text, AttributeSet attrs) throws BadLocationException

実装例：4桁のPINコード入力フォーム

以下のサンプルコードでは、JPasswordFieldに対してDocumentFilterを設定し、入力を4文字までに制限しています。5文字目以降を入力しようとしても、フィルタによって自動的に無視されます。

import java.awt.FlowLayout;
import javax.swing.*;
import javax.swing.text.*;

public class JPasswordFieldDigitLimitTest extends JFrame {
    private JPasswordField passwordField;
    private JPanel panel;

    public JPasswordFieldDigitLimitTest() {
        panel = new JPanel();
        ((FlowLayout) panel.getLayout()).setHgap(2);
        panel.add(new JLabel("Enter Pin: "));

        passwordField = new JPasswordField(4);
        PlainDocument document = (PlainDocument) passwordField.getDocument();
        document.setDocumentFilter(new DocumentFilter() {
            @Override
            public void replace(DocumentFilter.FilterBypass fb, int offset,
                    int length, String text, AttributeSet attrs)
                    throws BadLocationException {
                String string = fb.getDocument().getText(0, fb.getDocument().getLength()) + text;
                // 合計が4文字以内の場合のみ入力を許可
                if (string.length() <= 4) {
                    super.replace(fb, offset, length, text, attrs);
                }
            }
        });

        panel.add(passwordField);
        add(panel);
        setSize(400, 300);
        setDefaultCloseOperation(EXIT_ON_CLOSE);
        setLocationRelativeTo(null);
        setVisible(true);
    }

    public static void main(String[] args) {
        new JPasswordFieldDigitLimitTest();
    }
}

コードのポイント

• passwordField.getDocument()でドキュメントを取得し、setDocumentFilter()を使ってカスタムフィルタを設定します。
• replace()メソッド内では、まず既存のテキスト全体に新しく入力された文字列を連結し、その合計長が4文字以下である場合にのみsuper.replace()を呼び出します。
• 条件を満たさない入力は単純に無視されるため、ユーザーは指定桁数以上の文字を入力できなくなります。

なお、貼り付け（ペースト）操作による大量テキスト挿入もreplace()経由で処理されるため、この方法ならキーボード入力だけでなくクリップボードからの貼り付けにも対応できます。より厳密に制御したい場合は、insertString()やremove()も併せてオーバーライドするとよいでしょう。

実行結果

プログラムを実行すると、PINコード入力欄が表示され、4文字を超えて入力しようとしてもそれ以上文字が反映されないことが確認できます。