java.awt
クラス TextComponent

java.lang.Object
  java.awt.Component
      java.awt.TextComponent

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

ImageObserver, MenuContainer, Serializable, Accessible

直系の既知のサブクラス:

TextArea, TextField

public class TextComponent
extends Component
implements Accessible

TextComponent クラスは、テキストの編集を可能にするすべてのコンポーネントのスーパークラスです。

テキストコンポーネントはテキストの文字列を具体的に表現します。TextComponent クラスは、このテキストが編集可能であるかどうかを判定するメソッドセットを定義します。コンポーネントが編集可能である場合は、テキスト挿入キャレットをサポートする別のメソッドセットも定義します。

また、このクラスは、テキストの現在の「選択範囲」を保持するために使用されるメソッドも定義します。コンポーネントのテキストの部分テキストであるテキストの選択範囲は、編集操作の対象となります。テキストの選択範囲は、「選択テキスト」とも呼ばれます。

導入されたバージョン:

JDK1.0

関連項目:

直列化された形式

入れ子のクラスの概要

protected class

TextComponent.AccessibleAWTTextComponent このクラスは TextComponent クラス用のアクセシビリティーのサポートを実装しています。

クラス java.awt.Component から継承された入れ子のクラス/インタフェース

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

フィールドの概要

protected TextListener

textListener

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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

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

メソッドの概要

void	addNotify() ネイティブスクリーンリソースに接続して、この Component を表示可能にします。
void	addTextListener(TextListener l) このテキストコンポーネントからテキストイベントを受け取るために、指定されたテキストイベントリスナーを追加します。
void	enableInputMethods(boolean enable) このテキストコンポーネントのインプットメソッドサポートを使用可能または使用不可能にします。
AccessibleContext	getAccessibleContext() この TextComponent に関連した AccessibleContext を返します。
Color	getBackground() このテキストコンポーネントのバックグラウンドカラーを返します。
int	getCaretPosition() テキスト挿入キャレットの位置を返します。
InputMethodRequests	getInputMethodRequests() このコンポーネントのインプットメソッドからの要求をサポートするインプットメソッド要求ハンドラを返します。
<T extends EventListener> T[]	getListeners(Class<T> listenerType) この TextComponent に FooListener として、現在登録されているすべてのオブジェクトの配列を返します。
String	getSelectedText() このテキストコンポーネントによって表示されるテキストから選択テキストを返します。
int	getSelectionEnd() このテキストコンポーネントの選択テキストの終点を返します。
int	getSelectionStart() このテキストコンポーネントの選択テキストの始点を返します。
String	getText() このテキストコンポーネントによって表示されるテキストを返します。
TextListener[]	getTextListeners() このテキストコンポーネントに登録されたすべてのテキストリスナーの配列を返します。
boolean	isEditable() このテキストコンポーネントが編集可能であるかどうかを示します。
protected String	paramString() この TextComponent の状態を表す文字列を返します。
protected void	processEvent(AWTEvent e) このテキストコンポーネントのイベントを処理します。
protected void	processTextEvent(TextEvent e) このテキストコンポーネントで発生するアクションイベントを、登録された TextListener オブジェクトにディスパッチすることにより、アクションイベントを処理します。
void	removeNotify() TextComponent のピアを削除します。
void	removeTextListener(TextListener l) 以降このテキストコンポーネントからテキストイベントを受け取らないように、指定されたテキストイベントリスナーを削除します。
void	select(int selectionStart, int selectionEnd) 指定された始点と終点の間にあるテキストを選択します。
void	selectAll() このテキストコンポーネント内のすべてのテキストを選択します。
void	setBackground(Color c) このテキストコンポーネントのバックグラウンドカラーを設定します。
void	setCaretPosition(int position) テキスト挿入キャレットの位置を設定します。
void	setEditable(boolean b) このテキストコンポーネントが編集可能かどうかを指定するフラグを設定します。
void	setSelectionEnd(int selectionEnd) このテキストコンポーネントの選択範囲の終点を、指定された位置に設定します。
void	setSelectionStart(int selectionStart) このテキストコンポーネントの選択範囲の始点を、指定された位置に設定します。
void	setText(String t) このテキストコンポーネントで表示されるテキストを、指定されたテキストに設定します。

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

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

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

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

フィールドの詳細

textListener

protected transient TextListener textListener

メソッドの詳細

enableInputMethods

public void enableInputMethods(boolean enable)

このテキストコンポーネントのインプットメソッドサポートを使用可能または使用不可能にします。インプットメソッドサポートが使用可能で、テキストコンポーネントがキーイベントも処理する場合、入力イベントは現在のインプットメソッドに提供され、そのコンポーネントによってだけ処理されるか、インプットメソッドが使用しなければ、そのリスナーに送られます。このテキストコンポーネントのインプットメソッドサポートがデフォルトで有効であるか無効であるか、またその方法は実装に依存します。

オーバーライド:

クラス Component 内の enableInputMethods

パラメータ:

enable - 使用可能にするには true、使用不可能にするには false

導入されたバージョン:

1.2

関連項目:

Component.processKeyEvent(java.awt.event.KeyEvent)

getInputMethodRequests

public InputMethodRequests getInputMethodRequests()

クラス Component の記述:

このコンポーネントのインプットメソッドからの要求をサポートするインプットメソッド要求ハンドラを返します。オンザスポットテキスト入力をサポートするコンポーネントは、InputMethodRequests のインスタンスを返すためにはこのメソッドをオーバーライドする必要があります。同時に、インプットメソッドイベントを処理する必要もあります。

オーバーライド:

クラス Component 内の getInputMethodRequests

戻り値:

このコンポーネントのインプットメソッド要求ハンドラ。デフォルトでは null

関連項目:

Component.addInputMethodListener(java.awt.event.InputMethodListener)

addNotify

public void addNotify()

ネイティブスクリーンリソースに接続して、この Component を表示可能にします。このメソッドは、ツールキットによって内部で呼び出されます。 プログラムが直接呼び出すことはできません。

オーバーライド:

クラス Component 内の addNotify

関連項目:

removeNotify()

removeNotify

public void removeNotify()

TextComponent のピアを削除します。ピアは、TextComponent の機能を変えずに外観を変更することができます。

オーバーライド:

クラス Component 内の removeNotify

関連項目:

Component.isDisplayable(), Component.addNotify()

setText

public void setText(String t)

このテキストコンポーネントで表示されるテキストを、指定されたテキストに設定します。

パラメータ:

t - 新しいテキスト。このパラメータが null の場合、テキストは空の文字列 "" に設定される

関連項目:

getText()

getText

public String getText()

このテキストコンポーネントによって表示されるテキストを返します。デフォルトでこれは空の文字列です。

戻り値:

この TextComponent の値

関連項目:

setText(java.lang.String)

getSelectedText

public String getSelectedText()

このテキストコンポーネントによって表示されるテキストから選択テキストを返します。

戻り値:

このテキストコンポーネントの選択テキスト

関連項目:

select(int, int)

isEditable

public boolean isEditable()

このテキストコンポーネントが編集可能であるかどうかを示します。

戻り値:

このテキストコンポーネントが編集可能である場合は true、そうでない場合は false

導入されたバージョン:

JDK1.0

関連項目:

setEditable(boolean)

setEditable

public void setEditable(boolean b)

このテキストコンポーネントが編集可能かどうかを指定するフラグを設定します。

フラグが true に設定されている場合、テキストコンポーネントはユーザーによる編集が可能になります。フラグが false に設定されている場合、ユーザーはこのテキストコンポーネントのテキストを変更できません。デフォルトで、編集不可能なテキストコンポーネントは SystemColor.control のバックグラウンドカラーを持ちます。このデフォルトは setBackground の呼び出しによってオーバーライドできます。

パラメータ:

b - このテキストコンポーネントがユーザーにより編集可能かどうかを示すフラグ

導入されたバージョン:

JDK1.0

関連項目:

isEditable()

getBackground

public Color getBackground()

このテキストコンポーネントのバックグラウンドカラーを返します。 デフォルトで、編集不可能なテキストコンポーネントは SystemColor.control のバックグラウンドカラーを持ちます。このデフォルトは setBackground の呼び出しによってオーバーライドできます。

オーバーライド:

クラス Component 内の getBackground

戻り値:

このテキストコンポーネントのバックグラウンドカラー。このテキストコンポーネントにバックグラウンドカラーがない場合は、親のバックグラウンドカラーが返される

導入されたバージョン:

JDK1.0

関連項目:

setBackground(Color)

setBackground

public void setBackground(Color c)

このテキストコンポーネントのバックグラウンドカラーを設定します。

オーバーライド:

クラス Component 内の setBackground

パラメータ:

c - このテキストコンポーネントの色になる色。このパラメータが null の場合、このテキストコンポーネントは親のバックグラウンドカラーを継承する

導入されたバージョン:

JDK1.0

関連項目:

getBackground()

getSelectionStart

public int getSelectionStart()

このテキストコンポーネントの選択テキストの始点を返します。

戻り値:

選択テキストの始点

関連項目:

setSelectionStart(int), getSelectionEnd()

setSelectionStart

public void setSelectionStart(int selectionStart)

このテキストコンポーネントの選択範囲の始点を、指定された位置に設定します。新しい始点は現在の選択範囲の終点以前に制限されます。また、コンポーネントのテキストの先頭を示す 0 より小さい値に設定することはできません。呼び出し側が指定した selectionStart の値が境界外である場合でも、このメソッドは、失敗することなく、暗黙的にこれらの制約を適用します。

パラメータ:

selectionStart - 選択テキストの始点

導入されたバージョン:

JDK1.1

関連項目:

getSelectionStart(), setSelectionEnd(int)

getSelectionEnd

public int getSelectionEnd()

このテキストコンポーネントの選択テキストの終点を返します。

戻り値:

選択テキストの終点

関連項目:

setSelectionEnd(int), getSelectionStart()

setSelectionEnd

public void setSelectionEnd(int selectionEnd)

このテキストコンポーネントの選択範囲の終点を、指定された位置に設定します。新しい末尾は、現在の選択領域の先頭またはそのあとに限定されます。また、コンポーネントのテキストの末尾を超える値に設定することはできません。呼び出し側が指定した selectionEnd の値が境界外である場合でも、このメソッドは、失敗することなく、暗黙的にこれらの制約を適用します。

パラメータ:

selectionEnd - 選択テキストの終点

導入されたバージョン:

JDK1.1

関連項目:

getSelectionEnd(), setSelectionStart(int)

select

public void select(int selectionStart,
                   int selectionEnd)

指定された始点と終点の間にあるテキストを選択します。

このメソッドは選択テキストの始点と終点を設定します。 始点は 0 以上でなければならないという制約が適用されます。終点は始点と同じか、それより大きい値でなければならず、またテキストコンポーネントのテキストの長さに等しいか、それより短くなければいけません。文字の位置は、ゼロから始まるインデックスで指定します。選択範囲の長さは、 endPosition - startPosition です。 そのため、endPosition にある文字は選択されません。選択テキストの始点と終点が同じ場合は、すべてのテキストの選択が解除されます。

呼び出し側が一貫性のない値または境界外の値を指定した場合、メソッドはメッセージを表示せずに、これらの制約を適用します。具体的には、始点または終点がテキストの長さを超える場合、テキストと同じ長さに設定し直します。始点がゼロより小さい場合、ゼロに設定し直します。 終点が始点より小さい場合、始点に設定し直します。

パラメータ:

selectionStart - 選択される最初の文字 (char 値) のゼロから始まるインデックス

selectionEnd - 選択されるテキストの終点を示すゼロから始まるインデックス。selectionEnd にある文字 (char 値) は選択されない

関連項目:

setSelectionStart(int), setSelectionEnd(int), selectAll()

selectAll

public void selectAll()

このテキストコンポーネント内のすべてのテキストを選択します。

関連項目:

select(int, int)

setCaretPosition

public void setCaretPosition(int position)

テキスト挿入キャレットの位置を設定します。キャレット位置は 0 からテキストの末尾の文字までに制約されます。渡された値がこの範囲より大きい場合、値は最後の文字 (または TextComponent にテキストが格納されていない場合は 0) が設定され、エラーは返されません。渡された値が 0 より小さい場合は、 IllegalArgumentException がスローされます。

パラメータ:

position - テキスト挿入キャレットの位置

例外:

IllegalArgumentException - position が 0 未満の場合

導入されたバージョン:

JDK1.1

getCaretPosition

public int getCaretPosition()

テキスト挿入キャレットの位置を返します。キャレット位置は 0 からテキストの末尾の文字までに制約されます。テキストまたはキャレットが設定されていない場合、デフォルトのキャレット位置は 0 です。

戻り値:

テキスト挿入キャレットの位置

導入されたバージョン:

JDK1.1

関連項目:

setCaretPosition(int)

addTextListener

public void addTextListener(TextListener l)

このテキストコンポーネントからテキストイベントを受け取るために、指定されたテキストイベントリスナーを追加します。l が null の場合、例外はスローされず、処理も実行されません。

AWT スレッドモデルの詳細については、「AWT Threading Issues」を参照してください。

パラメータ:

l - テキストイベントリスナー

関連項目:

removeTextListener(java.awt.event.TextListener), getTextListeners(), TextListener

removeTextListener

public void removeTextListener(TextListener l)

以降このテキストコンポーネントからテキストイベントを受け取らないように、指定されたテキストイベントリスナーを削除します。l が null の場合、例外はスローされず、処理も実行されません。

AWT スレッドモデルの詳細については、「AWT Threading Issues」を参照してください。

パラメータ:

l - テキストリスナー

導入されたバージョン:

JDK1.1

関連項目:

addTextListener(java.awt.event.TextListener), getTextListeners(), TextListener

getTextListeners

public TextListener[] getTextListeners()

このテキストコンポーネントに登録されたすべてのテキストリスナーの配列を返します。

戻り値:

このテキストコンポーネントのすべての TextListener、または現在テキストリスナーが登録されていない場合は空の配列

導入されたバージョン:

1.4

関連項目:

addTextListener(java.awt.event.TextListener), removeTextListener(java.awt.event.TextListener)

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)

この TextComponent に FooListener として、現在登録されているすべてのオブジェクトの配列を返します。FooListener は、addFooListener メソッドを使用して登録します。

FooListener.class といったクラスリテラルを使用して、listenerType 引数を指定できます。たとえば、次のコードを使用して、そのテキストリスナーの TextComponent t を照会できます。

TextListener[] tls = (TextListener[])(t.getListeners(TextListener.class));

このようなリスナーがない場合は空の配列を返します。

オーバーライド:

クラス Component 内の getListeners

パラメータ:

listenerType - 要求されるリスナーの型。java.util.EventListener の下位インタフェースを指定

戻り値:

このテキストコンポーネントに FooListener として登録されているすべてのオブジェクトの配列。リスナーが追加されていない場合は空の配列を返す

例外:

ClassCastException - listenerType が java.util.EventListener を実装するクラスまたはインタフェースを指定しない場合

導入されたバージョン:

1.3

関連項目:

getTextListeners()

processEvent

protected void processEvent(AWTEvent e)

このテキストコンポーネントのイベントを処理します。イベントが TextEvent の場合、processTextEvent メソッドを起動します。 その他の場合は、スーパークラスの processEvent を起動します。

イベントパラメータが null の場合の動作は定義されていないため例外がスローされます。

オーバーライド:

クラス Component 内の processEvent

パラメータ:

e - イベント

関連項目:

Component.processComponentEvent(java.awt.event.ComponentEvent), Component.processFocusEvent(java.awt.event.FocusEvent), Component.processKeyEvent(java.awt.event.KeyEvent), Component.processMouseEvent(java.awt.event.MouseEvent), Component.processMouseMotionEvent(java.awt.event.MouseEvent), Component.processInputMethodEvent(java.awt.event.InputMethodEvent), Component.processHierarchyEvent(java.awt.event.HierarchyEvent), Component.processMouseWheelEvent(java.awt.event.MouseWheelEvent)

processTextEvent

protected void processTextEvent(TextEvent e)

このテキストコンポーネントで発生するアクションイベントを、登録された TextListener オブジェクトにディスパッチすることにより、アクションイベントを処理します。

注:このメソッドは、テキストイベントがこのコンポーネントに対して有効でない場合は呼び出されません。これは次のいずれか 1 つが発生した場合に実行されます。

• TextListener オブジェクトが addTextListener によって登録されている
• enableEvents によってテキストイベントが使用可能になっている

イベントパラメータが null の場合の動作は定義されていないため例外がスローされます。

パラメータ:

e - テキストイベント

関連項目:

Component.enableEvents(long)

paramString

protected String paramString()

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

オーバーライド:

クラス Component 内の paramString

戻り値:

このテキストコンポーネントのパラメータ文字列

getAccessibleContext

public AccessibleContext getAccessibleContext()

この TextComponent に関連した AccessibleContext を返します。テキストコンポーネントの場合、AccessibleContext は AccessibleAWTTextComponent の形式を取ります。必要に応じて新規の AccessibleAWTTextComponent インスタンスが作成されます。

定義:

インタフェース Accessible 内の getAccessibleContext

オーバーライド:

クラス Component 内の getAccessibleContext

戻り値:

この TextComponent の AccessibleContext として機能する AccessibleAWTTextComponent

導入されたバージョン:

1.3