モジュール java.desktop
パッケージ java.awt

クラスTextComponent

  • すべての実装されたインタフェース:
    ImageObserver, MenuContainer, Serializable, Accessible
    直系の既知のサブクラス:
    TextArea, TextField

    public class TextComponent
extends Component
implements Accessible
    TextComponentクラスは、一部のテキストの編集を可能にするすべてのコンポーネントのスーパー・クラスです。

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

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

    導入されたバージョン:
    1.0
    関連項目:
    直列化された形式

    • フィールドの詳細

      • textListener

        protected transient TextListener textListener
        このオブジェクトからイベントを受け取るリスナーのリスト。

    • メソッドの詳細

      • enableInputMethods

        public void enableInputMethods​(boolean enable)
        このテキスト・コンポーネントのインプット・メソッド・サポートを使用可能または使用不可能にします。 インプット・メソッド・サポートが使用可能で、テキスト・コンポーネントがキー・イベントも処理する場合、入力イベントは現在のインプット・メソッドに提供され、そのコンポーネントによってだけ処理されるか、インプット・メソッドが使用しなければ、そのリスナーに送られます。 このテキスト・コンポーネントのインプット・メソッド・サポートがデフォルトで有効であるか無効であるか、またその方法は実装に依存します。
        オーバーライド:
        enableInputMethods、クラス: Component
        パラメータ:
        enable - 有効にするにはtrue、無効にするにはfalse
        導入されたバージョン:
        1.2
        関連項目:
        Component.processKeyEvent(java.awt.event.KeyEvent)

      • getInputMethodRequests

        public InputMethodRequests getInputMethodRequests​()
        クラスからコピーされた説明: Component
        このコンポーネントのインプット・メソッドからの要求をサポートするインプット・メソッド要求ハンドラを取得します。 オンザスポット・テキスト入力をサポートするコンポーネントでInputMethodRequestsインスタンスを返すには、このメソッドをオーバーライドする必要があります。 同時に、インプット・メソッド・イベントを処理する必要もあります。
        オーバーライド:
        getInputMethodRequests、クラス: Component
        戻り値:
        このコンポーネントのインプット・メソッド要求ハンドラ、デフォルトではnull
        関連項目:
        Component.addInputMethodListener(java.awt.event.InputMethodListener)

      • addNotify

        public void addNotify​()
        ネイティブ・スクリーン・リソースに接続して、このComponentを表示可能にします。 このメソッドは、ツールキットによって内部で呼び出され、プログラムから直接呼び出されることはありません。
        オーバーライド:
        addNotify、クラス: Component
        関連項目:
        removeNotify()

      • 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。
        導入されたバージョン:
        1.0
        関連項目:
        setEditable(boolean)

      • setEditable

        public void setEditable​(boolean b)
        このテキスト・コンポーネントが編集可能かどうかを指定するフラグを設定します。

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

        パラメータ:
        b - このテキスト・コンポーネントがユーザーにより編集可能かどうかを示すフラグ。
        導入されたバージョン:
        1.0
        関連項目:
        isEditable()

      • getBackground

        public Color getBackground​()
        このテキスト・コンポーネントのバックグラウンド・カラーを返します。 デフォルトで、編集不可能なテキスト・コンポーネントはSystemColor.controlのバックグラウンド・カラーを持ちます。 このデフォルトはsetBackgroundの呼出しによってオーバーライドできます。
        オーバーライド:
        getBackground、クラス: Component
        戻り値:
        このテキスト・コンポーネントのバックグラウンド・カラー。 このテキスト・コンポーネントにバックグラウンド・カラーがない場合は、親のバックグラウンド・カラーが返される
        導入されたバージョン:
        1.0
        関連項目:
        setBackground(Color)

      • setBackground

        public void setBackground​(Color c)
        このテキスト・コンポーネントのバックグラウンド・カラーを設定します。
        オーバーライド:
        setBackground、クラス: Component
        パラメータ:
        c - このテキスト・コンポーネントの色になる色。 このパラメータがnullの場合、このテキスト・コンポーネントは親のバックグラウンド・カラーを継承する
        導入されたバージョン:
        1.0
        関連項目:
        getBackground()

      • getSelectionStart

        public int getSelectionStart​()
        このテキスト・コンポーネントの選択テキストの始点を返します。
        戻り値:
        選択テキストの始点
        関連項目:
        setSelectionStart(int), getSelectionEnd()

      • setSelectionStart

        public void setSelectionStart​(int selectionStart)
        このテキスト・コンポーネントの選択範囲の始点を、指定された位置に設定します。 新しい始点は現在の選択範囲の終点以前に制限されます。 また、コンポーネントのテキストの先頭を示す0より小さい値に設定することはできません。 呼出し元が、範囲外であるselectionStartの値を指定した場合でも、このメソッドは暗黙のうちに、かつ失敗することなくこれらの制約を適用します。
        パラメータ:
        selectionStart - 選択テキストの始点
        導入されたバージョン:
        1.1
        関連項目:
        getSelectionStart(), setSelectionEnd(int)

      • getSelectionEnd

        public int getSelectionEnd​()
        このテキスト・コンポーネントの選択テキストの終点を返します。
        戻り値:
        選択テキストの終点
        関連項目:
        setSelectionEnd(int), getSelectionStart()

      • setSelectionEnd

        public void setSelectionEnd​(int selectionEnd)
        このテキスト・コンポーネントの選択範囲の終点を、指定された位置に設定します。 新しい末尾は、現在の選択領域の先頭またはそのあとに限定されます。 また、コンポーネントのテキストの末尾を超える値に設定することはできません。 呼出し元が、範囲外であるselectionEndの値を指定した場合でも、このメソッドは暗黙のうちに、かつ失敗することなくこれらの制約を適用します。
        パラメータ:
        selectionEnd - 選択テキストの終点
        導入されたバージョン:
        1.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がゼロより小さい場合
        導入されたバージョン:
        1.1

      • getCaretPosition

        public int getCaretPosition​()
        テキスト挿入キャレットの位置を返します。 キャレット位置は0からテキストの末尾の文字までに制約されます。 テキストまたはキャレットが設定されていない場合、デフォルトのキャレット位置は0です。
        戻り値:
        テキスト挿入キャレットの位置
        導入されたバージョン:
        1.1
        関連項目:
        setCaretPosition(int)

      • addTextListener

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

        AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。

        パラメータ:
        l - テキスト・イベント・リスナー
        関連項目:
        removeTextListener(java.awt.event.TextListener), getTextListeners(), TextListener

      • removeTextListener

        public void removeTextListener​(TextListener l)
        指定されたテキスト・イベント・リスナーを削除して、このテキスト・コンポーネントからテキスト・イベントが受信されなくなるようにします。lがnullである場合、例外はスローされず、何も処理は行われません。

        AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。

        パラメータ:
        l - テキスト・リスナー
        導入されたバージョン:
        1.1
        関連項目:
        addTextListener(java.awt.event.TextListener), getTextListeners(), 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));
        このようなリスナーがない場合は空の配列を返します。
        オーバーライド:
        getListeners、クラス: Component
        型パラメータ:
        T - リスナーの型
        パラメータ:
        listenerType - 要求されるリスナーの型。java.util.EventListenerの子孫のインタフェースを指定してください
        戻り値:
        このテキスト・コンポーネントにFooListenerとして登録されているすべてのオブジェクトの配列。そのようなリスナーが登録されていない場合は空の配列
        例外:
        ClassCastException - listenerTypeで、java.util.EventListenerを実装するクラスまたはインタフェースが指定されなかった場合
        導入されたバージョン:
        1.3
        関連項目:
        getTextListeners()

      • processTextEvent

        protected void processTextEvent​(TextEvent e)
        このテキスト・コンポーネントで発生するテキスト・イベントを、登録されているすべてのTextListenerオブジェクトにディスパッチすることによって処理します。

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

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

        イベント・パラメータがnullである場合は、動作が未指定のため、例外が発生する可能性があります。

        パラメータ:
        e - テキスト・イベント
        関連項目:
        Component.enableEvents(long)

      • paramString

        protected String paramString​()
        このTextComponentの状態を表す文字列を返します。 このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なる場合があります。 返される文字列は空の場合がありますが、nullにはなりません。
        オーバーライド:
        paramString、クラス: Component
        戻り値:
        このテキスト・コンポーネントのパラメータ文字列

      • getAccessibleContext

        public AccessibleContext getAccessibleContext​()
        このTextComponentに関連付けられたAccessibleContextを取得します。 テキスト・コンポーネントの場合、AccessibleContextはAccessibleAWTTextComponentの形式を取ります。 必要に応じて新規のAccessibleAWTTextComponentインスタンスが作成されます。
        定義:
        getAccessibleContext、インタフェース: Accessible
        オーバーライド:
        getAccessibleContext、クラス: Component
        戻り値:
        このTextComponentのAccessibleContextとして機能するAccessibleAWTTextComponent
        導入されたバージョン:
        1.3