java.
awt
Class List
public class List
extends Component
implements ItemSelectable, Accessible
The List component presents the user with a scrolling list of text items. The list can be set up so that the user can choose either one item or multiple items.
Constructor Summary
List()
Creates a new scrolling list.
List(int rows)
Creates a new scrolling list initialized with the specified number of visible lines.
List(int rows, boolean multipleMode)
Creates a new scrolling list initialized to display the specified number of rows.
Method Summary
void add(String item)
Adds the specified item to the end of scrolling list.
void add(String item, int index)
Adds the specified item to the the scrolling list at the position indicated by the index.
void addActionListener(ActionListener l)
Adds the specified action listener to receive action events from this list.
void addItem(String item)
Deprecated. replaced by add(String).
void addItem(String item, int index)
Deprecated. replaced by add(String, int).
void addItemListener(ItemListener l)
Adds the specified item listener to receive item events from this list.
void addNotify()
Creates the peer for the list.
boolean allowsMultipleSelections()
Deprecated. As of JDK version 1.1, replaced by isMultipleMode().
void clear()
Deprecated. As of JDK version 1.1, replaced by removeAll().
int countItems()
Deprecated. As of JDK version 1.1, replaced by getItemCount().
void delItem(int position)
Deprecated. replaced by remove(String) and remove(int).
void delItems(int start, int end)
Deprecated. As of JDK version 1.1, Not for public use in the future. This method is expected to be retained only as a package private method.
void deselect(int index)
Deselects the item at the specified index.
AccessibleConte getAccessibleContext()
xt Gets the AccessibleContext associated with this List.
ActionListener[ getActionListeners()
] Returns an array of all the action listeners registered on this list.
String getItem(int index)
Gets the item associated with the specified index.
int getItemCount()
Gets the number of items in the list.
ItemListener[] getItemListeners()
Returns an array of all the item listeners registered on this list.
String[] getItems()
Gets the items in the list.
EventListener[] getListeners(Class listenerType)
Returns an array of all the objects currently registered as FooListeners upon this List.
Dimension getMinimumSize()
Determines the minimum size of this scrolling list.
Dimension getMinimumSize(int rows)
Gets the minumum dimensions for a list with the specified number of rows.
Dimension getPreferredSize()
Gets the preferred size of this scrolling list.
Dimension getPreferredSize(int rows)
Gets the preferred dimensions for a list with the specified number of rows.
int getRows()
Gets the number of visible lines in this list.
int getSelectedIndex()
Gets the index of the selected item on the list,
int[] getSelectedIndexes()
Gets the selected indexes on the list.
String getSelectedItem()
Gets the selected item on this scrolling list.
String[] getSelectedItems()
Gets the selected items on this scrolling list.
Object[] getSelectedObjects()
Returns the selected items on the list in an array of objects.
int getVisibleIndex()
Gets the index of the item that was last made visible by the method makeVisible.
boolean isIndexSelected(int index)
Determines if the specified item in this scrolling list is selected.
boolean isMultipleMode()
Determines whether this list allows multiple selections.
boolean isSelected(int index)
Deprecated. As of JDK version 1.1, replaced by isIndexSelected(int).
void makeVisible(int index)
Makes the item at the specified index visible.
Dimension minimumSize()
Deprecated. As of JDK version 1.1, replaced by getMinimumSize().
Dimension minimumSize(int rows)
Deprecated. As of JDK version 1.1, replaced by getMinimumSize(int).
protected paramString()
String Returns the parameter string representing the state of this scrolling list.
Dimension preferredSize()
Deprecated. As of JDK version 1.1, replaced by getPreferredSize().
Dimension preferredSize(int rows)
Deprecated. As of JDK version 1.1, replaced by getPreferredSize(int).
protected processActionEvent(ActionEvent e)
void Processes action events occurring on this component by dispatching them to any registered ActionListener objects.
protected processEvent(AWTEvent e)
void Processes events on this scrolling list.
protected processItemEvent(ItemEvent e)
void Processes item events occurring on this list by dispatching them to any registered ItemListener objects.
void remove(int position)
Remove the item at the specified position from this scrolling list.
void remove(String item)
Removes the first occurrence of an item from the list.
void removeActionListener(ActionListener l)
Removes the specified action listener so that it no longer receives action events from this list.
void removeAll()
Removes all items from this list.
void removeItemListener(ItemListener l)
Removes the specified item listener so that it no longer receives item events from this list.
void removeNotify()
Removes the peer for this list.
void replaceItem(String newValue, int index)
Replaces the item at the specified index in the scrolling list with the new string.
void select(int index)
Selects the item at the specified index in the scrolling list.
void setMultipleMode(boolean b)
Sets the flag that determines whether this list allows multiple selections.
void setMultipleSelections(boolean b)
Deprecated. As of JDK version 1.1, replaced by setMultipleMode(boolean).
Constructor Detail
List
public List()
throws HeadlessException
Creates a new scrolling list. By default, there are four visible lines and multiple selections are not allowed. Note that this is a convenience method for List(0, false). Also
note that the number of visible lines in the list cannot be changed after it has been created.
Throws:
HeadlessException - if [Link]() returns true.
See Also:
[Link]()
!
List
public List(int rows)
throws HeadlessException
Creates a new scrolling list initialized with the specified number of visible lines. By default, multiple selections are not allowed. Note that this is a convenience method for
List(rows, false). Also note that the number of visible rows in the list cannot be changed after it has been created.
Parameters:
rows - the number of items to show.
Throws:
HeadlessException - if [Link]() returns true.
Since:
JDK1.1
See Also:
[Link]()
!
List
public List(int rows,
boolean multipleMode)
throws HeadlessException
Creates a new scrolling list initialized to display the specified number of rows. Note that if zero rows are specified, then the list will be created with a default of four rows. Also
note that the number of visible rows in the list cannot be changed after it has been created. If the value of multipleMode is true, then the user can select multiple items from
the list. If it is false, only one item at a time can be selected.
Parameters:
rows - the number of items to show.
multipleMode - if true, then multiple selections are allowed; otherwise, only one item can be selected at a time.
Throws:
HeadlessException - if [Link]() returns true.
See Also:
[Link]()
Method Detail
addNotify
public void addNotify()
Creates the peer for the list. The peer allows us to modify the list's appearance without changing its functionality.
Overrides:
addNotify in class Component
See Also:
[Link](), [Link]()
!
removeNotify
public void removeNotify()
Removes the peer for this list. The peer allows us to modify the list's appearance without changing its functionality.
Overrides:
removeNotify in class Component
See Also:
[Link](), [Link]()
!
getItemCount
public int getItemCount()
Gets the number of items in the list.
Returns:
the number of items in the list
Since:
JDK1.1
See Also:
getItem(int)
!
countItems
public int countItems()
Deprecated. As of JDK version 1.1, replaced by getItemCount().
!
getItem
public String getItem(int index)
Gets the item associated with the specified index.
Parameters:
index - the position of the item
Returns:
an item that is associated with the specified index
See Also:
getItemCount()
!
getItems
public String[] getItems()
Gets the items in the list.
Returns:
a string array containing items of the list
Since:
JDK1.1
See Also:
select(int), deselect(int), isIndexSelected(int)
!
add
public void add(String item)
Adds the specified item to the end of scrolling list.
Parameters:
item - the item to be added
Since:
JDK1.1
!
addItem
public void addItem(String item)
Deprecated. replaced by add(String).
!
add
public void add(String item,
int index)
Adds the specified item to the the scrolling list at the position indicated by the index. The index is zero-based. If the value of the index is less than zero, or if the value of the index
is greater than or equal to the number of items in the list, then the item is added to the end of the list.
Parameters:
item - the item to be added; if this parameter is null then the item is treated as an empty string, ""
index - the position at which to add the item
Since:
JDK1.1
!
addItem
public void addItem(String item,
int index)
Deprecated. replaced by add(String, int).
!
replaceItem
public void replaceItem(String newValue,
int index)
Replaces the item at the specified index in the scrolling list with the new string.
Parameters:
newValue - a new string to replace an existing item
index - the position of the item to replace
Throws:
ArrayIndexOutOfBoundsException - if index is out of range
!
removeAll
public void removeAll()
Removes all items from this list.
Since:
JDK1.1
See Also:
remove([Link]), delItems(int, int)
!
clear
public void clear()
Deprecated. As of JDK version 1.1, replaced by removeAll().
!
remove
public void remove(String item)
Removes the first occurrence of an item from the list.
Parameters:
item - the item to remove from the list
Throws:
IllegalArgumentException - if the item doesn't exist in the list
Since:
JDK1.1
!
remove
public void remove(int position)
Remove the item at the specified position from this scrolling list.
Parameters:
position - the index of the item to delete
Throws:
ArrayIndexOutOfBoundsException - if the position is less than 0 or greater than getItemCount()-1
Since:
JDK1.1
See Also:
add(String, int)
!
delItem
public void delItem(int position)
Deprecated. replaced by remove(String) and remove(int).
!
getSelectedIndex
public int getSelectedIndex()
Gets the index of the selected item on the list,
Returns:
the index of the selected item, or -1 if no item is selected, or if more that one item is selected
See Also:
select(int), deselect(int), isIndexSelected(int)
!
getSelectedIndexes
public int[] getSelectedIndexes()
Gets the selected indexes on the list.
Returns:
an array of the selected indexes of this scrolling list; if no items are selected, a zero-length array is returned
See Also:
select(int), deselect(int), isIndexSelected(int)
!
getSelectedItem
public String getSelectedItem()
Gets the selected item on this scrolling list.
Returns:
the selected item on the list, or null if no item is selected
See Also:
select(int), deselect(int), isIndexSelected(int)
!
getSelectedItems
public String[] getSelectedItems()
Gets the selected items on this scrolling list.
Returns:
an array of the selected items on this scrolling list
See Also:
select(int), deselect(int), isIndexSelected(int)
!
getSelectedObjects
public Object[] getSelectedObjects()
Returns the selected items on the list in an array of objects.
Specified by:
getSelectedObjects in interface ItemSelectable
See Also:
ItemSelectable
!
select
public void select(int index)
Selects the item at the specified index in the scrolling list.
Note that this method should be primarily used to initially select an item in this component. Programmatically calling this method will not trigger an ItemEvent. The only way
to trigger an ItemEvent is by user interaction.
Parameters:
index - the position of the item to select
See Also:
getSelectedItem(), deselect(int), isIndexSelected(int)
!
deselect
public void deselect(int index)
Deselects the item at the specified index.
If the item at the specified index is not selected, or if the index is out of range, then the operation is ignored.
Parameters:
index - the position of the item to deselect
See Also:
select(int), getSelectedItem(), isIndexSelected(int)
!
isIndexSelected
public boolean isIndexSelected(int index)
Determines if the specified item in this scrolling list is selected.
Parameters:
index - the item to be checked
Returns:
true if the specified item has been selected; false otherwise
Since:
JDK1.1
See Also:
select(int), deselect(int)
!
isSelected
public boolean isSelected(int index)
Deprecated. As of JDK version 1.1, replaced by isIndexSelected(int).
!
getRows
public int getRows()
Gets the number of visible lines in this list. Note that once the List has been created, this number will never change.
Returns:
the number of visible lines in this scrolling list
!
isMultipleMode
public boolean isMultipleMode()
Determines whether this list allows multiple selections.
Returns:
true if this list allows multiple selections; otherwise, false
Since:
JDK1.1
See Also:
setMultipleMode(boolean)
!
allowsMultipleSelections
public boolean allowsMultipleSelections()
Deprecated. As of JDK version 1.1, replaced by isMultipleMode().
!
setMultipleMode
public void setMultipleMode(boolean b)
Sets the flag that determines whether this list allows multiple selections.
Parameters:
b - if true then multiple selections are allowed; otherwise, only one item from the list can be selected at once
Since:
JDK1.1
See Also:
isMultipleMode()
!
setMultipleSelections
public void setMultipleSelections(boolean b)
Deprecated. As of JDK version 1.1, replaced by setMultipleMode(boolean).
!
getVisibleIndex
public int getVisibleIndex()
Gets the index of the item that was last made visible by the method makeVisible.
Returns:
the index of the item that was last made visible
See Also:
makeVisible(int)
!
makeVisible
public void makeVisible(int index)
Makes the item at the specified index visible.
Parameters:
index - the position of the item
See Also:
getVisibleIndex()
!
getPreferredSize
public Dimension getPreferredSize(int rows)
Gets the preferred dimensions for a list with the specified number of rows.
Parameters:
rows - number of rows in the list
Returns:
the preferred dimensions for displaying this scrolling list given that the specified number of rows must be visible
Since:
JDK1.1
See Also:
[Link]()
!
preferredSize
public Dimension preferredSize(int rows)
Deprecated. As of JDK version 1.1, replaced by getPreferredSize(int).
!
getPreferredSize
public Dimension getPreferredSize()
Gets the preferred size of this scrolling list.
Overrides:
getPreferredSize in class Component
Returns:
the preferred dimensions for displaying this scrolling list
Since:
JDK1.1
See Also:
[Link]()
!
preferredSize
public Dimension preferredSize()
Deprecated. As of JDK version 1.1, replaced by getPreferredSize().
Overrides:
preferredSize in class Component
!
getMinimumSize
public Dimension getMinimumSize(int rows)
Gets the minumum dimensions for a list with the specified number of rows.
Parameters:
rows - number of rows in the list
Returns:
the minimum dimensions for displaying this scrolling list given that the specified number of rows must be visible
Since:
JDK1.1
See Also:
[Link]()
!
minimumSize
public Dimension minimumSize(int rows)
Deprecated. As of JDK version 1.1, replaced by getMinimumSize(int).
!
getMinimumSize
public Dimension getMinimumSize()
Determines the minimum size of this scrolling list.
Overrides:
getMinimumSize in class Component
Returns:
the minimum dimensions needed to display this scrolling list
Since:
JDK1.1
See Also:
[Link]()
!
minimumSize
public Dimension minimumSize()
Deprecated. As of JDK version 1.1, replaced by getMinimumSize().
Overrides:
minimumSize in class Component
!
addItemListener
public void addItemListener(ItemListener l)
Adds the specified item listener to receive item events from this list. Item events are sent in response to user input, but not in response to calls to select or deselect. If
listener l is null, no exception is thrown and no action is performed.
Specified by:
addItemListener in interface ItemSelectable
Parameters:
l - the item listener
Since:
JDK1.1
See Also:
removeItemListener([Link]), getItemListeners(), select(int), deselect(int), ItemEvent, ItemListener
!
removeItemListener
public void removeItemListener(ItemListener l)
Removes the specified item listener so that it no longer receives item events from this list. If listener l is null, no exception is thrown and no action is performed.
Specified by:
removeItemListener in interface ItemSelectable
Parameters:
l - the item listener
Since:
JDK1.1
See Also:
addItemListener([Link]), getItemListeners(), ItemEvent, ItemListener
!
getItemListeners
public ItemListener[] getItemListeners()
Returns an array of all the item listeners registered on this list.
Returns:
all of this list's ItemListeners or an empty array if no item listeners are currently registered
Since:
1.4
See Also:
addItemListener([Link]), removeItemListener([Link]), ItemEvent, ItemListener
!
addActionListener
public void addActionListener(ActionListener l)
Adds the specified action listener to receive action events from this list. Action events occur when a user double-clicks on a list item. If listener l is null, no exception is thrown
and no action is performed.
Parameters:
l - the action listener
Since:
JDK1.1
See Also:
removeActionListener([Link]), getActionListeners(), ActionEvent, ActionListener
!
removeActionListener
public void removeActionListener(ActionListener l)
Removes the specified action listener so that it no longer receives action events from this list. Action events occur when a user double-clicks on a list item. If listener l is null, no
exception is thrown and no action is performed.
Parameters:
l - the action listener
Since:
JDK1.1
See Also:
addActionListener([Link]), getActionListeners(), ActionEvent, ActionListener
!
getActionListeners
public ActionListener[] getActionListeners()
Returns an array of all the action listeners registered on this list.
Returns:
all of this list's ActionListeners or an empty array if no action listeners are currently registered
Since:
1.4
See Also:
addActionListener([Link]), removeActionListener([Link]), ActionEvent,
ActionListener
!
getListeners
public EventListener[] getListeners(Class listenerType)
Returns an array of all the objects currently registered as FooListeners upon this List. FooListeners are registered using the addFooListener method.
You can specify the listenerType argument with a class literal, such as [Link]. For example, you can query a List l for its item listeners with the
following code:
ItemListener[] ils = (ItemListener[])([Link]([Link]));
If no such listeners exist, this method returns an empty array.
Overrides:
getListeners in class Component
Parameters:
listenerType - the type of listeners requested; this parameter should specify an interface that descends from [Link]
Returns:
an array of all objects registered as FooListeners on this list, or an empty array if no such listeners have been added
Throws:
ClassCastException - if listenerType doesn't specify a class or interface that implements [Link]
Since:
1.3
See Also:
getItemListeners()
!
processEvent
protected void processEvent(AWTEvent e)
Processes events on this scrolling list. If an event is an instance of ItemEvent, it invokes the processItemEvent method. Else, if the event is an instance of
ActionEvent, it invokes processActionEvent. If the event is not an item event or an action event, it invokes processEvent on the superclass.
Note that if the event parameter is null the behavior is unspecified and may result in an exception.
Overrides:
processEvent in class Component
Parameters:
e - the event
Since:
JDK1.1
See Also:
ActionEvent, ItemEvent, processActionEvent([Link]), processItemEvent([Link])
!
processItemEvent
protected void processItemEvent(ItemEvent e)
Processes item events occurring on this list by dispatching them to any registered ItemListener objects.
This method is not called unless item events are enabled for this component. Item events are enabled when one of the following occurs:
An ItemListener object is registered via addItemListener.
Item events are enabled via enableEvents.
Note that if the event parameter is null the behavior is unspecified and may result in an exception.
Parameters:
e - the item event
Since:
JDK1.1
See Also:
ItemEvent, ItemListener, addItemListener([Link]), [Link](long)
!
processActionEvent
protected void processActionEvent(ActionEvent e)
Processes action events occurring on this component by dispatching them to any registered ActionListener objects.
This method is not called unless action events are enabled for this component. Action events are enabled when one of the following occurs:
An ActionListener object is registered via addActionListener.
Action events are enabled via enableEvents.
Note that if the event parameter is null the behavior is unspecified and may result in an exception.
Parameters:
e - the action event
Since:
JDK1.1
See Also:
ActionEvent, ActionListener, addActionListener([Link]), [Link](long)
!
paramString
protected String paramString()
Returns the parameter string representing the state of this scrolling list. This string is useful for debugging.
Overrides:
paramString in class Component
Returns:
the parameter string of this scrolling list
!
delItems
public void delItems(int start,
int end)
Deprecated. As of JDK version 1.1, Not for public use in the future. This method is expected to be retained only as a package private method.
!
getAccessibleContext
public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this List. For lists, the AccessibleContext takes the form of an AccessibleAWTList. A new
AccessibleAWTList instance is created, if necessary.
Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in class Component
Returns:
an AccessibleAWTList that serves as the AccessibleContext of this List