javax.swing
クラス JTextField
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.text.JTextComponent
javax.swing.JTextField
- すべての実装されたインタフェース:
- ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, SwingConstants
- 直系の既知のサブクラス:
- DefaultTreeCellEditor.DefaultTextField, JFormattedTextField, JPasswordField
public class JTextField
- extends JTextComponent
- implements SwingConstants
JTextField は、1 行のテキストの編集を可能にする軽量コンポーネントです。テキストフィールドの詳細と使用例については、「The Java Tutorial」の「How to Use Text Fields」を参照してください。
JTextField は、この処理を適切に行う java.awt.TextField クラスとのソース互換性を提供するために用意されています。このコンポーネントは、java.awt.TextField クラスにはない機能を備えています。追加機能については、スーパークラスを参照してください。
JTextField は、発生するアクションイベントのコマンド文字列として使う文字列を確定するメソッドを持ちます。java.awt.TextField は、フィールドのテキストを ActionEvent のコマンド文字列として使いました。JTextField は null でなければ、setActionCommand メソッドで設定されたコマンド文字列を使います。それ以外の場合は、フィールドのテキストを java.awt.TextField との互換機能として使います。
プラグイン可能な Look & Feel の新しい実装がパスワード文字列を偶発的に表示してしまわないようにするために、setEchoChar メソッドと getEchoChar メソッドは直接提供はされません。パスワード様式のサービスを提供するためには、これとは別の JPasswordField クラスが JTextField を拡張して導入され、独自にプラグイン可能な Look & Feel にこのサービスを提供します。
java.awt.TextField の変更を監視するには、TextEvent の TextListener を追加します。JTextComponent ベースのコンポーネントでは、DocumentEvent 経由でモデルから DocumentListeners に変更が送られます。DocumentEvent は必要に応じて、変更位置と変更の種類を提供します。コードは次のようになります。
DocumentListener myListener = ??;
JTextField myArea = ??;
myArea.getDocument().addDocumentListener(myListener);
JTextField の水平配置は、左揃え、中央揃え、右揃え、または末尾調整に設定できます。フィールドテキストの必要なサイズがそのフィールドに割り当てられたサイズよりも小さい場合は、右揃えと末尾調整は便利です。これは setHorizontalAlignment メソッドと getHorizontalAlignment メソッドによって指定されます。デフォルトでは、左揃えになります。
テキストフィールドが VK_ENTER イベントを消費する方法は、このテキストフィールドにアクションリスナーがあるかどうかによって異なります。アクションリスナーがある場合は、VK_ENTER によりリスナーに ActionEvent が返され、VK_ENTER イベントが消費されます。これは、AWT テキストフィールドが VK_ENTER イベントを処理する方法と互換性があります。テキストフィールドにアクションリスナーがない場合、v 1.3 では、VK_ENTER イベントは消費されません。代わりに、上位クラスのコンポーネントのバインディングが処理されて、JFC/Swing のデフォルトボタン機能が使用できます。
カスタマイズされたフィールドを簡単に作成するには、モデルを拡張して、提供されるデフォルトモデルを変更します。たとえば次のコードの一部は、大文字だけを保持するフィールドを作成します。これは、テキストがクリップボードからペーストされたり、プログラムに基づいて変更されても機能します。
public class UpperCaseField extends JTextField {
public UpperCaseField(int cols) {
super(cols);
}
protected Document createDefaultModel() {
return new UpperCaseDocument();
}
static class UpperCaseDocument extends PlainDocument {
public void insertString(int offs, String str, AttributeSet a)
throws BadLocationException {
if (str == null) {
return;
}
char[] upper = str.toCharArray();
for (int i = 0; i < upper.length; i++) {
upper[i] = Character.toUpperCase(upper[i]);
}
super.insertString(offs, new String(upper), a);
}
}
}
警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。JDK バージョン 1.4 以降、すべての JavaBeans™ の長期間の運用サポートは、java.beans パッケージに追加されています。詳細は、XMLEncoder を参照してください。
- 関連項目:
setActionCommand(java.lang.String),
JPasswordField,
addActionListener(java.awt.event.ActionListener)
| インタフェース javax.swing.SwingConstants から継承されたフィールド |
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST |
| クラス javax.swing.text.JTextComponent から継承されたメソッド |
addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write |
| クラス javax.swing.JComponent から継承されたメソッド |
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update |
| クラス java.awt.Container から継承されたメソッド |
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree |
| クラス java.awt.Component から継承されたメソッド |
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle |
notifyAction
public static final String notifyAction
- フィールドの内容が受け付けられたという通知を送るアクションの名前です。通常、これは復帰動作に割り当てられます。
- 関連項目:
- 定数フィールド値
JTextField
public JTextField()
- 新しい
TextField を構築します。デフォルトモデルが作成され、初期文字列は null で、列数が 0 に設定されます。
JTextField
public JTextField(String text)
- 指定されたテキストで初期化される新しい
TextField を構築します。デフォルトモデルが作成され、列数は 0 です。
- パラメータ:
text - 表示されるテキストまたは null
JTextField
public JTextField(int columns)
- 指定された列数で新しい空の
TextField を構築します。デフォルトモデルが作成され、初期文字列は null に設定されます。
- パラメータ:
columns - 適切な幅を計算するのに使う列数。列数をゼロに設定すると、コンポーネント実装から自然に生ずるものは何であれ適切な幅になる
JTextField
public JTextField(String text,
int columns)
- 指定されたテキストと列数で初期化される新しい
TextField を構築します。デフォルトモデルが作成されます。
- パラメータ:
text - 表示されるテキストまたは nullcolumns - 適切な幅を計算するのに使う列数。列数をゼロに設定すると、コンポーネント実装から自然に生ずるものは何であれ適切な幅になる
JTextField
public JTextField(Document doc,
String text,
int columns)
- 指定されたテキストストレージモデルと列数を使って新しい
JTextField を構築します。新しい JTextField は、ほかのコンストラクタが影響を及ぼすコンストラクタです。ドキュメントが null の場合はデフォルトモデルが作成されます。
- パラメータ:
doc - 使用するテキストストレージ。null の場合は、createDefaultModel メソッドを呼び出すことによってデフォルトの値が提供されるtext - 表示する初期文字列または nullcolumns - 適切な幅を計算するのに使う列数 >= 0。columns をゼロに設定すると、コンポーネント実装から自然に生ずるものは何であれ適切な幅になる
- 例外:
IllegalArgumentException - columns が 0 よりも小さい場合
getUIClassID
public String getUIClassID()
- UI のクラス ID を返します。
- オーバーライド:
- クラス
JComponent 内の getUIClassID
- 戻り値:
- 文字列「TextFieldUI」
- 関連項目:
JComponent.getUIClassID(),
UIDefaults.getUI(javax.swing.JComponent)
setDocument
public void setDocument(Document doc)
- エディタをテキストドキュメントに関連付けます。現在登録されているファクトリを使うと、ドキュメントのビューを構築できます。このドキュメントは、再検証後にエディタによって表示されます。PropertyChange イベント (document) は、各リスナーに通知されます。
- オーバーライド:
- クラス
JTextComponent 内の setDocument
- パラメータ:
doc - 表示および編集するドキュメント- 関連項目:
JTextComponent.getDocument()
isValidateRoot
public boolean isValidateRoot()
- テキストフィールド自身の中から呼び出される
revalidate は、テキストフィールドの妥当性を検証することによって処理されます。ただし、テキストフィールドが JViewport 内に含まれていない場合は false を返します。
- オーバーライド:
- クラス
JComponent 内の isValidateRoot
- 戻り値:
- このテキストフィールドの親が
JViewPort の場合は false、そうでない場合は true - 関連項目:
JComponent.revalidate(),
JComponent.isValidateRoot()
getHorizontalAlignment
public int getHorizontalAlignment()
- テキストの水平配置を返します。有効なキーは次のとおりです。
JTextField.LEFT JTextField.CENTER JTextField.RIGHT JTextField.LEADING JTextField.TRAILING
- 戻り値:
- 水平配置
setHorizontalAlignment
public void setHorizontalAlignment(int alignment)
- テキストの水平配置を設定します。有効なキーは次のとおりです。
JTextField.LEFT JTextField.CENTER JTextField.RIGHT JTextField.LEADING JTextField.TRAILING
配置が設定されると invalidate と repaint が呼び出され、PropertyChange イベント (horizontalAlignment) がトリガされます。
- パラメータ:
alignment - 配置方法
- 例外:
IllegalArgumentException - alignment が有効なキーではない場合
createDefaultModel
protected Document createDefaultModel()
- モデルが明示的に指定されない場合は、構築時に使うモデルのデフォルト実装を作成します。
PlainDocument のインスタンスが返されます。
- 戻り値:
- デフォルトモデルの実装
getColumns
public int getColumns()
- この
TextField の列数を返します。
- 戻り値:
- 列数 >= 0
setColumns
public void setColumns(int columns)
- この
TextField の列数を設定し、配置を無効にします。
- パラメータ:
columns - 列数 >= 0
- 例外:
IllegalArgumentException - columns が 0 より小さい場合
getColumnWidth
protected int getColumnWidth()
- 列幅を取得します。フォントによっては、列は弱い意味しか持ちません。このメソッドを使うと、1 列の幅を定義できます。これはデフォルトで、使用フォントの文字「m」の幅で定義されます。このメソッドは、異なる幅になるように再定義できます。
- 戻り値:
- 列幅 >= 1
getPreferredSize
public Dimension getPreferredSize()
- この
TextField に必要とされる適切なサイズ Dimensions を返します。ゼロ以外の列数が設定されていると、その幅は列数を列幅でかけた値に設定されます。
- オーバーライド:
- クラス
JComponent 内の getPreferredSize
- 戻り値:
- このテキストフィールドの寸法
- 関連項目:
JComponent.setPreferredSize(java.awt.Dimension),
ComponentUI
setFont
public void setFont(Font f)
- 現在のフォントを設定します。キャッシュされた行の高さと列の幅を削除するので、新しいフォントの設定が反映されます。
revalidate は、フォント設定後に呼び出されます。
- オーバーライド:
- クラス
JComponent 内の setFont
- パラメータ:
f - 新規フォント- 関連項目:
Component.getFont()
addActionListener
public void addActionListener(ActionListener l)
- 指定されたアクションリスナーを追加して、アクションイベントをこのテキストフィールドから受け取ります。
- パラメータ:
l - 追加されるアクションリスナー
removeActionListener
public void removeActionListener(ActionListener l)
- 指定されたアクションリスナーを削除して、アクションイベントをこのテキストフィールドからそれ以上受け取らないようにします。
- パラメータ:
l - 削除されるアクションリスナー
getActionListeners
public ActionListener[] getActionListeners()
- addActionListener() によってこの JTextField に追加された全
ActionListener の配列を返します。
- 戻り値:
- 追加された
ActionListener のすべて。リスナーが追加されていない場合は、空の配列 - 導入されたバージョン:
- 1.4
fireActionPerformed
protected void fireActionPerformed()
- 通知の配信対象をこのイベント型で登録したすべてのリスナーに通知します。イベントインスタンスが作成されます。リスナーリストは降順方式で処理されます。
- 関連項目:
EventListenerList
setActionCommand
public void setActionCommand(String command)
- アクションイベントに使うコマンド文字列を設定します。
- パラメータ:
command - コマンド文字列
setAction
public void setAction(Action a)
ActionEvent ソースに Action を設定します。新しい Action は設定済みの Action と置き換わりますが、addActionListener で独立して追加された ActionListener には影響しません。Action がすでに ActionEvent ソースにすでに登録されている ActionListener である場合は、再登録されません。
Action を設定すると、ActionEvent ソースのプロパティが、configurePropertiesFromAction メソッドで Action の値を使用して直ちに設定され、続いて createActionPropertyChangeListener メソッドが生成した PropertyChangeListener により、Action のプロパティの変更に従って更新されます。
- パラメータ:
a - JTextField の Action、または null- 導入されたバージョン:
- 1.3
- 関連項目:
Action,
getAction(),
configurePropertiesFromAction(javax.swing.Action),
createActionPropertyChangeListener(javax.swing.Action)
getAction
public Action getAction()
- この
ActionEvent ソースに現在設定されている Action を返します。Action が設定されていない場合は、null が返されます。
- 戻り値:
- この
ActionEvent ソースの Action、または null - 導入されたバージョン:
- 1.3
- 関連項目:
Action,
setAction(javax.swing.Action)
configurePropertiesFromAction
protected void configurePropertiesFromAction(Action a)
Action インスタンスの値に従って ActionEvent ソースのプロパティを設定するファクトリメソッドです。設定されるプロパティはサブクラスによって異なります。デフォルトでは、設定されるプロパティは Enabled および ToolTipText です。
- パラメータ:
a - プロパティを取得する Action、または null- 導入されたバージョン:
- 1.3
- 関連項目:
Action,
setAction(javax.swing.Action)
createActionPropertyChangeListener
protected PropertyChangeListener createActionPropertyChangeListener(Action a)
ActionEvent ソースを Action インスタンスのプロパティの変更に従って更新するのに使う PropertyChangeListener を生成するファクトリメソッドです。最新の状態で保持する必要のあるプロパティのセットがデフォルトプロパティ (Text、Enabled、ToolTipText) と異なる場合は、独自の PropertyChangeListener を提供するためにサブクラスがこのメソッドをオーバーライドすることがあります。
PropertyChangeListener は ActionEvent ソースへの強参照を保持しないようにする必要があります。これは、ActionEvent ソースのガベージコレクションおよびすべての包含関係の階層のコンポーネントを妨害する可能性があるからです。
- パラメータ:
a - プロパティを取得する Action、または null- 導入されたバージョン:
- 1.3
- 関連項目:
Action,
setAction(javax.swing.Action)
getActions
public Action[] getActions()
- エディタのコマンドリストを返します。これは、エディタ自身がサポートするコマンドコレクションで拡張された、プラグイン済み UI によってサポートされるコマンドのリストです。これらは、キーマップ内でのように、イベントへの割り当てに役立ちます。
- オーバーライド:
- クラス
JTextComponent 内の getActions
- 戻り値:
- コマンドリスト
postActionEvent
public void postActionEvent()
- このテキストフィールドで発生するアクションイベントを、登録済みの
ActionListener オブジェクトのどれかにディスパッチすることで処理します。これは一般的に、テキストフィールドに登録されたコントローラによって呼び出されます。
getHorizontalVisibility
public BoundedRangeModel getHorizontalVisibility()
- テキストフィールドの可視性を返します。これを調整すると、フィールドのサイズが割り当てられた可視領域よりも大きい場合にその領域の位置を変更できます。
フィールドの Look & Feel の実装は、BoundedRangeModel の最小値、最大値、長さの各プロパティの値を管理します。
- 戻り値:
- 可視性
- 関連項目:
BoundedRangeModel
getScrollOffset
public int getScrollOffset()
- ピクセル単位のスクロールオフセットを返します。
- 戻り値:
- オフセット >= 0
setScrollOffset
public void setScrollOffset(int scrollOffset)
- ピクセル単位のスクロールオフセットを設定します。
- パラメータ:
scrollOffset - オフセット >= 0
scrollRectToVisible
public void scrollRectToVisible(Rectangle r)
- フィールドを左または右にスクロールします。
- オーバーライド:
- クラス
JComponent 内の scrollRectToVisible
- パラメータ:
r - スクロール対象の範囲- 関連項目:
JViewport
paramString
protected String paramString()
- この
JTextField の文字列表現を返します。このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なります。返される文字列は空の場合がありますが、null にはなりません。
- オーバーライド:
- クラス
JTextComponent 内の paramString
- 戻り値:
- この
JTextField の文字列表現
getAccessibleContext
public AccessibleContext getAccessibleContext()
- この
JTextField に関連する AccessibleContext を返します。JTextFields の場合、AccessibleContext は AccessibleJTextField の形式を取ります。必要に応じて新規の AccessibleJTextField インスタンスが作成されます。
- 定義:
- インタフェース
Accessible 内の getAccessibleContext - オーバーライド:
- クラス
JTextComponent 内の getAccessibleContext
- 戻り値:
- この
JTextField の AccessibleContext として機能する AccessibleJTextField
バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。