    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class java.awt.List

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

public class List
extends Component
implements ItemSelectable.

A scrolling list of text items.

##

List()
  Creates a new scrolling list initialized with no visible Lines or multiple selections.
List(int)
  Creates a new scrolling list initialized with the specified number of visible lines and a boolean stating whether multiple selections are allowed or not.
List(int, boolean)
  Creates a new scrolling list initialized with the specified number of visible lines and a boolean stating whether multiple selections are allowed or not.

##

add(String)
  Adds the specified item to the end of scrolling list.
add(String, int)
  Adds the specified item to the scrolling list at the specified position.
addActionListener(ActionListener)
  Adds the specified action listener to receive action events from this list.
addItem(String)
  Adds the specified item to the end of scrolling list.
addItem(String, int)
  Adds the specified item to the scrolling list at the specified position.
addItemListener(ItemListener)
  Adds the specified item listener to recieve item events from this list.
addNotify()
  Creates the peer for the list.
allowsMultipleSelections()
  Deprecated.
clear()
  Deprecated.
countItems()
  Deprecated.
delItem(int)
  Removes an item from the list.
delItems(int, int)
  Deprecated.
deselect(int)
  Deselects the item at the specified index.
getItem(int)
  Gets the item associated with the specified index.
getItemCount()
  Returns the number of items in the list.
getItems()
  Returns the items in the list.
getMinimumSize()
  Returns the minimum dimensions needed for the list.
getMinimumSize(int)
  Returns the minimum dimensions needed for the amount of rows in the list.
getPreferredSize()
  Returns the preferred dimensions needed for the list.
getPreferredSize(int)
  Returns the preferred dimensions needed for the list with the specified amount of rows.
getRows()
  Returns the number of visible lines in this list.
getSelectedIndex()
  Get the selected item on the list or -1 if no item is selected.
getSelectedIndexes()
  Returns the selected indexes on the list.
getSelectedItem()
  Returns the selected item on the list or null if no item is selected.
getSelectedItems()
  Returns the selected items on the list in an array of Strings.
getSelectedObjects()
  Returns the selected items on the list in an array of Objects.
getVisibleIndex()
  Gets the index of the item that was last made visible by the method makeVisible.
isIndexSelected(int)
  Returns true if the item at the specified index has been selected; false otherwise.
isMultipleMode()
  Returns true if this list allows multiple selections.
isSelected(int)
  Deprecated.
makeVisible(int)
  Forces the item at the specified index to be visible.
minimumSize()
  Deprecated.
minimumSize(int)
  Deprecated.
paramString()
  Returns the parameter String of this list.
preferredSize()
  Deprecated.
preferredSize(int)
  Deprecated.
processActionEvent(ActionEvent)
  Processes action events occurring on this component by dispatching them to any registered ActionListener objects.
processEvent(AWTEvent)
  Processes events on this list.
processItemEvent(ItemEvent)
  Processes item events occurring on this list by dispatching them to any registered ItemListener objects.
remove(int)
  Removes an item from the list.
remove(String)
  Remove the first occurrence of item from the list.
removeActionListener(ActionListener)
  Removes the specified action listener so it no longer receives action events from this list.
removeAll()
  Removes all items from the list.
removeItemListener(ItemListener)
  Removes the specified item listener so it no longer receives item events from this list.
removeNotify()
  Removes the peer for this list.
replaceItem(String, int)
  Replaces the item at the given index.
select(int)
  Selects the item at the specified index.
setMultipleMode(boolean)
  Sets whether this list should allow multiple selections or not.
setMultipleSelections(boolean)
  Deprecated.

##

List

      public List()

  Creates a new scrolling list initialized with no visible Lines or multiple selections.

List

      public List(int rows)

  Creates a new scrolling list initialized with the specified number of visible lines and a boolean stating whether multiple selections are allowed or not.

  Parameters:
    rows - the number of items to show.
    multipleMode - if true then multiple selections are allowed.

List

      public List(int rows,
                  boolean multipleMode)

  Creates a new scrolling list initialized with the specified number of visible lines and a boolean stating whether multiple selections are allowed or not.

  Parameters:
    rows - the number of items to show.
    multipleMode - if true then multiple selections are allowed.

##

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

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

getItemCount

      public int getItemCount()

  Returns the number of items in the list.

  See Also:
    getItem

countItems

      public int countItems()

  Note: countItems() is 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
  See Also:
    getItemCount

getItems

      public synchronized String[] getItems()

  Returns the items in the list.

  See Also:
    select, deselect, isIndexSelected

add

      public void add(String item)

  Adds the specified item to the end of scrolling list.

  Parameters:
    item - the item to be added

addItem

      public void addItem(String item)

  Adds the specified item to the end of scrolling list.

  Parameters:
    item - the item to be added

add

      public synchronized void add(String item,
                                   int index)

  Adds the specified item to the scrolling list at the specified position.

  Parameters:
    item - the item to be added
    index - the position at which to put in the item. The index is zero-based. If index is -1 then the item is added to the end. If index is greater than the number of items in the list, the item gets added at the end.

addItem

      public synchronized void addItem(String item,
                                       int index)

  Adds the specified item to the scrolling list at the specified position.

  Parameters:
    item - the item to be added
    index - the position at which to put in the item. The index is zero-based. If index is -1 then the item is added to the end. If index is greater than the number of items in the list, the item gets added at the end.

replaceItem

      public synchronized void replaceItem(String newValue,
                                           int index)

  Replaces the item at the given index.

  Parameters:
    newValue - the new value to replace the existing item
    index - the position of the item to replace

removeAll

      public synchronized void removeAll()

  Removes all items from the list.

  See Also:
    remove, delItems

clear

      public synchronized void clear()

  Note: clear() is deprecated. As of JDK version 1.1, replaced by removeAll().

remove

      public synchronized void remove(String item)

  Remove the first occurrence of item from the list.

  Parameters:
    item - the item to remove from the list
  Throws: IllegalArgumentException
    If the item doesn't exist in the list.

remove

      public synchronized void remove(int position)

  Removes an item from the list.

delItem

      public synchronized void delItem(int position)

  Removes an item from the list.

getSelectedIndex

      public synchronized int getSelectedIndex()

  Get the selected item on the list or -1 if no item is selected.

  See Also:
    select, deselect, isIndexSelected

getSelectedIndexes

      public synchronized int[] getSelectedIndexes()

  Returns the selected indexes on the list.

  See Also:
    select, deselect, isIndexSelected

getSelectedItem

      public synchronized String getSelectedItem()

  Returns the selected item on the list or null if no item is selected.

  See Also:
    select, deselect, isIndexSelected

getSelectedItems

      public synchronized String[] getSelectedItems()

  Returns the selected items on the list in an array of Strings.

  See Also:
    select, deselect, isIndexSelected

getSelectedObjects

      public Object[] getSelectedObjects()

  Returns the selected items on the list in an array of Objects.

  See Also:
    ItemSelectable.

select

      public synchronized void select(int index)

  Selects the item at the specified index.

  Parameters:
    index - the position of the item to select
  See Also:
    getSelectedItem, deselect, isIndexSelected

deselect

      public synchronized void deselect(int index)

  Deselects the item at the specified index.

  Parameters:
    index - the position of the item to deselect
  See Also:
    select, getSelectedItem, isIndexSelected

isIndexSelected

      public boolean isIndexSelected(int index)

  Returns true if the item at the specified index has been selected; false otherwise.

  Parameters:
    index - the item to be checked
  See Also:
    select, deselect

isSelected

      public boolean isSelected(int index)

  Note: isSelected() is deprecated. As of JDK version 1.1, replaced by isIndexSelected(int).

getRows

      public int getRows()

  Returns the number of visible lines in this list.

isMultipleMode

      public boolean isMultipleMode()

  Returns true if this list allows multiple selections.

  See Also:
    setMultipleMode

allowsMultipleSelections

      public boolean allowsMultipleSelections()

  Note: allowsMultipleSelections() is deprecated. As of JDK version 1.1, replaced by isMultipleMode().

setMultipleMode

      public synchronized void setMultipleMode(boolean b)

  Sets whether this list should allow multiple selections or not.

  Parameters:
    v - the boolean to allow multiple selections
  See Also:
    isMultipleMode

setMultipleSelections

      public synchronized void setMultipleSelections(boolean b)

  Note: setMultipleSelections() is 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.

makeVisible

      public synchronized void makeVisible(int index)

  Forces the item at the specified index to be visible.

  Parameters:
    index - the position of the item
  See Also:
    getVisibleIndex

getPreferredSize

      public Dimension getPreferredSize(int rows)

  Returns the preferred dimensions needed for the list with the specified amount of rows.

  Parameters:
    rows - amount of rows in list.

preferredSize

      public Dimension preferredSize(int rows)

  Note: preferredSize() is deprecated. As of JDK version 1.1, replaced by getPreferredSize(int).

getPreferredSize

      public Dimension getPreferredSize()

  Returns the preferred dimensions needed for the list.

  Returns:
    the preferred size with the specified number of rows if the row size is greater than 0.
  Overrides:
    getPreferredSize in class Component

preferredSize

      public Dimension preferredSize()

  Note: preferredSize() is deprecated. As of JDK version 1.1, replaced by getPreferredSize().

  Overrides:
    preferredSize in class Component

getMinimumSize

      public Dimension getMinimumSize(int rows)

  Returns the minimum dimensions needed for the amount of rows in the list.

  Parameters:
    rows - minimum amount of rows in the list

minimumSize

      public Dimension minimumSize(int rows)

  Note: minimumSize() is deprecated. As of JDK version 1.1, replaced by getMinimumSize(int).

getMinimumSize

      public Dimension getMinimumSize()

  Returns the minimum dimensions needed for the list.

  Returns:
    the preferred size with the specified number of rows if the row size is greater than zero.
  Overrides:
    getMinimumSize in class Component

minimumSize

      public Dimension minimumSize()

  Note: minimumSize() is 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 recieve item events from this list.

  Parameters:
    l - the item listener

removeItemListener

      public void removeItemListener(ItemListener l)

  Removes the specified item listener so it no longer receives item events from this list.

  Parameters:
    l - the item listener

addActionListener

      public void addActionListener(ActionListener l)

  Adds the specified action listener to receive action events from this list. Action events occur when a list item is double-clicked.

  Parameters:
    l - the action listener

removeActionListener

      public void removeActionListener(ActionListener l)

  Removes the specified action listener so it no longer receives action events from this list.

  Parameters:
    l - the action listener

processEvent

      protected void processEvent(AWTEvent e)

  Processes events on this list. If the event is an ItemEvent, it invokes the processItemEvent method, else if the event is an ActionEvent, it invokes the processActionEvent method, else it invokes the superclass's processEvent.

  Parameters:
    e - the event
  Overrides:
    processEvent in class Component

processItemEvent

      protected void processItemEvent(ItemEvent e)

  Processes item events occurring on this list by dispatching them to any registered ItemListener objects. NOTE: This method will not be called unless item events are enabled for this component; this happens when one of the following occurs: a) An ItemListener object is registered via addItemListener() b) Item events are enabled via enableEvents()

  Parameters:
    e - the item event
  See Also:
    enableEvents

processActionEvent

      protected void processActionEvent(ActionEvent e)

  Processes action events occurring on this component by dispatching them to any registered ActionListener objects. NOTE: This method will not be called unless action events are enabled for this component; this happens when one of the following occurs: a) An ActionListener object is registered via addActionListener() b) Action events are enabled via enableEvents()

  Parameters:
    e - the action event
  See Also:
    enableEvents

paramString

      protected String paramString()

  Returns the parameter String of this list.

  Overrides:
    paramString in class Component

delItems

      public synchronized void delItems(int start,
                                        int end)

  Note: delItems() is 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.

    All Packages  Class Hierarchy  This Package  Previous  Next  Index