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

クラスList

java.lang.Object
java.awt.Component
java.awt.List
すべての実装されたインタフェース:
ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible
public class List extends Component implements ItemSelectable, Accessible
Listコンポーネントは、ユーザーにテキスト項目のスクロール・リストを提供します。 リストは、1つまたは複数の項目が選択できるように設定できます。

たとえば、次のコードは . . . 

 List lst = new List(4, false);
 lst.add("Mercury");
 lst.add("Venus");
 lst.add("Earth");
 lst.add("JavaSoft");
 lst.add("Mars");
 lst.add("Jupiter");
 lst.add("Saturn");
 lst.add("Uranus");
 lst.add("Neptune");
 lst.add("Pluto");
 cnt.add(lst);

コンテナがcntの場合は、次のスクロール・リストを作成します。

Venus、Earth、Java Software、およびMarsを含むリストを示す。 Java Softwareが選択されている。

Listが複数選択を許可する場合に、すでに選択されている項目をクリックすると、選択が解除されます。 前の例では、新しいスクロール・リストの作成時に2番目の引数がfalseであるため、スクロール・リストから一度に選択できる項目は1つに限られます。 Listが複数選択を許可しない場合、項目を選択すると、ほかの選択された項目の選択が解除されます。

この例に示されるリストは、可視の4行で作成されます。 リストが作成されると、表示行の数は変更できません。 デフォルトのListは、lst = new List()がlist = new List(4, false)と同等になるように4行で作成されます。

Java 1.1から、Abstract Window Toolkitは、Listオブジェクトにそこで発生するすべてのマウス、キーボード、フォーカス・イベントを送ります。 下位互換性のために古いAWTイベント・モデルが保持されていますが、それを使用することは非推奨です。

ユーザーによって項目が選択または選択解除されるときには、AWTはItemEventのインスタンスをリストに送ります。 ユーザーがスクロール・リストの項目をダブルクリックすると、AWTは項目イベントに続いてActionEventのインスタンスをリストに送ります。 AWTは同時に、リスト内の項目が選択されている間にReturnキーが押されるとアクション・イベントを生成します。

ユーザーが選択したかまたはアクティブ化したこのリスト内の項目に基づいてアプリケーションが特定のアクションを実行しようとする場合は、ItemListenerまたはActionListenerを必要に応じて実装して、このリストからイベントを受け取る新しいリスナーを登録します。

複数選択のスクロール・リストでは、それは外部のジェスチャ(ボタンのクリックなど)を使ってアクションをトリガーするのに最適なユーザー・インタフェースと見なされます。

導入されたバージョン:
1.0
関連項目:

  • コンストラクタの詳細

    • List

      public List() throws HeadlessException
      新しいスクロール・リストを作成します。 デフォルトでは、4行が表示されており、複数の選択はできません。 これはList(0, false)の簡易メソッドです。 また、リストに表示される行数は、作成後に変更できません。
      例外:
      HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返した場合。
      関連項目:

    • List

      public List(int rows) throws HeadlessException
      指定された表示行の数により初期化された新しいスクロール・リストを作成します。 デフォルトでは、複数の選択はできません。 これはList(rows, false)の簡易メソッドです。 また、リストに表示される行数は作成後に変更できません。
      パラメータ:
      rows - 表示する項目の数。
      例外:
      HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返した場合。
      導入されたバージョン:
      1.1
      関連項目:

    • List

      public List(int rows, boolean multipleMode) throws HeadlessException
      指定された行数を表示するように初期化された新しいスクロール・リストを作成します。 行数0が指定された場合、リストはデフォルトの4行で作成されます。 また、リストに表示される行数は作成後に変更できません。 multipleModeの値がtrueの場合、ユーザーはリストから複数の項目を選択できます。 falseの場合、一度に1項目のみ選択できます。
      パラメータ:
      rows - 表示する項目の数。
      multipleMode - trueの場合、複数選択が許可される。そうでない場合、リストから同時に選択できる項目は1つだけ。
      例外:
      HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返した場合。
      関連項目:

  • メソッドの詳細

    • addNotify

      public void addNotify()
      リストのピアを作成します。 ピアを使用すると、その機能性を変更せずに外観を変更することができます。
      オーバーライド:
      addNotify、クラスComponent
      関連項目:

    • removeNotify

      public void removeNotify()
      このリストのピアを削除します。 ピアを使用すると、その機能性を変更せずに外観を変更することができます。
      オーバーライド:
      removeNotify、クラスComponent
      関連項目:

    • getItemCount

      public int getItemCount()
      リスト内の項目の数を返します。
      戻り値:
      リスト内の項目の数
      導入されたバージョン:
      1.1
      関連項目:

    • countItems

      @Deprecated public int countItems()
      非推奨。
      JDK Version 1.1以降は、getItemCount()に置き換えられています。
      リスト内の項目の数を返します。
      戻り値:
      リスト内の項目の数

    • getItem

      public String getItem(int index)
      指定するインデックスに対応する項目を返します。
      パラメータ:
      index - 項目の位置
      戻り値:
      指定されたインデックスに関連付けられた項目
      関連項目:

    • getItems

      public String[] getItems()
      リスト内の項目を返します。
      戻り値:
      リストの項目を格納する文字列の配列
      導入されたバージョン:
      1.1
      関連項目:

    • add

      public void add(String item)
      指定された項目をスクロール・リストの末尾に追加します。
      パラメータ:
      item - 追加される項目
      導入されたバージョン:
      1.1

    • addItem

      @Deprecated public void addItem(String item)
      非推奨。
      add(String)に置き換えられています。
      指定されたアイテムをリストの最後に追加します。
      パラメータ:
      item - 追加される項目

    • add

      public void add(String item, int index)
      インデックスで指定された位置のスクロール・リストに指定されたアイテムを追加します。 インデックスはゼロから始まります。 インデックスの値がゼロより小さい場合、またはリスト内の項目数以上の場合は、その項目はリストの末尾に追加されます。
      パラメータ:
      item - 追加される項目。このパラメータがnullの場合、項目は空の文字列""として扱われる
      index - 項目を追加する位置
      導入されたバージョン:
      1.1

    • addItem

      @Deprecated public void addItem(String item, int index)
      非推奨。
      add(String, int)に置き換えられています。
      指定されたアイテムをインデックスで指定された位置のリストに追加します。
      パラメータ:
      item - 追加される項目
      index - 項目を追加する位置

    • replaceItem

      public void replaceItem(String newValue, int index)
      スクロール・リスト内の指定されたインデックスにある項目を新しい文字列で置き換えます。
      パラメータ:
      newValue - 既存の項目を置き換える新しい文字列
      index - 置き換える項目の位置
      例外:
      ArrayIndexOutOfBoundsException - indexが範囲外の場合

    • removeAll

      public void removeAll()
      このリストからすべての項目を削除します。
      導入されたバージョン:
      1.1
      関連項目:

    • clear

      @Deprecated public void clear()
      非推奨。
      JDK Version 1.1以降は、removeAll()に置き換えられています。

    • remove

      public void remove(String item)
      リスト中の同じ項目のうち最初に出現したものを削除します。 指定された項目が選択されており、それがリスト内で唯一選択された項目である場合、リストの選択はなくなります。
      パラメータ:
      item - リストから削除される項目
      例外:
      IllegalArgumentException - その項目がリストに存在しない場合
      導入されたバージョン:
      1.1

    • remove

      public void remove(int position)
      指定された位置にある項目をこのスクロール・リストから削除します。 指定された位置の項目が選択されており、それがリスト内で唯一選択された項目である場合、リストの選択はなくなります。
      パラメータ:
      position - 削除される項目のインデックス
      例外:
      ArrayIndexOutOfBoundsException - positionが0より小さいか、getItemCount()-1より大きい場合
      導入されたバージョン:
      1.1
      関連項目:

    • delItem

      @Deprecated public void delItem(int position)
      非推奨。
      remove(String)およびremove(int)に置き換えられています。
      指定された位置にあるアイテムを削除します。
      パラメータ:
      position - 削除される項目のインデックス

    • getSelectedIndex

      public int getSelectedIndex()
      リストで選択されている項目のインデックスを返します。
      戻り値:
      選択された項目のインデックス。項目が選択されていない場合、または複数の項目が選択された場合は、-1が返される。
      関連項目:

    • getSelectedIndexes

      public int[] getSelectedIndexes()
      リストで選択されているインデックスを返します。
      戻り値:
      このスクロール・リストで選択されているインデックスの配列。項目が選択されていない場合は、長さゼロの配列が返される
      関連項目:

    • getSelectedItem

      public String getSelectedItem()
      このスクロール・リストで選択されている項目を返します。
      戻り値:
      リストで選択されている項目。項目が選択されていない場合、または複数の項目が選択された場合は、nullが返される。
      関連項目:

    • getSelectedItems

      public String[] getSelectedItems()
      このスクロール・リストで選択されている項目を返します。
      戻り値:
      このスクロール・リストで選択されている項目の配列。項目が選択されていない場合は、長さゼロの配列が返される
      関連項目:

    • getSelectedObjects

      public Object[] getSelectedObjects()
      このスクロール・リストの選択されている項目をObjectの配列で取得します。
      定義:
      getSelectedObjects、インタフェースItemSelectable
      戻り値:
      このスクロール・リストで選択されている項目を表すObjectの配列。項目が選択されていない場合は、長さゼロの配列が返される。
      関連項目:

    • select

      public void select(int index)
      スクロール・リストの指定されたインデックスにある項目を選択します。

      範囲外のパラメータを渡すことは無効であり、特定できない動作が発生します。

      このメソッドは、主にこのコンポーネント内の項目を初期状態で選択するために使用されます。 このメソッドをプログラムによって呼び出した場合、ItemEventはトリガーされません。 ItemEventをトリガーするための唯一の方法は、ユーザーの操作です。

      パラメータ:
      index - 選択する項目の位置
      関連項目:

    • deselect

      public void deselect(int index)
      指定されたインデックスにある項目を選択解除します。

      範囲外のパラメータを渡すことは無効であり、特定できない動作が発生します。

      指定されたインデックスの項目が選択されていない場合、操作は無視されます。

      パラメータ:
      index - 選択を解除する項目の位置
      関連項目:

    • isIndexSelected

      public boolean isIndexSelected(int index)
      このスクロール・リストで指定された項目が選択されているかどうかを判定します。
      パラメータ:
      index - チェック対象の項目
      戻り値:
      指定された項目が選択されている場合はtrue、そうでない場合はfalse
      導入されたバージョン:
      1.1
      関連項目:

    • isSelected

      @Deprecated public boolean isSelected(int index)
      非推奨。
      JDK Version 1.1以降は、isIndexSelected(int)に置き換えられています。
      リスト内の指定されたアイテムが選択されているかどうかを判定します。
      パラメータ:
      index - チェックされるアイテムを指定
      戻り値:
      アイテムが選択されている場合はtrue;そうでなければfalse

    • getRows

      public int getRows()
      リストの表示行の数を返します。 Listが作成されると、この数は変更できません。
      戻り値:
      このスクロール・リストの表示行の数

    • isMultipleMode

      public boolean isMultipleMode()
      このリストが複数選択を許すかどうかを判定します。
      戻り値:
      このリストで複数選択が許可されている場合はtrue、そうでない場合はfalse
      導入されたバージョン:
      1.1
      関連項目:

    • allowsMultipleSelections

      @Deprecated public boolean allowsMultipleSelections()
      非推奨。
      JDK Version 1.1以降は、isMultipleMode()に置き換えられています。
      このリストが複数選択を許すかどうかを判定します。
      戻り値:
      このリストで複数の選択が可能な場合はtrue;そうでなければfalse

    • setMultipleMode

      public void setMultipleMode(boolean b)
      このリストが複数選択を許すかどうかを判定するフラグを設定します。 選択モードが複数選択から単一選択に変更されると、選択された項目は次のように変更されます。選択された項目に位置カーソルがある場合、その項目のみが選択されたままになります。 選択された項目に位置カーソルがない場合、すべての項目が選択解除されます。
      パラメータ:
      b - trueの場合は複数選択が許可される。そうでない場合はリストから同時に選択できる項目は1つだけ
      導入されたバージョン:
      1.1
      関連項目:

    • setMultipleSelections

      @Deprecated public void setMultipleSelections(boolean b)
      非推奨。
      JDK Version 1.1以降は、setMultipleMode(boolean)に置き換えられています。
      このリストの複数の選択モードを有効または無効にします。
      パラメータ:
      b - trueはマルチ・モードを有効にし、falseはそうでない場合

    • getVisibleIndex

      public int getVisibleIndex()
      メソッドmakeVisibleによって最後に表示された項目のインデックスを取得します。
      戻り値:
      最後に表示された項目のインデックス
      関連項目:

    • makeVisible

      public void makeVisible(int index)
      指定されたインデックスにある項目を表示させます。
      パラメータ:
      index - 項目の位置
      関連項目:

    • getPreferredSize

      public Dimension getPreferredSize(int rows)
      指定された行数を持つリストの推奨寸法を返します。
      パラメータ:
      rows - リスト内の行の数
      戻り値:
      指定された行数を表示しなければならないという条件のもとで、このスクロール・リストを表示するための推奨寸法
      導入されたバージョン:
      1.1
      関連項目:

    • preferredSize

      @Deprecated public Dimension preferredSize(int rows)
      非推奨。
      JDK Version 1.1以降は、getPreferredSize(int)に置き換えられています。
      指定された行数を持つと仮定して、このコンポーネントの優先サイズを返します。
      パラメータ:
      rows - 行の数
      戻り値:
      このリストを表示するための優先ディメンション

    • getPreferredSize

      public Dimension getPreferredSize()
      このスクロール・リストの推奨サイズを返します。
      オーバーライド:
      getPreferredSize、クラスComponent
      戻り値:
      このスクロール・リストを表示するための推奨寸法
      導入されたバージョン:
      1.1
      関連項目:

    • preferredSize

      @Deprecated public Dimension preferredSize()
      非推奨。
      JDK Version 1.1以降は、getPreferredSize()に置き換えられています。
      次のクラスからコピーされた説明: Component
      コンポーネントの優先サイズを返します。
      オーバーライド:
      preferredSize、クラスComponent
      戻り値:
      コンポーネントの優先サイズ

    • getMinimumSize

      public Dimension getMinimumSize(int rows)
      指定された行数を持つリストの最小サイズを取得します。
      パラメータ:
      rows - リスト内の行の数
      戻り値:
      指定された行数を表示しなければならないという条件のもとで、このスクロール・リストを表示するための最小寸法
      導入されたバージョン:
      1.1
      関連項目:

    • minimumSize

      @Deprecated public Dimension minimumSize(int rows)
      非推奨。
      JDK Version 1.1以降は、getMinimumSize(int)に置き換えられています。
      指定された行数のリストの最小ディメンションを返します。
      パラメータ:
      rows - リスト内の行数
      戻り値:
      このリストを表示するための最小ディメンション

    • getMinimumSize

      public Dimension getMinimumSize()
      このスクロール・リストの最小サイズを指定します。
      オーバーライド:
      getMinimumSize、クラスComponent
      戻り値:
      このスクロール・リストを表示するために必要な最小寸法
      導入されたバージョン:
      1.1
      関連項目:

    • minimumSize

      @Deprecated public Dimension minimumSize()
      非推奨。
      JDK Version 1.1以降は、getMinimumSize()に置き換えられています。
      次のクラスからコピーされた説明: Component
      このコンポーネントの最小サイズを返します。
      オーバーライド:
      minimumSize、クラスComponent
      戻り値:
      このコンポーネントの最小サイズ

    • addItemListener

      public void addItemListener(ItemListener l)
      このリストから項目イベントを受け取るために、指定された項目リスナーを追加します。 項目イベントはselectまたはdeselectの呼出しではなく、ユーザーの入力に反応してリスナーに送信されます。 リスナーlがnullである場合、例外はスローされず、何も処理は行われません。

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

      定義:
      addItemListener、インタフェースItemSelectable
      パラメータ:
      l - 項目リスナー
      導入されたバージョン:
      1.1
      関連項目:

    • removeItemListener

      public void removeItemListener(ItemListener l)
      以降このリストから項目イベントを受け取らないように、指定された項目リスナーを削除します。 リスナーlがnullである場合、例外はスローされず、何も処理は行われません。

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

      定義:
      removeItemListener、インタフェースItemSelectable
      パラメータ:
      l - 項目リスナー
      導入されたバージョン:
      1.1
      関連項目:

    • getItemListeners

      public ItemListener[] getItemListeners()
      このリストに登録されているすべての項目リスナーの配列を返します。
      戻り値:
      このリストのすべてのItemListener。項目リスナーが現在登録されていない場合は空の配列
      導入されたバージョン:
      1.4
      関連項目:

    • addActionListener

      public void addActionListener(ActionListener l)
      このリストからアクション・イベントを受け取るために、指定されたアクション・リスナーを追加します。 ユーザーがリスト項目をダブルクリックするか、またはリストにキーボード・フォーカスがある場合にEnterキーを押すと、アクション・イベントが発生します。

      リスナーlがnullである場合、例外はスローされず、何も処理は行われません。

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

      パラメータ:
      l - アクション・リスナー
      導入されたバージョン:
      1.1
      関連項目:

    • removeActionListener

      public void removeActionListener(ActionListener l)
      以降このリストからアクション・イベントを受け取らないように、指定されたアクション・リスナーを削除します。 ユーザーがリスト項目をダブルクリックすると、アクション・イベントが発生します。 リスナーlがnullである場合、例外はスローされず、何も処理は行われません。

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

      パラメータ:
      l - アクション・リスナー
      導入されたバージョン:
      1.1
      関連項目:

    • getActionListeners

      public ActionListener[] getActionListeners()
      このリストに登録されたすべてのアクション・リスナーの配列を返します。
      戻り値:
      このリストのすべてのActionListener。アクション・リスナーが現在登録されていない場合は空の配列
      導入されたバージョン:
      1.4
      関連項目:

    • getListeners

      public <T extends EventListener> T[] getListeners(Class<T> listenerType)
      このListにFooListenerとして現在登録されているすべてのオブジェクトの配列を返します。 FooListenerは、addFooListenerメソッドを使用して登録されます。

      FooListener.classなどのクラス・リテラルを使用してlistenerType引数を指定できます。 たとえば、次のコードを使用して、アイテム・リスナーのList lを問い合せることができます: 

      ItemListener[] ils = (ItemListener[])(l.getListeners(ItemListener.class));
      このようなリスナーがない場合は空の配列を返します。

      オーバーライド:
      getListeners、クラスComponent
      型パラメータ:
      T - リスナーの型
      パラメータ:
      listenerType - 要求されるリスナーの型; java.util.EventListenerの下位インタフェースを指定
      戻り値:
      このリスト上でFooListenerとして登録されたすべてのオブジェクトの配列、またはこのようなリスナーが追加されていない場合は空の配列
      例外:
      ClassCastException - listenerTypeで、java.util.EventListenerを実装するクラスまたはインタフェースが指定されなかった場合
      導入されたバージョン:
      1.3
      関連項目:

    • processEvent

      protected void processEvent(AWTEvent e)
      このスクロール・リストのイベントを処理します。 イベントがItemEventのインスタンスである場合は、processItemEventメソッドを呼び出します。 イベントがActionEventのインスタンスの場合は、processActionEventを呼び出します。 イベントが項目イベントやアクション・イベントでない場合は、スーパー・クラスでprocessEventを呼び出します。

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

      オーバーライド:
      processEvent、クラスComponent
      パラメータ:
      e - イベント
      導入されたバージョン:
      1.1
      関連項目:

    • processItemEvent

      protected void processItemEvent(ItemEvent e)
      このリストで発生する項目イベントを、登録されているItemListenerオブジェクトにディスパッチすることによって処理します。

      項目イベントがこのコンポーネント用に使用可能になっていないかぎり、このメソッドは呼び出されません。 項目イベントは、次の項目の1つが発生したときに使用可能になります。

      • ItemListenerオブジェクトがaddItemListenerによって登録されている。
      • enableEventsによって項目イベントが使用可能になっている。

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

      パラメータ:
      e - 項目イベント
      導入されたバージョン:
      1.1
      関連項目:

    • processActionEvent

      protected void processActionEvent(ActionEvent e)
      このコンポーネントで発生するアクション・イベントを、登録されているActionListenerオブジェクトにディスパッチすることによって処理します。

      このコンポーネントに対してアクション・イベントが使用可能でないかぎり、このメソッドは呼び出されません。 アクション・イベントは、次のどちらかの場合に使用可能になります。

      • ActionListenerオブジェクトがaddActionListenerによって登録されている。
      • enableEventsによってアクション・イベントが使用可能になっている。

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

      パラメータ:
      e - アクション・イベント
      導入されたバージョン:
      1.1
      関連項目:

    • paramString

      protected String paramString()
      このスクロール・リストの状態を表現しているパラメータ文字列を返します。 この文字列はデバッグの際に便利です。
      オーバーライド:
      paramString、クラスComponent
      戻り値:
      このスクロール・リストのパラメータの文字列

    • delItems

      @Deprecated public void delItems(int start, int end)
      非推奨。
      JDK Version 1.1の時点では、将来的に一般利用される予定はありません。 このメソッドは、パッケージprivateメソッドとしてのみ保持されるように想定されています。
      指定されたインデックス範囲内のリスト・アイテムを削除します。
      パラメータ:
      start - 削除する範囲の先頭のインデックス
      end - 削除する範囲の終了インデックス

    • getAccessibleContext

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