java.awt
クラス TextComponent

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.TextComponent

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

TextArea, TextField

public class TextComponent

extends Component

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

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

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

導入されたバージョン:

JDK1.0

関連項目:

直列化された形式

フィールドの概要

protected TextListener

textListener

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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

メソッドの概要

void	addTextListener(TextListener l) このテキストコンポーネントからテキストイベントを受け取るために、指定されたテキストイベントリスナーを追加します。
int	getCaretPosition() このテキストコンポーネントのテキスト挿入キャレットの位置を取得します。
String	getSelectedText() このテキストコンポーネントによって表示されるテキストから選択テキストを取得します。
int	getSelectionEnd() このテキストコンポーネントの選択テキストの終点を取得します。
int	getSelectionStart() このテキストコンポーネントの選択テキストの始点を取得します。
String	getText() このテキストコンポーネントによって表示されるテキストを取得します。
boolean	isEditable() このテキストコンポーネントが編集可能であるかどうかを示します。
protected String	paramString() このテキストコンポーネントの状態を表すパラメータの文字列を返します。
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	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, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, 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, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate

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

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

フィールドの詳細

textListener

protected transient TextListener textListener

メソッドの詳細

removeNotify

public void removeNotify()

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

オーバーライド:

クラス Component 内の removeNotify

setText

public void setText(String t)

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

パラメータ:

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

関連項目:

getText()

getText

public String getText()

このテキストコンポーネントによって表示されるテキストを取得します。

関連項目:

setText(java.lang.String)

getSelectedText

public String getSelectedText()

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

戻り値:

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

関連項目:

select(int, int)

isEditable

public boolean isEditable()

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

戻り値:

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

導入されたバージョン:

JDK1ble

関連項目:

setEditable(boolean)

setEditable

public void setEditable(boolean b)

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

フラグが true に設定されている場合、ユーザはこのテキストコンポーネントを編集できます。フラグが false に設定されている場合、ユーザはこのテキストコンポーネントのテキストを変更できません。

パラメータ:

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

関連項目:

isEditable()

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)

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

パラメータ:

selectionEnd - 選択テキストの終点

導入されたバージョン:

JDK1.1

関連項目:

getSelectionEnd(), setSelectionStart(int)

select

public void select(int selectionStart,
                   int selectionEnd)

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

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

パラメータ:

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

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

関連項目:

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

selectAll

public void selectAll()

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

関連項目:

select(int, int)

setCaretPosition

public void setCaretPosition(int position)

このテキストコンポーネントのテキスト挿入キャレットの位置を設定します。

パラメータ:

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

例外:

IllegalArgumentException - position に指定された値が 0 未満の場合

導入されたバージョン:

JDK1.1

getCaretPosition

public int getCaretPosition()

このテキストコンポーネントのテキスト挿入キャレットの位置を取得します。

戻り値:

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

導入されたバージョン:

JDK1.1

addTextListener

public void addTextListener(TextListener l)

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

パラメータ:

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

removeTextListener

public void removeTextListener(TextListener l)

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

パラメータ:

l - テキストリスナー

導入されたバージョン:

JDK1.1

関連項目:

TextListener, java.awt.Button#addTextListener

processEvent

protected void processEvent(AWTEvent e)

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

パラメータ:

e - イベント

オーバーライド:

クラス Component 内の processEvent

processTextEvent

protected void processTextEvent(TextEvent e)

このテキストコンポーネントで発生するテキストイベントを、登録された TextListener オブジェクトにディスパッチすることにより、テキストイベントを処理します。注：このメソッドは、このコンポーネントに対してテキストイベントが有効になっていなければ呼び出されません。次のどれかの場合に有効になります。

1. addTextListener() によって TextListener オブジェクトが登録されている
2. enableEvents() によってテキストイベントが有効になっている

パラメータ:

e - テキストイベント

関連項目:

Component.enableEvents(long)

paramString

protected String paramString()

このテキストコンポーネントの状態を表すパラメータの文字列を返します。この文字列はデバッグに使用します。

戻り値:

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

オーバーライド:

クラス Component 内の paramString