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
の場合は、次のスクロール・リストを作成します。
Listが複数選択を許可する場合に、すでに選択されている項目をクリックすると、選択が解除されます。前の例では、新しいスクロール・リストの作成時に2番目の引数がfalse
であるため、スクロール・リストから一度に選択できる項目は1つに限られます。Listが複数選択を許可しない場合、項目を選択すると、ほかの選択された項目の選択が解除されます。
この例に示されるリストは、可視の4行で作成されます。リストが作成されると、表示行の数は変更できません。デフォルトのList
は、lst = new List()
がlist = new List(4, false)
と同等になるように4行で作成されます。
Java 1.1から、Abstract Window Toolkit (AWT)は、List
オブジェクトにそこで発生するすべてのマウス、キーボード、フォーカス・イベントを送ります。下位互換性のために古いAWTイベント・モデルが保持されていますが、それを使用することは非推奨です。
ユーザーによって項目が選択または選択解除されるときには、AWTはItemEvent
のインスタンスをリストに送ります。ユーザーがスクロール・リストの項目をダブルクリックすると、AWTは項目イベントに続いてActionEvent
のインスタンスをリストに送ります。AWTは同時に、リスト内の項目が選択されている間にReturnキーが押されるとアクション・イベントを生成します。
ユーザーが選択したかまたはアクティブ化したこのリスト内の項目に基づいてアプリケーションが特定のアクションを実行しようとする場合は、ItemListener
またはActionListener
を必要に応じて実装して、このリストからイベントを受け取る新しいリスナーを登録します。
複数選択のスクロール・リストでは、それは外部のジェスチャ(ボタンのクリックなど)を使ってアクションをトリガーするのに最適なユーザー・インタフェースと見なされます。
ItemEvent
, ItemListener
, ActionEvent
, ActionListener
, 直列化された形式修飾子と型 | クラスと説明 |
---|---|
protected class |
List.AccessibleAWTList
このクラスは
List クラス用のアクセシビリティ・サポートを実装しています。 |
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
コンストラクタと説明 |
---|
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 version 1.1以降は、
isMultipleMode() に置き換えられています。 |
void |
clear()
非推奨。
JDK version 1.1以降は、
removeAll() に置き換えられています。 |
int |
countItems()
非推奨。
JDK version 1.1以降は、
getItemCount() に置き換えられています。 |
void |
delItem(int position)
非推奨。
remove(String) およびremove(int) に置き換えられています。 |
void |
delItems(int start, int end)
非推奨。
JDK Version 1.1の時点では、将来的に一般利用される予定はありません。このメソッドは、パッケージprivateメソッドとしてのみ保持されるように想定されています。
|
void |
deselect(int index)
指定されたインデックスにある項目を選択解除します。
|
AccessibleContext |
getAccessibleContext()
この
List に関連付けられたAccessibleContext を取得します。 |
ActionListener[] |
getActionListeners()
このリストに登録されたすべてのアクション・リスナーの配列を返します。
|
String |
getItem(int index)
指定するインデックスに対応する項目を返します。
|
int |
getItemCount()
リスト内の項目の数を返します。
|
ItemListener[] |
getItemListeners()
このリストに登録されたすべての項目リスナーの配列を返します。
|
String[] |
getItems()
リスト内の項目を返します。
|
<T extends EventListener> |
getListeners(Class<T> listenerType)
この
List にFooListener として現在登録されているすべてのオブジェクトの配列を返します。 |
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 version 1.1以降は、
isIndexSelected(int) に置き換えられています。 |
void |
makeVisible(int index)
指定されたインデックスにある項目を表示させます。
|
Dimension |
minimumSize()
非推奨。
JDK version 1.1以降は、
getMinimumSize() に置き換えられています。 |
Dimension |
minimumSize(int rows)
非推奨。
JDK version 1.1以降は、
getMinimumSize(int) に置き換えられています。 |
protected String |
paramString()
このスクロール・リストの状態を表現しているパラメータ文字列を返します。
|
Dimension |
preferredSize()
非推奨。
JDK version 1.1以降は、
getPreferredSize() に置き換えられています。 |
Dimension |
preferredSize(int rows)
非推奨。
JDK version 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 version 1.1以降は、
setMultipleMode(boolean) に置き換えられています。 |
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, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, 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, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, 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, revalidate, setBackground, 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
public List() throws HeadlessException
List(0, false)
の簡易メソッドです。また、リストに表示される行数は、作成後に変更できません。HeadlessException
- GraphicsEnvironment.isHeadless()がtrueを返した場合。GraphicsEnvironment.isHeadless()
public List(int rows) throws HeadlessException
List(rows, false)
の簡易メソッドです。また、リストに表示される行数は作成後に変更できません。rows
- 表示する項目の数。HeadlessException
- GraphicsEnvironment.isHeadless()がtrueを返した場合。GraphicsEnvironment.isHeadless()
public List(int rows, boolean multipleMode) throws HeadlessException
multipleMode
の値がtrue
の場合、ユーザーはリストから複数の項目を選択できます。false
の場合、一度に1項目のみ選択できます。rows
- 表示する項目の数。multipleMode
- true
の場合、複数選択が許可される。そうでない場合、リストから同時に選択できる項目は1つだけ。HeadlessException
- GraphicsEnvironment.isHeadless()がtrueを返した場合。GraphicsEnvironment.isHeadless()
public void addNotify()
addNotify
、クラス: Component
Component.isDisplayable()
, Component.removeNotify()
, Component.invalidate()
public void removeNotify()
removeNotify
、クラス: Component
Component.isDisplayable()
, Component.addNotify()
public int getItemCount()
getItem(int)
@Deprecated public int countItems()
getItemCount()
に置き換えられています。public String getItem(int index)
index
- 項目の位置getItemCount()
public String[] getItems()
select(int)
, deselect(int)
, isIndexSelected(int)
public void add(String item)
item
- 追加される項目@Deprecated public void addItem(String item)
add(String)
に置き換えられています。public void add(String item, int index)
item
- 追加される項目。このパラメータがnull
の場合、項目は空の文字列""
として扱われるindex
- 項目を追加する位置@Deprecated public void addItem(String item, int index)
add(String, int)
に置き換えられています。public void replaceItem(String newValue, int index)
newValue
- 既存の項目を置き換える新しい文字列index
- 置き換える項目の位置ArrayIndexOutOfBoundsException
- index
が範囲外の場合public void removeAll()
remove(java.lang.String)
, delItems(int, int)
@Deprecated public void clear()
removeAll()
に置き換えられています。public void remove(String item)
item
- リストから削除される項目IllegalArgumentException
- その項目がリストに存在しない場合public void remove(int position)
position
- 削除される項目のインデックスArrayIndexOutOfBoundsException
- position
が0より小さいか、getItemCount()-1
より大きい場合add(String, int)
@Deprecated public void delItem(int position)
remove(String)
およびremove(int)
に置き換えられています。public int getSelectedIndex()
-1
が返される。select(int)
, deselect(int)
, isIndexSelected(int)
public int[] getSelectedIndexes()
select(int)
, deselect(int)
, isIndexSelected(int)
public String getSelectedItem()
null
が返される。select(int)
, deselect(int)
, isIndexSelected(int)
public String[] getSelectedItems()
select(int)
, deselect(int)
, isIndexSelected(int)
public Object[] getSelectedObjects()
getSelectedObjects
、インタフェース: ItemSelectable
Object
の配列。項目が選択されていない場合は、長さゼロの配列が返される。getSelectedItems()
, ItemSelectable
public void select(int index)
範囲外のパラメータを渡すことは無効であり、特定できない動作が発生します。
このメソッドは、主にこのコンポーネント内の項目を初期状態で選択するために使用されます。このメソッドをプログラムによって呼び出した場合、ItemEvent
はトリガーされません。ItemEvent
をトリガーするための唯一の方法は、ユーザーの操作です。
index
- 選択する項目の位置getSelectedItem()
, deselect(int)
, isIndexSelected(int)
public void deselect(int index)
範囲外のパラメータを渡すことは無効であり、特定できない動作が発生します。
指定されたインデックスの項目が選択されていない場合、操作は無視されます。
index
- 選択を解除する項目の位置select(int)
, getSelectedItem()
, isIndexSelected(int)
public boolean isIndexSelected(int index)
index
- チェック対象の項目true
、そうでない場合はfalse
select(int)
, deselect(int)
@Deprecated public boolean isSelected(int index)
isIndexSelected(int)
に置き換えられています。public int getRows()
List
が作成されると、この数は変更できません。public boolean isMultipleMode()
true
、そうでない場合はfalse
setMultipleMode(boolean)
@Deprecated public boolean allowsMultipleSelections()
isMultipleMode()
に置き換えられています。public void setMultipleMode(boolean b)
b
- true
の場合は複数選択が許可される。そうでない場合はリストから同時に選択できる項目は1つだけisMultipleMode()
@Deprecated public void setMultipleSelections(boolean b)
setMultipleMode(boolean)
に置き換えられています。public int getVisibleIndex()
makeVisible
によって最後に表示された項目のインデックスを取得します。makeVisible(int)
public void makeVisible(int index)
index
- 項目の位置getVisibleIndex()
public Dimension getPreferredSize(int rows)
rows
- リスト内の行の数Component.getPreferredSize()
@Deprecated public Dimension preferredSize(int rows)
getPreferredSize(int)
に置き換えられています。public Dimension getPreferredSize()
getPreferredSize
、クラス: Component
Component.getPreferredSize()
@Deprecated public Dimension preferredSize()
getPreferredSize()
に置き換えられています。preferredSize
、クラス: Component
public Dimension getMinimumSize(int rows)
rows
- リスト内の行の数Component.getMinimumSize()
@Deprecated public Dimension minimumSize(int rows)
getMinimumSize(int)
に置き換えられています。public Dimension getMinimumSize()
getMinimumSize
、クラス: Component
Component.getMinimumSize()
@Deprecated public Dimension minimumSize()
getMinimumSize()
に置き換えられています。minimumSize
、クラス: Component
public void addItemListener(ItemListener l)
select
またはdeselect
の呼出しではなく、ユーザーの入力に反応してリスナーに送信されます。リスナーl
がnull
である場合、例外はスローされず、何も処理は行われません。
AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。
addItemListener
、インタフェース: ItemSelectable
l
- 項目リスナーremoveItemListener(java.awt.event.ItemListener)
, getItemListeners()
, select(int)
, deselect(int)
, ItemEvent
, ItemListener
public void removeItemListener(ItemListener l)
l
がnull
である場合、例外はスローされず、何も処理は行われません。
AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。
removeItemListener
、インタフェース: ItemSelectable
l
- 項目リスナーaddItemListener(java.awt.event.ItemListener)
, getItemListeners()
, ItemEvent
, ItemListener
public ItemListener[] getItemListeners()
ItemListener
。項目リスナーが現在登録されていない場合は空の配列addItemListener(java.awt.event.ItemListener)
, removeItemListener(java.awt.event.ItemListener)
, ItemEvent
, ItemListener
public void addActionListener(ActionListener l)
リスナーl
がnull
である場合、例外はスローされず、何も処理は行われません。
AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。
l
- アクション・リスナーremoveActionListener(java.awt.event.ActionListener)
, getActionListeners()
, ActionEvent
, ActionListener
public void removeActionListener(ActionListener l)
l
がnull
である場合、例外はスローされず、何も処理は行われません。
AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。
l
- アクション・リスナーaddActionListener(java.awt.event.ActionListener)
, getActionListeners()
, ActionEvent
, ActionListener
public ActionListener[] getActionListeners()
ActionListener
。アクション・リスナーが現在登録されていない場合は空の配列addActionListener(java.awt.event.ActionListener)
, removeActionListener(java.awt.event.ActionListener)
, ActionEvent
, ActionListener
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
listenerType
- 要求されるリスナーの型。java.util.EventListener
の子孫のインタフェースを指定してくださいFooListener
として登録されたすべてのオブジェクトの配列、またはこのようなリスナーが追加されていない場合は空の配列ClassCastException
- listenerType
で、java.util.EventListener
を実装するクラスまたはインタフェースが指定されなかった場合getItemListeners()
protected void processEvent(AWTEvent e)
ItemEvent
のインスタンスである場合は、processItemEvent
メソッドを呼び出します。イベントがActionEvent
のインスタンスの場合は、processActionEvent
を呼び出します。イベントが項目イベントやアクション・イベントでない場合は、スーパー・クラスでprocessEvent
を呼び出します。
イベント・パラメータがnull
である場合は、動作が未指定のため、例外が発生する可能性があります。
processEvent
、クラス: Component
e
- イベントActionEvent
, ItemEvent
, processActionEvent(java.awt.event.ActionEvent)
, processItemEvent(java.awt.event.ItemEvent)
protected void processItemEvent(ItemEvent e)
ItemListener
オブジェクトにディスパッチすることによって処理します。
項目イベントがこのコンポーネント用に使用可能になっていないかぎり、このメソッドは呼び出されません。項目イベントは、次の項目の1つが発生したときに使用可能になります。
ItemListener
オブジェクトがaddItemListener
によって登録されている。
enableEvents
によって項目イベントが使用可能になっている。
イベント・パラメータがnull
である場合は、動作が未指定のため、例外が発生する可能性があります。
e
- 項目イベントItemEvent
, ItemListener
, addItemListener(java.awt.event.ItemListener)
, Component.enableEvents(long)
protected void processActionEvent(ActionEvent e)
ActionListener
オブジェクトにディスパッチすることによって処理します。
このコンポーネントに対してアクション・イベントが使用可能でないかぎり、このメソッドは呼び出されません。アクション・イベントは、次のどちらかの場合に使用可能になります。
ActionListener
オブジェクトがaddActionListener
によって登録されている。
enableEvents
によってアクション・イベントが使用可能になっている。
イベント・パラメータがnull
である場合は、動作が未指定のため、例外が発生する可能性があります。
e
- アクション・イベントActionEvent
, ActionListener
, addActionListener(java.awt.event.ActionListener)
, Component.enableEvents(long)
protected String paramString()
paramString
、クラス: Component
@Deprecated public void delItems(int start, int end)
public AccessibleContext getAccessibleContext()
List
に関連付けられたAccessibleContext
を取得します。リストの場合、AccessibleContext
はAccessibleAWTList
の形式を取ります。必要に応じて、新しいAccessibleAWTList
インスタンスが作成されます。getAccessibleContext
、インタフェース: Accessible
getAccessibleContext
、クラス: Component
List
のAccessibleContext
として機能するAccessibleAWTList
バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.