org.eclipse.ercp.swt.mobile
Class ListView

java.lang.Object
  extended by org.eclipse.swt.widgets.Widget
      extended by org.eclipse.swt.widgets.Control
          extended by org.eclipse.swt.widgets.Scrollable
              extended by org.eclipse.ercp.swt.mobile.ListView
All Implemented Interfaces:
Drawable

public class ListView
extends Scrollable

A widget that allows the user to select one or more items from a collection of items that can be displayed in a multi-column way with different styles.

ListView lays out its children items in one or more columns from top to bottom. If a layout orientation hint is not specified, the implementation chooses the orientation. If there is only enough screen width for one column, the list scrolls vertically. If there is room to display multiple columns within the widget, then the list scrolls horizontally. The list never scrolls in more than one direction. The layout orientation may be set at runtime by calling method setLayout(int).

The item density hint determines the size and positioning of items in order to fit more or less within the widget. Applications can query the preferred sizes of the icons for each density level. Note that the sizes may be diverse in different platforms. When the given icons do not match the prefered size, the implementation may adjust icon sizes without throwing any exception. Applications can change the item density level at runtime by calling method setLayoutDensity(int). Some platforms may use context-sensitive device keys to allow the user to change the ListView's density level at run-time. For example, by activating "zoom in/out" device keys when the ListView is focused.

Applications can query the current layout and density values by calling the corresponding "get" methods.

SWT styles:
SINGLE, MULTI: single or multiple selection
VERTICAL, HORIZONTAL: defines the layout orientation
ListView density levels:
HIGH, MEDIUM (default), LOW: defines the item density levels that determine the numbers of visible list items per screen
Events:
Selection, DefaultSelection

Note: If styles not applicable to ListView are specified, they are ignored.

Note: ListView is a subclass of Scrollable. Changing the scrollbar values ( ScrollBar.setSelection(int)) will affect the scrolling position of the ListView control. However, changing the range of scrollbars, such as setMaximum(int) and setMinimum(int), will not affect the ListView at all.

IMPORTANT: This class is not intended to be subclassed.


Field Summary
static int HIGH
          A high density level.
static int LOW
          A low density level.
static int MEDIUM
          A medium density level.
 
Constructor Summary
ListView(Composite parent, int style)
          Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.
ListView(Composite parent, int style, int density)
          Constructs a new instance of this class given its parent and a style value describing its behavior and appearance styles.
 
Method Summary
 void add(java.lang.String item, Image icon)
          Adds the string item and an optional icon to the end of the receiver's list.
 void add(java.lang.String string, Image icon, int index)
          Adds the string item and an optional icon to the receiver's list at the given zero-relative index.
 void addSelectionListener(SelectionListener listener)
          Adds the listener to the collection of listeners who will be notified when the receiver's selection changes.
 void deselect(int index)
          Deselects the item at the given zero-relative index in the receiver.
 void deselect(int[] indices)
          Deselects the items at the given zero-relative indices in the receiver.
 void deselect(int start, int end)
          Deselects the items at the given zero-relative indices in the receiver.
 void deselectAll()
          Deselects all selected items in the receiver.
 int getFocusIndex()
          Returns the zero-relative index of the item which currently has the focus in the receiver, or -1 if no item has focus.
 Image getIcon(int index)
          Returns the item icon at the given, zero-relative index in the receiver.
 Point getIconSize(int style)
          Gets the preferred icon size that matches the density style.
 java.lang.String getItem(int index)
          Returns the item at the given, zero-relative index in the receiver.
 int getItemCount()
          Returns the number of items contained in the receiver.
 java.lang.String[] getItems()
          Returns an array of String s which are the items in the receiver.
 int getLayout()
          Returns the value of the layout orientation.
 int getLayoutDensity()
          Returns the value of the item density level.
 java.lang.String[] getSelection()
          Returns an array of String s that are currently selected in the receiver.
 int getSelectionCount()
          Returns the number of selected items contained in the receiver.
 int[] getSelectionIndices()
          Returns the zero-relative indices of the items which are currently selected in the receiver.
 int getTopIndex()
          Returns the zero-relative index of the item which is currently at the top of the receiver.
 int indexOf(java.lang.String string)
          Gets the index of an item.
 int indexOf(java.lang.String string, int start)
          Searches the receiver's list starting at the given, zero-relative index until an item is found that is equal to the argument, and returns the index of that item.
 boolean isSelected(int index)
          Returns true if the item is selected, and false otherwise.
 void remove(int index)
          Removes the item from the receiver at the given zero-relative index.
 void remove(int[] indices)
          Removes the items from the receiver at the given zero-relative indices.
 void remove(int start, int end)
          Removes the items from the receiver which are between the given zero-relative start and end indices (inclusive).
 void remove(java.lang.String string)
          Searches the receiver's list starting at the first item until an item is found that is equal to the argument, and removes that item from the list.
 void removeAll()
          Removes all of the items from the receiver.
 void removeSelectionListener(SelectionListener listener)
          Removes the listener from the collection of listeners who will be notified when the receiver's selection changes.
 void select(int index)
          Selects the item at the given zero-relative index in the receiver's list.
 void select(int[] indices)
          Selects the items at the given zero-relative indices in the receiver.
 void select(int start, int end)
          Selects the items in the range specified by the given zero-relative indices in the receiver.
 void selectAll()
          Selects all of the items in the receiver.
 void setItem(int index, java.lang.String string, Image icon)
          Sets the text and icon of the item in the receiver's list at the given zero-relative index to the string argument.
 void setItems(java.lang.String[] items, Image[] icons)
          Sets the receiver's items to be the given array of items and icons.
 void setLayout(int style)
          Changes the widget layout orientation, which affects which way the widget scrolls.
 void setLayoutDensity(int style)
          Changes the item density level.
 void setSelection(int index)
          Selects the item at the given zero-relative index in the receiver.
 void setSelection(int[] indices)
          Selects the items at the given zero-relative indices in the receiver.
 void setSelection(int start, int end)
          Selects the items in the range specified by the given zero-relative indices in the receiver.
 void setSelection(java.lang.String[] items)
          Sets the receiver's selection to be the given array of items.
 void showSelection()
          Shows the selection.
 
Methods inherited from class org.eclipse.swt.widgets.Scrollable
computeTrim, getClientArea, getHorizontalBar, getVerticalBar
 
Methods inherited from class org.eclipse.swt.widgets.Control
addControlListener, addFocusListener, addKeyListener, addMouseListener, addMouseMoveListener, addPaintListener, addTraverseListener, computeSize, computeSize, forceFocus, getBackground, getBorderWidth, getBounds, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getParent, getShell, getSize, getToolTipText, getVisible, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setEnabled, setFocus, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update
 
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LOW

public static final int LOW
A low density level.

Value 1 is assigned to LOW.

See Also:
Constant Field Values

MEDIUM

public static final int MEDIUM
A medium density level.

Value 2 is assigned to MEDIUM.

See Also:
Constant Field Values

HIGH

public static final int HIGH
A high density level.

Value 3 is assigned to HIGH.

See Also:
Constant Field Values
Constructor Detail

ListView

public ListView(Composite parent,
                int style)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR 'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:
parent - a widget which will be the parent of the new instance (cannot be null)
style - the style value of the widget to construct. See Description for details.
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the parent is null
SWTException -
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
See Also:
SWT.SINGLE, SWT.MULTI, SWT.HORIZONTAL, SWT.VERTICAL

ListView

public ListView(Composite parent,
                int style,
                int density)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance styles.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR 'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

The density style is one of HIGH, MEDIUM and LOW.

Parameters:
parent - a widget which will be the parent of the new instance (cannot be null)
style - the style value of the widget to construct. See Description for details.
density - the density style value.
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the parent is null
  • ERROR_INVALID_ARGUMENT - if the density is invalid
SWTException -
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
See Also:
SWT.SINGLE, SWT.MULTI, SWT.HORIZONTAL, SWT.VERTICAL, HIGH, MEDIUM, LOW, getLayoutDensity()
Method Detail

getLayoutDensity

public int getLayoutDensity()
Returns the value of the item density level.

Returns:
the density level. One of HIGH, MEDIUM, or LOW.
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also:
LOW, MEDIUM, HIGH

getLayout

public int getLayout()
Returns the value of the layout orientation.

Returns:
the scrolling orientation value. One of SWT.VERTICAL and SWT.HORIZONTAL
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also:
SWT.HORIZONTAL, SWT.VERTICAL

add

public void add(java.lang.String item,
                Image icon)
Adds the string item and an optional icon to the end of the receiver's list.

Parameters:
item - the new item text
icon - the icon of the item, or null.
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the item is null
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_ITEM_NOT_ADDED - if the operation fails because of an operating system failure
See Also:
add(String,Image, int)

add

public void add(java.lang.String string,
                Image icon,
                int index)
Adds the string item and an optional icon to the receiver's list at the given zero-relative index.

Note: To add an item at the end of the list, use the result of calling getItemCount() as the index or use add(String, Image).

Parameters:
string - the new item
icon - the icon part of the item, or null.
index - the index for the item
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the string is null
  • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list (inclusive)
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_ITEM_NOT_ADDED - if the operation fails because of an operating system failure
See Also:
add(String, Image)

addSelectionListener

public void addSelectionListener(SelectionListener listener)
Adds the listener to the collection of listeners who will be notified when the receiver's selection changes. The listener receives the messages defined in the SelectionListener interface.

widgetSelected is called when the selection changes. widgetDefaultSelected is typically called when an item is double-clicked.

Parameters:
listener - the listener which should be notified
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the listener is null
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also:
SelectionListener, removeSelectionListener(org.eclipse.swt.events.SelectionListener), SelectionEvent

deselect

public void deselect(int index)
Deselects the item at the given zero-relative index in the receiver. If the item at the index was already deselected, it remains deselected. Indices that are out of range are ignored.

Parameters:
index - the index of the item to deselect
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

deselect

public void deselect(int start,
                     int end)
Deselects the items at the given zero-relative indices in the receiver. If the items at the given zero-relative indexes in the receiver were selected, they are deselected. If they were not selected, they remain deselected. The range of the indices is inclusive. Indices that are out of range are ignored.

Parameters:
start - the start index of the items to deselect
end - the end index of the items to deselect
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

deselect

public void deselect(int[] indices)
Deselects the items at the given zero-relative indices in the receiver. If the items at the given zero-relative indexes in the receiver are selected, they are deselected. If they were not selected, they remain deselected. Indices that are out of range and duplicate indices are ignored.

Parameters:
indices - the array of indices for the items to deselect
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the set of indices is null
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

deselectAll

public void deselectAll()
Deselects all selected items in the receiver.

Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getFocusIndex

public int getFocusIndex()
Returns the zero-relative index of the item which currently has the focus in the receiver, or -1 if no item has focus.

Returns:
the index of the selected item
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItem

public java.lang.String getItem(int index)
Returns the item at the given, zero-relative index in the receiver. Throws an exception if the index is out of range.

Parameters:
index - the index of the item to return
Returns:
the item at the given index
Throws:
java.lang.IllegalArgumentException -
  • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_CANNOT_GET_ITEM - if the operation fails because of an operating system failure

getIcon

public Image getIcon(int index)
Returns the item icon at the given, zero-relative index in the receiver. Throws an exception if the index is out of range.

Parameters:
index - the index of the item to return
Returns:
the associated icon at the given index. Null means no icon defined.
Throws:
java.lang.IllegalArgumentException -
  • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_CANNOT_GET_ITEM - if the operation fails because of an operating system failure

getIconSize

public Point getIconSize(int style)
Gets the preferred icon size that matches the density style. The style must be one of HIGH, MEDIUM, or or LOW.

Parameters:
style - the size style. Only HIGH, MEDIUM, and LOW can be used.
Returns:
Point the best icon size in pixel (width and height). Must be positive values.
Throws:
java.lang.IllegalArgumentException -
  • ERROR_INVALID_ARGUMENT - if the style value is invalid
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also:
LOW, MEDIUM, HIGH

getItemCount

public int getItemCount()
Returns the number of items contained in the receiver.

Returns:
the number of items
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_CANNOT_GET_COUNT - if the operation fails because of an operating system failure

getItems

public java.lang.String[] getItems()
Returns an array of String s which are the items in the receiver.

Note: This is not the actual structure used by the receiver to maintain its list of items, so modifying the array will not affect the receiver.

Returns:
the items in the receiver's list
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_CANNOT_GET_ITEM - if the operation fails because of an operating system failure while getting an item
  • ERROR_CANNOT_GET_COUNT - if the operation fails because of an operating system failure while getting the item count

getSelection

public java.lang.String[] getSelection()
Returns an array of String s that are currently selected in the receiver. An empty array indicates that no items are selected.

Note: This is not the actual structure used by the receiver to maintain its selection, so modifying the array will not affect the receiver.

Returns:
an array representing the selection
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_CANNOT_GET_SELECTION - if the operation fails because of an operating system failure while getting the selection
  • ERROR_CANNOT_GET_ITEM - if the operation fails because of an operating system failure while getting an item

getSelectionCount

public int getSelectionCount()
Returns the number of selected items contained in the receiver.

Returns:
the number of selected items
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_CANNOT_GET_COUNT - if the operation fails because of an operating system failure

getSelectionIndices

public int[] getSelectionIndices()
Returns the zero-relative indices of the items which are currently selected in the receiver. The array is empty if no items are selected.

Note: This is not the actual structure used by the receiver to maintain its selection, so modifying the array will not affect the receiver.

Returns:
the array of indices of the selected items
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_CANNOT_GET_SELECTION - if the operation fails because of an operating system failure

getTopIndex

public int getTopIndex()
Returns the zero-relative index of the item which is currently at the top of the receiver. This index can change when items are scrolled or new items are added or removed.

Returns:
the index of the top item
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

indexOf

public int indexOf(java.lang.String string)
Gets the index of an item.

The list is searched starting at 0 until an item is found that is equal to the search item. If no item is found, -1 is returned. Indexing is zero based.

Parameters:
string - the search item
Returns:
the index of the item
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the string is null
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

indexOf

public int indexOf(java.lang.String string,
                   int start)
Searches the receiver's list starting at the given, zero-relative index until an item is found that is equal to the argument, and returns the index of that item. If no item is found or the starting index is out of range, returns -1.

Parameters:
string - the search item
start - the zero-relative index at which to start the search
Returns:
the index of the item
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the string is null
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_CANNOT_GET_COUNT - if the operation fails because of an operating system failure while getting the item count
  • ERROR_CANNOT_GET_ITEM - if the operation fails because of an operating system failure while getting an item

isSelected

public boolean isSelected(int index)
Returns true if the item is selected, and false otherwise. Indices out of range are ignored.

Parameters:
index - the index of the item
Returns:
the visibility state of the item at the index
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

remove

public void remove(int index)
Removes the item from the receiver at the given zero-relative index.

Parameters:
index - the index for the item
Throws:
java.lang.IllegalArgumentException -
  • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_ITEM_NOT_REMOVED - if the operation fails because of an operating system failure

remove

public void remove(int start,
                   int end)
Removes the items from the receiver which are between the given zero-relative start and end indices (inclusive).

Parameters:
start - the start of the range
end - the end of the range
Throws:
java.lang.IllegalArgumentException -
  • ERROR_INVALID_RANGE - if either the start or end are not between 0 and the number of elements in the list minus 1 (inclusive)
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_ITEM_NOT_REMOVED - if the operation fails because of an operating system failure

remove

public void remove(java.lang.String string)
Searches the receiver's list starting at the first item until an item is found that is equal to the argument, and removes that item from the list.

Parameters:
string - the item to remove
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the string is null
  • ERROR_INVALID_ARGUMENT - if the string is not found in the list
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_ITEM_NOT_REMOVED - if the operation fails because of an operating system failure

remove

public void remove(int[] indices)
Removes the items from the receiver at the given zero-relative indices.

Parameters:
indices - the array of indices of the items
Throws:
java.lang.IllegalArgumentException -
  • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
  • ERROR_NULL_ARGUMENT - if the indices array is null
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_ITEM_NOT_REMOVED - if the operation fails because of an operating system failure

removeAll

public void removeAll()
Removes all of the items from the receiver.

Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)
Removes the listener from the collection of listeners who will be notified when the receiver's selection changes.

Parameters:
listener - the listener which should no longer be notified
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the listener is null
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also:
SelectionListener, addSelectionListener(org.eclipse.swt.events.SelectionListener)

select

public void select(int index)
Selects the item at the given zero-relative index in the receiver's list. If the item at the index was already selected, it remains selected. Indices that are out of range are ignored.

Parameters:
index - the index of the item to select
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

select

public void select(int start,
                   int end)
Selects the items in the range specified by the given zero-relative indices in the receiver. The range of indices is inclusive. The current selection is not cleared before the new items are selected.

If an item in the given range is not selected, it is selected. If an item in the given range was already selected, it remains selected. Indices that are out of range are ignored and no items will be selected if start is greater than end. If the receiver is single-select and there is more than one item in the given range, then all indices are ignored.

Parameters:
start - the start of the range
end - the end of the range
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also:
List.setSelection(int,int)

select

public void select(int[] indices)
Selects the items at the given zero-relative indices in the receiver. The current selection is not cleared before the new items are selected.

If the item at a given index is not selected, it is selected. If the item at a given index was already selected, it remains selected. Indices that are out of range and duplicate indices are ignored. If the receiver is single-select and multiple indices are specified, then all indices are ignored.

Parameters:
indices - the array of indices for the items to select
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the array of indices is null
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also:
List.setSelection(int[])

selectAll

public void selectAll()
Selects all of the items in the receiver.

If the receiver is single-select, do nothing.

Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setItem

public void setItem(int index,
                    java.lang.String string,
                    Image icon)
Sets the text and icon of the item in the receiver's list at the given zero-relative index to the string argument. This is equivalent to remove 'ing the old item at the index, and then add 'ing the new item at that index.

Parameters:
index - the index for the item
string - the new text for the item
icon - the icon image for the item, can be Null.
Throws:
java.lang.IllegalArgumentException -
  • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
  • ERROR_NULL_ARGUMENT - if the string is null
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_ITEM_NOT_REMOVED - if the remove operation fails because of an operating system failure
  • ERROR_ITEM_NOT_ADDED - if the add operation fails because of an operating system failure

setItems

public void setItems(java.lang.String[] items,
                     Image[] icons)
Sets the receiver's items to be the given array of items and icons.

Parameters:
items - the array of items
icons - the array of icons. Can be NULL.
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the items array is null
  • ERROR_INVALID_RANGE - if number of elements in icons does not match the number in items
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
SWTError -
  • ERROR_ITEM_NOT_ADDED - if the operation fails because of an operating system failure

setLayout

public void setLayout(int style)
Changes the widget layout orientation, which affects which way the widget scrolls.

Parameters:
style - the orientation style. Only SWT.VERTICAL and SWT.HORIZONTAL can be used.
Throws:
java.lang.IllegalArgumentException -
  • ERROR_INVALID_ARGUMENT - if the style value is invalid
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also:
SWT.HORIZONTAL, SWT.VERTICAL

setLayoutDensity

public void setLayoutDensity(int style)
Changes the item density level.

Parameters:
style - the density level. Only HIGH, MEDIUM, LOW can be used.
Throws:
java.lang.IllegalArgumentException -
  • ERROR_INVALID_ARGUMENT - if the style value is invalid
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also:
LOW, MEDIUM, HIGH

setSelection

public void setSelection(int index)
Selects the item at the given zero-relative index in the receiver. If the item at the index was already selected, it remains selected. The current selected is first cleared, then the new items are selected. Indices that are out of range are ignored.

Parameters:
index - the index of the item to select
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also:
List.deselectAll(), List.select(int)

setSelection

public void setSelection(int start,
                         int end)
Selects the items in the range specified by the given zero-relative indices in the receiver. The range of indices is inclusive. The current selection is cleared before the new items are selected.

Indices that are out of range are ignored and no items will be selected if start is greater than end. If the receiver is single-select and there is more than one item in the given range, then all indices are ignored.

Parameters:
start - the start index of the items to select
end - the end index of the items to select
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also:
List.deselectAll(), List.select(int,int)

setSelection

public void setSelection(int[] indices)
Selects the items at the given zero-relative indices in the receiver. The current selection is cleared before the new items are selected.

Indices that are out of range and duplicate indices are ignored. If the receiver is single-select and multiple indices are specified, then all indices are ignored.

Parameters:
indices - the indices of the items to select
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the array of indices is null
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also:
List.deselectAll(), List.select(int[])

setSelection

public void setSelection(java.lang.String[] items)
Sets the receiver's selection to be the given array of items. The current selection is cleared before the new items are selected.

Items that are not in the receiver are ignored. If the receiver is single-select and multiple items are specified, then all items are ignored.

Parameters:
items - the array of items
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the array of items is null
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
See Also:
List.deselectAll(), List.select(int[]), List.setSelection(int[])

showSelection

public void showSelection()
Shows the selection. If the selection is already showing in the receiver, this method simply returns. Otherwise, the items are scrolled until the selection is visible. When multiple items are selected, the selection of which item becomes visible is implementation-dependent.

Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver