Java プラットフォーム 1.2

java.awt
クラス List

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

public class List
extends Component
implements ItemSelectable

List コンポーネントは、テキスト項目のスクロールリストをユーザに対して表示します。リストは、1 つまたは複数の項目が選択できるように設定できます。

たとえば、次のコード (cnt はコンテナ) は


 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);
 

次のスクロールリストを作成します。

選択されていない項目をクリックすると選択され、選択済みの項目をクリックすると選択解除されます。上記の例では、新しいスクロールリストを作成する際の 2 番目の引数が false なので、同時に選択できる項目は 1 つだけです。ある項目を選択すると、ほかに選択済みの項目があれば自動的に選択解除されます。

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

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

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

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

導入されたバージョン:
JDK1.0
関連項目:
ItemEvent, ItemListener, ActionEvent, ActionListener, 直列化された形式

クラス java.awt.Component から継承したフィールド
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
コンストラクタの概要
List()
          新しいスクロールリストを作成します。
List(int rows)
          指定された数の表示行を持つように初期化された新しいスクロールリストを作成します。
List(int rows, boolean multipleMode)
          指定された行数を表示するように初期化された新しいスクロールリストを作成します。
 
メソッドの概要
 void add(String item)
          指定された項目をスクロールリストの終わりに追加します。
 void add(String item, int index)
          指定された項目を、スクロールリストのインデックスで指定された位置に追加します。
 void addActionListener(ActionListener l)
          このリストからアクションイベントを受け取るために、指定されたアクションリスナーを追加します。
 void addItem(String item)
          推奨されません。 add(String) に置き換えられました。
 void addItem(String item, int index)
          推奨されません。 add(String, int) に置き換えられました。
 void addItemListener(ItemListener l)
          このリストから項目イベントを受け取るために指定された項目リスナーを追加します。
 void addNotify()
          リストのピアを作成します。
 boolean allowsMultipleSelections()
          推奨されません。 JDK バージョン 1.1 以降は、isMultipleMode() に置き換えられました。
 void clear()
          推奨されません。 JDK バージョン 1.1 以降は、removeAll() に置き換えられました。
 int countItems()
          推奨されません。 JDK バージョン 1.1 以降は、getItemCount() に置き換えられました。
 void delItem(int position)
          推奨されません。 remove(String)remove(int) に置き換えられました。
 void delItems(int start, int end)
          推奨されません。 JDK バージョン 1.1 の時点では、将来的にパブリックに使用されるようになる予定はありません。このメソッドは、パッケージのプライベートメソッドとしてだけ保持される予定です。
 void deselect(int index)
          指定されたインデックスにある項目を選択解除します。
 String getItem(int index)
          指定するインデックスに対応する項目を取得します。
 int getItemCount()
          リスト内の項目の数を取得します。
 String[] getItems()
          リスト内の項目を取得します。
 Dimension getMinimumSize()
          このスクロールリストの最小サイズを指定します。
 Dimension getMinimumSize(int rows)
          指定された行数を持つリストの最小寸法を取得します。
 Dimension getPreferredSize()
          このスクロールリストの推奨サイズを取得します。
 Dimension getPreferredSize(int rows)
          指定された行数を持つリストの推奨寸法を取得します。
 int getRows()
          このリストでの表示行の数を取得します。
 int getSelectedIndex()
          リストで選択されている項目のインデックスを取得します。
 int[] getSelectedIndexes()
          リストで選択されているインデックスを取得します。
 String getSelectedItem()
          このスクロールリストで選択されている項目を取得します。
 String[] getSelectedItems()
          このスクロールリストで選択されている項目を取得します。
 Object[] getSelectedObjects()
          リスト中の選択されている項目を Object の配列で返します。
 int getVisibleIndex()
          makeVisibleメソッドによって最後に表示された項目のインデックスを取得します。
 boolean isIndexSelected(int index)
          このスクロールリストで指定された項目が選択されているかどうかを判定します。
 boolean isMultipleMode()
          このリストが複数選択を許すかどうかを判定します。
 boolean isSelected(int index)
          推奨されません。 JDK バージョン 1.1 以降は、isIndexSelected(int) に置き換えられました。
 void makeVisible(int index)
          指定されたインデックスにある項目を表示させます。
 Dimension minimumSize()
          推奨されません。 JDK バージョン 1.1 以降は、getMinimumSize() に置き換えられました。
 Dimension minimumSize(int rows)
          推奨されません。 JDK バージョン 1.1 以降は、getMinimumSize(int) に置き換えられました。
protected  String paramString()
          このスクロールリストの状態を表現しているパラメータ文字列を返します。
 Dimension preferredSize()
          推奨されません。 JDK バージョン 1.1 以降は、getPreferredSize() に置き換えられました。
 Dimension preferredSize(int rows)
          推奨されません。 JDK バージョン 1.1 以降は、getPreferredSize(int) に置き換えられました。
protected  void processActionEvent(ActionEvent e)
          このコンポーネントで発生するアクションイベントを、登録された ActionListener オブジェクトにディスパッチすることにより、アクションイベントを処理します。
protected  void processEvent(AWTEvent e)
          このスクロールリストのイベントを処理します。
protected  void processItemEvent(ItemEvent e)
          このリストで発生する項目イベントを、登録された ItemListener オブジェクトにディスパッチすることにより、項目イベントを処理します。
 void remove(int position)
          指定された位置にある項目をこのスクロールリストから削除します。
 void remove(String item)
          リスト中の同じ項目のうち最初に出現したものを削除します。
 void removeActionListener(ActionListener l)
          指定されたアクションリスナーを削除し、それがこのリストからアクションイベントを受け取らないようにします。
 void removeAll()
          このリストからすべての項目を削除します。
 void removeItemListener(ItemListener l)
          指定された項目リスナーを削除して、それがこのリストから項目イベントを受け取らないようにします。
 void removeNotify()
          このリストのピアを削除します。
 void replaceItem(String newValue, int index)
          スクロールリスト内の指定されたインデックスにある項目を新しい文字列で置き換えます。
 void select(int index)
          スクロールリストの指定されたインデックスにある項目を選択します。
 void setMultipleMode(boolean b)
          このリストが複数選択を許すかどうかを判定するフラグを設定します。
 void setMultipleSelections(boolean b)
          推奨されません。 JDK バージョン 1.1 以降は、setMultipleMode(boolean) に置き換えられました。
 
クラス java.awt.Component から継承したメソッド
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, 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, getName, getParent, getPeer, 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, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, 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
 

コンストラクタの詳細

List

public List()
新しいスクロールリストを作成します。デフォルトでは、4 行が表示されており、複数の選択はできません。

List

public List(int rows)
指定された数の表示行を持つように初期化された新しいスクロールリストを作成します。デフォルトでは、複数の選択はできません。
パラメータ:
rows - 表示される項目の数
導入されたバージョン:
JDK1.1

List

public List(int rows,
            boolean multipleMode)
指定された行数を表示するように初期化された新しいスクロールリストを作成します。multipleMode の値が true の場合、ユーザはリストから複数の項目を選択できます。false の場合、同時に選択できる項目は 1 つだけです。
パラメータ:
rows - 表示される項目の数
multipleMode - true では複数選択が許可され、false では選択できる項目数は一度に 1 つだけ
メソッドの詳細

addNotify

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

removeNotify

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

getItemCount

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

countItems

public int countItems()
推奨されません。 JDK バージョン 1.1 以降は、getItemCount() に置き換えられました。

getItem

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

getItems

public String[] getItems()
リスト内の項目を取得します。
戻り値:
リストの項目を格納する文字列の配列
導入されたバージョン:
JDK1.1
関連項目:
select(int), deselect(int), isIndexSelected(int)

add

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

addItem

public void addItem(String item)
推奨されません。 add(String) に置き換えられました。

add

public void add(String item,
                int index)
指定された項目を、スクロールリストのインデックスで指定された位置に追加します。インデックスはゼロから始まります。インデックスの値が -1 より小さい場合は、ArrayIndexOutOfBoundsException がスローされます。インデックスの値がリスト内の項目数よりも大きい場合は、その項目は最後に追加されます。
パラメータ:
item - 追加される項目。このパラメータが null の場合、項目は空の文字列 "" として処理される
index - 項目を追加する位置
導入されたバージョン:
JDK1.1

addItem

public void addItem(String item,
                    int index)
推奨されません。 add(String, int) に置き換えられました。

replaceItem

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

removeAll

public void removeAll()
このリストからすべての項目を削除します。
導入されたバージョン:
JDK1.1
関連項目:
remove(java.lang.String), delItems(int, int)

clear

public void clear()
推奨されません。 JDK バージョン 1.1 以降は、removeAll() に置き換えられました。

remove

public void remove(String item)
リスト中の同じ項目のうち最初に出現したものを削除します。
パラメータ:
item - リストから削除される項目
例外:
IllegalArgumentException - その項目がリストに存在しない場合
導入されたバージョン:
JDK1.1

remove

public void remove(int position)
指定された位置にある項目をこのスクロールリストから削除します。
パラメータ:
position - 削除される項目のインデックス
例外:
ArrayIndexOutOfBoundsException - position が 0 より小さいか、getItemCount()-1 より大きい場合
導入されたバージョン:
JDK1.1
関連項目:
add(String, int)

delItem

public void delItem(int position)
推奨されません。 remove(String)remove(int) に置き換えられました。

getSelectedIndex

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

getSelectedIndexes

public int[] getSelectedIndexes()
リストで選択されているインデックスを取得します。
戻り値:
このスクロールリストで選択されたインデックスの配列
関連項目:
select(int), deselect(int), isIndexSelected(int)

getSelectedItem

public String getSelectedItem()
このスクロールリストで選択されている項目を取得します。
戻り値:
リストで選択されている項目。選択されている項目がない場合は null
関連項目:
select(int), deselect(int), isIndexSelected(int)

getSelectedItems

public String[] getSelectedItems()
このスクロールリストで選択されている項目を取得します。
戻り値:
このスクロールリストで選択されている項目の配列
関連項目:
select(int), deselect(int), isIndexSelected(int)

getSelectedObjects

public Object[] getSelectedObjects()
リスト中の選択されている項目を Object の配列で返します。
定義:
インタフェース ItemSelectable 内の getSelectedObjects
関連項目:
ItemSelectable

select

public void select(int index)
スクロールリストの指定されたインデックスにある項目を選択します。
パラメータ:
index - 選択される項目の位置
関連項目:
getSelectedItem(), deselect(int), isIndexSelected(int)

deselect

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

指定されたインデックスにある項目が選択されていない場合や、インデックスが範囲外にある場合には、操作は無視されます。

パラメータ:
index - 選択解除される項目の位置
関連項目:
select(int), getSelectedItem(), isIndexSelected(int)

isIndexSelected

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

isSelected

public boolean isSelected(int index)
推奨されません。 JDK バージョン 1.1 以降は、isIndexSelected(int) に置き換えられました。

getRows

public int getRows()
このリストでの表示行の数を取得します。
戻り値:
このスクロールリストの表示行の数

isMultipleMode

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

allowsMultipleSelections

public boolean allowsMultipleSelections()
推奨されません。 JDK バージョン 1.1 以降は、isMultipleMode() に置き換えられました。

setMultipleMode

public void setMultipleMode(boolean b)
このリストが複数選択を許すかどうかを判定するフラグを設定します。
パラメータ:
b - 複数選択が許される場合は true、そうでない場合はリストから同時に選択できる項目は 1 つだけ
導入されたバージョン:
JDK1.1
関連項目:
isMultipleMode()

setMultipleSelections

public void setMultipleSelections(boolean b)
推奨されません。 JDK バージョン 1.1 以降は、setMultipleMode(boolean) に置き換えられました。

getVisibleIndex

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

makeVisible

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

getPreferredSize

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

preferredSize

public Dimension preferredSize(int rows)
推奨されません。 JDK バージョン 1.1 以降は、getPreferredSize(int) に置き換えられました。

getPreferredSize

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

preferredSize

public Dimension preferredSize()
推奨されません。 JDK バージョン 1.1 以降は、getPreferredSize() に置き換えられました。
オーバーライド:
クラス Component 内の preferredSize

getMinimumSize

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

minimumSize

public Dimension minimumSize(int rows)
推奨されません。 JDK バージョン 1.1 以降は、getMinimumSize(int) に置き換えられました。

getMinimumSize

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

minimumSize

public Dimension minimumSize()
推奨されません。 JDK バージョン 1.1 以降は、getMinimumSize() に置き換えられました。
オーバーライド:
クラス Component 内の minimumSize

addItemListener

public void addItemListener(ItemListener l)
このリストから項目イベントを受け取るために指定された項目リスナーを追加します。l が null の場合、例外はスローされず、処理も実行されません。
定義:
インタフェース ItemSelectable 内の addItemListener
パラメータ:
l - 項目リスナー
導入されたバージョン:
JDK1.1
関連項目:
ItemEvent, ItemListener, removeItemListener(java.awt.event.ItemListener)

removeItemListener

public void removeItemListener(ItemListener l)
指定された項目リスナーを削除して、それがこのリストから項目イベントを受け取らないようにします。l が null の場合、例外はスローされず、処理も実行されません。
定義:
インタフェース ItemSelectable 内の removeItemListener
パラメータ:
l - 項目リスナー
導入されたバージョン:
JDK1.1
関連項目:
ItemEvent, ItemListener, addItemListener(java.awt.event.ItemListener)

addActionListener

public void addActionListener(ActionListener l)
このリストからアクションイベントを受け取るために、指定されたアクションリスナーを追加します。ユーザがリスト項目をダブルクリックすると、アクションイベントが発生します。l が null の場合、例外はスローされず、処理も実行されません。
パラメータ:
l - アクションリスナー
導入されたバージョン:
JDK1.1
関連項目:
ActionEvent, ActionListener, removeActionListener(java.awt.event.ActionListener)

removeActionListener

public void removeActionListener(ActionListener l)
指定されたアクションリスナーを削除し、それがこのリストからアクションイベントを受け取らないようにします。ユーザがリスト項目をダブルクリックすると、アクションイベントが発生します。l が null の場合、例外はスローされず、処理も実行されません。
パラメータ:
l - アクションリスナー
導入されたバージョン:
JDK1.1
関連項目:
ActionEvent, ActionListener, addActionListener(java.awt.event.ActionListener)

processEvent

protected void processEvent(AWTEvent e)
このスクロールリストのイベントを処理します。イベントが ItemEvent のインスタンスの場合は、processItemEvent メソッドを呼び出します。イベントが ActionEvent のインスタンスの場合は、processActionEvent を呼び出します。イベントが項目イベントやアクションイベントでない場合は、スーパークラスで processEvent を呼び出します。
パラメータ:
e - イベント
オーバーライド:
クラス Component 内の processEvent
導入されたバージョン:
JDK1.1
関連項目:
ActionEvent, ItemEvent, processActionEvent(java.awt.event.ActionEvent), processItemEvent(java.awt.event.ItemEvent)

processItemEvent

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

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

パラメータ:
e - 項目イベント
導入されたバージョン:
JDK1.1
関連項目:
ItemEvent, ItemListener, addItemListener(java.awt.event.ItemListener), Component.enableEvents(long)

processActionEvent

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

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

パラメータ:
e - アクションイベント
導入されたバージョン:
JDK1.1
関連項目:
ActionEvent, ActionListener, addActionListener(java.awt.event.ActionListener), Component.enableEvents(long)

paramString

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

delItems

public void delItems(int start,
                     int end)
推奨されません。 JDK バージョン 1.1 の時点では、将来的にパブリックに使用されるようになる予定はありません。このメソッドは、パッケージのプライベートメソッドとしてだけ保持される予定です。

Java プラットフォーム 1.2

バグや機能要求の報告
新しい javadoc の表示についてのコメントやご提案
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.