Class java.awt.List

All Packages    This Package    Previous    Next

Class java.awt.List

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

public class List
extends Component

A scrolling list of text items.

Version:: 1.18, 09/01/95
Author:: Sami Shaio

List(): Creates a new scrolling list initialized with no visible Lines or multiple selections.
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.

addItem(String): Adds the specified item to the end of scrolling list.
addNotify(): Creates the peer for the list.
allowsMultipleSelections(): Returns true if this list allows multiple selections.
clear(): Clears the list.
countItems(): Returns the number of items in the list.
delItem(int): Delete an item from the list.
delItems(int, int): Delete multiple items from the list.
deselect(int): Deselects the item at the specified index.
getItem(int): Gets the item associated with the specified index.
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.
getVisibleIndex(): Gets the index of the item that was last made visible by the method makeVisible.
isSelected(int): Returns true if the item at the specified index has been selected; false otherwise.
makeVisible(int): Forces the item at the specified index to be visible.
minimumSize(int): Returns the minimum dimensions needed for the amount of rows in the list.
minimumSize(): Returns the minimum dimensions needed for the list.
paramString(): Returns the parameter String of this list.
preferredSize(int): Returns the preferred dimensions needed for the list with the specified amount of rows.
preferredSize(): Returns the preferred dimensions needed for the list.
removeNotify(): Removes the peer for this list.
select(int): Selects the item at the specified index.
setMultipleSelections(boolean): Sets whether this list should allow multiple selections or not.

List

  public List()

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

List

  public List(int rows,
              boolean multipleSelections)

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.; multipleSelections - if true then multiple selections are allowed.

addNotify

  public synchronized 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 synchronized 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

countItems

  public int countItems()

Returns the number of items in the list.

See Also:: getItem

getItem

  public String getItem(int index)

Gets the item associated with the specified index.

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

addItem

  public synchronized void addItem(String item)

Adds the specified item to the end of scrolling list.

Parameters:: item - the item to be added

clear

  public synchronized void clear()

Clears the list.

See Also:: delItem, delItems

delItem

  public synchronized void delItem(int position)

Delete an item from the list.

delItems

  public synchronized void delItems(int start,
                                    int end)

Delete multiple items 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, isSelected

getSelectedIndexes

  public synchronized int[] getSelectedIndexes()

Returns the selected indexes on the list.

See Also:: select, deselect, isSelected

getSelectedItem

  public synchronized String getSelectedItem()

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

See Also:: select, deselect, isSelected

getSelectedItems

  public synchronized String[] getSelectedItems()

Returns the selected items on the list.

See Also:: select, deselect, isSelected

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, isSelected

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, isSelected

isSelected

  public synchronized boolean isSelected(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

getRows

  public int getRows()

Returns the number of visible lines in this list.

allowsMultipleSelections

  public boolean allowsMultipleSelections()

Returns true if this list allows multiple selections.

See Also:: setMultipleSelections

setMultipleSelections

  public void setMultipleSelections(boolean v)

Sets whether this list should allow multiple selections or not.

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

getVisibleIndex

  public int getVisibleIndex()

Gets the index of the item that was last made visible by the method makeVisible.

makeVisible

  public void makeVisible(int index)

Forces the item at the specified index to be visible.

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

preferredSize

  public Dimension preferredSize(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()

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:: preferredSize in class Component

minimumSize

  public Dimension minimumSize(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()

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:: minimumSize in class Component

paramString

  protected String paramString()

Returns the parameter String of this list.

Overrides:: paramString in class Component

All Packages    This Package    Previous    Next