javax.swing
クラス JPasswordField

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.text.JTextComponent
                          |
                          +--javax.swing.JTextField
                                |
                                +--javax.swing.JPasswordField

すべての実装インタフェース:

Accessible, ImageObserver, MenuContainer, Scrollable, Serializable, SwingConstants

public class JPasswordField

extends JTextField

JPasswordField は、1 行のテキストの編集を可能にする、軽量コンポーネントです。ただし、ビューは入力があったことを示しますが、どの文字が入力されたかは表示しません。詳細や使用例については、「The Java Tutorial」の「How to Use Text Fields」を参照してください。

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

標準の Look & Feel (L&F) 表現でこのコンポーネントが使用するキーボードのキーについては、JPasswordField のキーの割り当てを参照してください。

警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。今後の Swing リリースでは、長期間の持続性をサポートする予定です。

関連項目:

直列化された形式

内部クラスの概要

protected class

JPasswordField.AccessibleJPasswordField このクラスは JPasswordField クラス用のユーザ補助機能のサポートを実装しています。

クラス javax.swing.JTextField から継承した内部クラス

JTextField.AccessibleJTextField

クラス javax.swing.text.JTextComponent から継承した内部クラス

JTextComponent.AccessibleJTextComponent, JTextComponent.KeyBinding

クラス javax.swing.JComponent から継承した内部クラス

JComponent.AccessibleJComponent

クラス java.awt.Container から継承した内部クラス

Container.AccessibleAWTContainer

クラス java.awt.Component から継承した内部クラス

Component.AccessibleAWTComponent

クラス javax.swing.JTextField から継承したフィールド

notifyAction

クラス javax.swing.text.JTextComponent から継承したフィールド

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

クラス javax.swing.JComponent から継承したフィールド

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

クラス java.awt.Component から継承したフィールド

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

インタフェース javax.swing.SwingConstants から継承したフィールド

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NORTH, NORTH_EAST, NORTH_WEST, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

インタフェース java.awt.image.ImageObserver から継承したフィールド

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

コンストラクタの概要

JPasswordField()
新しい JPasswordField を構築します。

JPasswordField(Document doc, String txt, int columns)
指定されたテキストストレージモデルと列数を使って新規の JPasswordField を構築します。

JPasswordField(int columns)
指定された列数で新規の空の JPasswordField を構築します。

JPasswordField(String text)
指定されたテキストで初期化される新規 JPasswordField を構築します。

JPasswordField(String text, int columns)
指定されたテキストと列で初期化される新規 JPasswordField を構築します。

メソッドの概要

void	copy() 関連したテキストモデル内の現在選択されている領域をシステムクリップボードに転送して、テキストモデルからコンテンツをそのまま残します。
void	cut() 関連したテキストモデル内の現在選択されている領域をシステムクリップボードに転送して、モデルからコンテンツを削除します。
boolean	echoCharIsSet() エコー表示に使用する文字セットが JPasswordField に用意されている場合に true を返します。
AccessibleContext	getAccessibleContext() この JPasswordField に関連した AccessibleContext を返します。
char	getEchoChar() エコーに使う文字を返します。
char[]	getPassword() TextComponent 内に格納されているテキストを返します。
String	getText() 推奨されていません。 Java 2 プラットフォーム v1.2 以降、getPassword() に置き換えられました。
String	getText(int offs, int len) 推奨されていません。 Java 2 プラットフォーム v1.2 以降、getPassword() に置き換えられました。
String	getUIClassID() このコンポーネントを描画する L&F クラスの名前を返します。
protected String	paramString() この JPasswordField の文字列表現を返します。
void	setEchoChar(char c) JPasswordField にエコー文字を設定します。

クラス javax.swing.JTextField から継承したメソッド

addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAction, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, isValidateRoot, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setFont, setHorizontalAlignment, setScrollOffset

クラス javax.swing.text.JTextComponent から継承したメソッド

addCaretListener, addInputMethodListener, addKeymap, fireCaretUpdate, getCaret, getCaretColor, getCaretPosition, getDisabledTextColor, getDocument, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getUI, isEditable, isFocusTraversable, loadKeymap, modelToView, moveCaretPosition, paste, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDocument, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write

クラス javax.swing.JComponent から継承したメソッド

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

クラス java.awt.Container から継承したメソッド

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree

クラス java.awt.Component から継承したメソッド

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

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 を構築します。これは、ほかのコンストラクタが入力するコンストラクタです。エコー文字は「*」に設定されます。ドキュメントが null の場合はデフォルトモデルが作成されます。

パラメータ:

doc - 使用するテキストストレージ

txt - 表示されるテキスト。ない場合は null

columns - 望ましい幅を計算するのに使う列数 >= 0。列数をゼロに設定すると、コンポーネント実装から自然に得られる結果を問わず望ましい幅になる

メソッドの詳細

getUIClassID

public String getUIClassID()

このコンポーネントを描画する L&F クラスの名前を返します。

オーバーライド:

クラス JTextField 内の getUIClassID

戻り値:

PasswordFieldUI

関連項目:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

getEchoChar

public char getEchoChar()

エコーに使う文字を返します。デフォルトは「*」です。

戻り値:

エコー文字。設定がない場合は 0

関連項目:

setEchoChar(char), echoCharIsSet()

setEchoChar

public void setEchoChar(char c)

JPasswordField にエコー文字を設定します。このエコー文字は表示のみに過ぎないという点に注意してください。インストールされるビューは、任意のグラフィックな方法を使ってフィールドを表示できます。値を 0 に設定すると、エコー文字は設定を解除されます。

パラメータ:

c - 表示するエコー文字

関連項目:

echoCharIsSet(), getEchoChar()

echoCharIsSet

public boolean echoCharIsSet()

エコー表示に使用する文字セットが JPasswordField に用意されている場合に true を返します。エコー文字が 0 でなければ、エコー文字が設定されていると解釈されます。

戻り値:

エコー表示に使用する文字が設定されている場合は true

関連項目:

setEchoChar(char), getEchoChar()

cut

public void cut()

関連したテキストモデル内の現在選択されている領域をシステムクリップボードに転送して、モデルからコンテンツを削除します。これは、パスワードの入力フィールドには不適切な動作なので、実装をやり直してビープ音だけになっています。

オーバーライド:

クラス JTextComponent 内の cut

copy

public void copy()

関連したテキストモデル内の現在選択されている領域をシステムクリップボードに転送して、テキストモデルからコンテンツをそのまま残します。これは、パスワードの入力フィールドには不適切な動作なので、実装をやり直してビープ音だけになっています。

オーバーライド:

クラス JTextComponent 内の copy

getText

public String getText()

推奨されていません。 Java 2 プラットフォーム v1.2 以降、getPassword() に置き換えられました。

この TextComponent に格納されたテキストを返します。基本となるドキュメントが null の場合は、NullPointerException を返します。

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

オーバーライド:

クラス JTextComponent 内の getText

戻り値:

テキスト

getText

public String getText(int offs,
                      int len)
               throws BadLocationException

推奨されていません。 Java 2 プラットフォーム v1.2 以降、getPassword() に置き換えられました。

コンポーネントが表すテキストの一部を取り出します。長さが 0 の場合は、空の文字列を返します。

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

オーバーライド:

クラス JTextComponent 内の getText

パラメータ:

offs - オフセット >= 0

len - 長さ >= 0

戻り値:

テキスト

例外:

BadLocationException - オフセットまたは長さが無効な場合

getPassword

public char[] getPassword()

TextComponent 内に格納されているテキストを返します。基本となるドキュメントが null の場合は、NullPointerException を返します。セキュリティ強化のために、返された文字の配列を使用したあとは、各文字をゼロに設定してクリアすることをお勧めします。

戻り値:

テキスト

paramString

protected String paramString()

この JPasswordField の文字列表現を返します。このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なります。返される文字列は空の場合がありますが、null にはなりません。

オーバーライド:

クラス JTextField 内の paramString

戻り値:

この JPasswordField の文字列表現

getAccessibleContext

public AccessibleContext getAccessibleContext()

この JPasswordField に関連した AccessibleContext を返します。パスワードフィールドの場合、AccessibleContext は AccessibleJPasswordField の形式を取ります。新規の AccessibleJPasswordField インスタンスが必要に応じて作成されます。

オーバーライド:

クラス JTextField 内の getAccessibleContext

戻り値:

この JPasswordField の AccessibleContext として機能する AccessibleJPasswordField