Top Description Fields Constructors Methods
org.eclipse.swt.widgets

public Class List

extends Scrollable
Class Inheritance
Imports
org.eclipse.swt.*, org.eclipse.swt.events.*, org.eclipse.swt.graphics.*, org.eclipse.swt.internal.*, org.eclipse.swt.internal.gtk.*, org.eclipse.swt.internal.gtk3.*, org.eclipse.swt.internal.gtk4.*
Instances of this class represent a selectable user interface object that displays a list of strings and issues notification when a string is selected. A list may be single or multi select.
Styles:
SINGLE, MULTI
Events:
Selection, DefaultSelection

Note

Only one of SINGLE and MULTI may be specified.

Important Note

This class is not intended to be subclassed.

See Also
List snippets, SWT Example: ControlExample, Sample code and further information

Field Summary

Modifier and TypeField and Description
pack-priv double
cachedAdjustment

pack-priv double
currentAdjustment

pack-priv long
modelHandle

pack-priv boolean
rowActivated

pack-priv int
selectionCountOnPress

pack-priv int
selectionCountOnRelease

pack-priv static final int
TEXT_COLUMN

pack-priv int
topIndex

Inherited from org.eclipse.swt.widgets.Scrollable:
horizontalBarRESIZE_ON_GETCLIENTAREAscrolledHandleverticalBar

Constructor Summary

AccessConstructor and Description
public
List(Composite
a composite control which will be the parent of the new instance (cannot be null)
parent, int
the style of control to construct
style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

Modifier and TypeMethod and Description
public void
add(String
the new item
string)

Adds the argument to the end of the receiver's list.

public void
add(String
the new item
string, int
the index for the item
index)

Adds the argument to the receiver's list at the given zero-relative index.

public void
addSelectionListener(SelectionListener
the listener which should be notified when the user changes the receiver's selection
listener)

Adds the listener to the collection of listeners who will be notified when the user changes the receiver's selection, by sending it one of the messages defined in the SelectionListener interface.

pack-priv int
applyThemeBackground()

Overrides org.eclipse.swt.widgets.Scrollable.applyThemeBackground.

pack-priv static int
checkStyle(int style)

pack-priv Point
computeSizeInPixels(int wHint, int hHint, boolean changed)

Overrides org.eclipse.swt.widgets.Control.computeSizeInPixels.

pack-priv void
createHandle(int index)

Overrides org.eclipse.swt.widgets.Widget.createHandle.

pack-priv GdkRGBA
defaultBackground()

Overrides org.eclipse.swt.widgets.Control.defaultBackground.

pack-priv void
deregister()

Overrides org.eclipse.swt.widgets.Scrollable.deregister.

public void
deselect(int
the index of the item to deselect
index)

Deselects the item at the given zero-relative index in the receiver.

public void
deselect(int
the start index of the items to deselect
start, int
the end index of the items to deselect
end)

Deselects the items at the given zero-relative indices in the receiver.

public void
deselect(int[]
the array of indices for the items to deselect
indices)

Deselects the items at the given zero-relative indices in the receiver.

public void
deselectAll()

Deselects all selected items in the receiver.

pack-priv boolean
dragDetect(int x, int y, boolean filter, boolean dragOnTimeout, boolean[] consume)

Overrides org.eclipse.swt.widgets.Control.dragDetect.

pack-priv long
eventWindow()

Overrides org.eclipse.swt.widgets.Control.eventWindow.

public int

Returns:

the index of the selected item
getFocusIndex()

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

public String

Returns:

the item at the given index
getItem(int
the index of the item to return
index)

Returns the item at the given, zero-relative index in the receiver.

public int

Returns:

the number of items
getItemCount()

Returns the number of items contained in the receiver.

public int

Returns:

the height of one item
getItemHeight()

Returns the height of the area which would be used to display one of the items in the list.

pack-priv int
getItemHeightInPixels()

public String[]

Returns:

the items in the receiver's list
getItems()

Returns a (possibly empty) array of Strings which are the items in the receiver.

public String[]

Returns:

an array representing the selection
getSelection()

Returns an array of Strings that are currently selected in the receiver.

public int

Returns:

the number of selected items
getSelectionCount()

Returns the number of selected items contained in the receiver.

public int

Returns:

the index of the selected item or -1
getSelectionIndex()

Returns the zero-relative index of the item which is currently selected in the receiver, or -1 if no item is selected.

public int[]

Returns:

the array of indices of the selected items
getSelectionIndices()

Returns the zero-relative indices of the items which are currently selected in the receiver.

pack-priv long
getTextRenderer(long column)

public int

Returns:

the index of the top item
getTopIndex()

Returns the zero-relative index of the item which is currently at the top of the receiver.

pack-priv long
gtk_button_press_event(long widget, long event)

Overrides org.eclipse.swt.widgets.Control.gtk_button_press_event.

pack-priv long
gtk_button_release_event(long widget, long event)

Overrides org.eclipse.swt.widgets.Control.gtk_button_release_event.

pack-priv long
gtk_changed(long widget)

Overrides org.eclipse.swt.widgets.Widget.gtk_changed.

pack-priv void
gtk_gesture_press_event(long
the corresponding controller responsible for capturing the event
gesture, int
how many touch/button presses happened with this one
n_press, double
the x coordinate, in widget allocation coordinates
x, double
the y coordinate, in widget allocation coordinates
y, long
the GdkEvent captured
event)

Overrides org.eclipse.swt.widgets.Control.gtk_gesture_press_event.

Handling multi-press event on GTK4
pack-priv long
gtk_key_press_event(long widget, long event)

Overrides org.eclipse.swt.widgets.Control.gtk_key_press_event.

pack-priv long
gtk_row_activated(long tree, long path, long column)

Overrides org.eclipse.swt.widgets.Widget.gtk_row_activated.

pack-priv void
hookEvents()

Overrides org.eclipse.swt.widgets.Control.hookEvents.

public int

Returns:

the index of the item
indexOf(String
the search item
string)

Gets the index of an item.

public int

Returns:

the index of the item
indexOf(String
the search item
string, int
the zero-relative index at which to start the search
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.

public boolean

Returns:

the selection state of the item at the index
isSelected(int
the index of the item
index)

Returns true if the item is selected, and false otherwise.

pack-priv void
keyPressDefaultSelectionHandler(long
the gtk key press event that was fired.
event, int key)

Used to emulate DefaultSelection event.

pack-priv long
paintWindow()

Overrides org.eclipse.swt.widgets.Control.paintWindow.

pack-priv void
register()

Overrides org.eclipse.swt.widgets.Scrollable.register.

pack-priv void
releaseWidget()

Overrides org.eclipse.swt.widgets.Control.releaseWidget.

public void
remove(int
the index for the item
index)

Removes the item from the receiver at the given zero-relative index.

public void
remove(int
the start of the range
start, int
the end of the range
end)

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

public void
remove(String
the item to remove
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.

public void
remove(int[]
the array of indices of the items
indices)

Removes the items from the receiver at the given zero-relative indices.

public void
removeAll()

Removes all of the items from the receiver.

public void
removeSelectionListener(SelectionListener
the listener which should no longer be notified
listener)

Removes the listener from the collection of listeners who will be notified when the user changes the receiver's selection.

public void
select(int
the index of the item to select
index)

Selects the item at the given zero-relative index in the receiver's list.

public void
select(int
the start of the range
start, int
the end of the range
end)

Selects the items in the range specified by the given zero-relative indices in the receiver.

public void
select(int[]
the array of indices for the items to select
indices)

Selects the items at the given zero-relative indices in the receiver.

public void
selectAll()

Selects all of the items in the receiver.

pack-priv void
selectFocusIndex(int index)

pack-priv void
sendTreeDefaultSelection()

Used to emulate DefaultSelection event.

pack-priv int
setBounds(int x, int y, int width, int height, boolean move, boolean resize)

Overrides org.eclipse.swt.widgets.Control.setBounds.

pack-priv void
setForegroundGdkRGBA(GdkRGBA rgba)

Overrides org.eclipse.swt.widgets.Control.setForegroundGdkRGBA.

public void
setItem(int
the index for the item
index, String
the new text for the item
string)

Sets the text of the item in the receiver's list at the given zero-relative index to the string argument.

public void
setItems(String...
the array of items
items)

Sets the receiver's items to be the given array of items.

public void
setSelection(int
the index of the item to select
index)

Selects the item at the given zero-relative index in the receiver.

public void
setSelection(int
the start index of the items to select
start, int
the end index of the items to select
end)

Selects the items in the range specified by the given zero-relative indices in the receiver.

public void
setSelection(int[]
the indices of the items to select
indices)

Selects the items at the given zero-relative indices in the receiver.

public void
setSelection(String[]
the array of items
items)

Sets the receiver's selection to be the given array of items.

public void
setTopIndex(int
the index of the top item
index)

Sets the zero-relative index of the item which is currently at the top of the receiver.

public void
showSelection()

Shows the selection.

Inherited from org.eclipse.swt.widgets.Scrollable:
clientHandlecomputeTrimcomputeTrimInPixelscreateScrollBarcreateWidgetdestroyScrollBargetBorderWidthInPixelsgetClientAreagetClientAreaInPixelsgetHorizontalBargetScrollbarsModegetVerticalBargtk_drawgtk_scroll_eventhScrollBarWidthredrawBackgroundImageredrawWidgetreleaseChildrenreleaseHandleresizeHandlereskinChildrensendLeaveNotifysetOrientationsetScrollBarVisibleshowWidgettopHandleupdateBackgroundModeupdateScrollBarValuevScrollBarWidth

Field Detail

cachedAdjustmentback to summary
pack-priv double cachedAdjustment
currentAdjustmentback to summary
pack-priv double currentAdjustment
modelHandleback to summary
pack-priv long modelHandle
rowActivatedback to summary
pack-priv boolean rowActivated
selectionCountOnPressback to summary
pack-priv int selectionCountOnPress
selectionCountOnReleaseback to summary
pack-priv int selectionCountOnRelease
TEXT_COLUMNback to summary
pack-priv static final int TEXT_COLUMN
topIndexback to summary
pack-priv int topIndex

Constructor Detail

Listback to summary
public List(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:Composite

a composite control which will be the parent of the new instance (cannot be null)

style:int

the style of control to construct

Exceptions
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, Widget#checkSubclass, Widget#getStyle

Method Detail

addback to summary
public void add(String string)

Adds the argument to the end of the receiver's list.

Note

If control characters like '\n', '\t' etc. are used in the string, then the behavior is platform dependent.

Parameters
string:String

the new item

Exceptions
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
See Also
add(String, int)
addback to summary
public void add(String string, int index)

Adds the argument 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).

Also note, if control characters like '\n', '\t' etc. are used in the string, then the behavior is platform dependent.

Parameters
string:String

the new item

index:int

the index for the item

Exceptions
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
See Also
add(String)
addSelectionListenerback to summary
public void addSelectionListener(SelectionListener listener)

Adds the listener to the collection of listeners who will be notified when the user changes the receiver's selection, by sending it one of 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:SelectionListener

the listener which should be notified when the user changes the receiver's selection

Exceptions
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, SelectionEvent
applyThemeBackgroundback to summary
pack-priv int applyThemeBackground()

Overrides org.eclipse.swt.widgets.Scrollable.applyThemeBackground.

Returns:int

Doc from org.eclipse.swt.widgets.Scrollable.applyThemeBackground.

  • 0 to remove THEME_BACKGROUND
  • 1 to apply THEME_BACKGROUND
  • otherwise don't change THEME_BACKGROUND state
    • Annotations
    @Override
    checkStyleback to summary
    pack-priv static int checkStyle(int style)
    computeSizeInPixelsback to summary
    pack-priv Point computeSizeInPixels(int wHint, int hHint, boolean changed)

    Overrides org.eclipse.swt.widgets.Control.computeSizeInPixels.

    Annotations
    @Override
    createHandleback to summary
    pack-priv void createHandle(int index)

    Overrides org.eclipse.swt.widgets.Widget.createHandle.

    Annotations
    @Override
    defaultBackgroundback to summary
    pack-priv GdkRGBA defaultBackground()

    Overrides org.eclipse.swt.widgets.Control.defaultBackground.

    Annotations
    @Override
    deregisterback to summary
    pack-priv void deregister()

    Overrides org.eclipse.swt.widgets.Scrollable.deregister.

    Annotations
    @Override
    deselectback to summary
    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:int

    the index of the item to deselect

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    deselectback to summary
    public void deselect(int start, int end)

    Deselects the items at the given zero-relative indices in the receiver. If the item at the given zero-relative index in the receiver is selected, it is deselected. If the item at the index was not selected, it remains deselected. The range of the indices is inclusive. Indices that are out of range are ignored.

    Parameters
    start:int

    the start index of the items to deselect

    end:int

    the end index of the items to deselect

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    deselectback to summary
    public void deselect(int[] indices)

    Deselects the items at the given zero-relative indices in the receiver. If the item at the given zero-relative index in the receiver is selected, it is deselected. If the item at the index was not selected, it remains deselected. Indices that are out of range and duplicate indices are ignored.

    Parameters
    indices:int[]

    the array of indices for the items to deselect

    Exceptions
    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
    deselectAllback to summary
    public void deselectAll()

    Deselects all selected items in the receiver.

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    dragDetectback to summary
    pack-priv boolean dragDetect(int x, int y, boolean filter, boolean dragOnTimeout, boolean[] consume)

    Overrides org.eclipse.swt.widgets.Control.dragDetect.

    Annotations
    @Override
    eventWindowback to summary
    pack-priv long eventWindow()

    Overrides org.eclipse.swt.widgets.Control.eventWindow.

    Annotations
    @Override
    getFocusIndexback to summary
    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:int

    the index of the selected item

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    getItemback to summary
    public 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:int

    the index of the item to return

    Returns:String

    the item at the given index

    Exceptions
    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
    getItemCountback to summary
    public int getItemCount()

    Returns the number of items contained in the receiver.

    Returns:int

    the number of items

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    getItemHeightback to summary
    public int getItemHeight()

    Returns the height of the area which would be used to display one of the items in the list.

    Returns:int

    the height of one item

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    getItemHeightInPixelsback to summary
    pack-priv int getItemHeightInPixels()
    getItemsback to summary
    public String[] getItems()

    Returns a (possibly empty) array of Strings 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:String[]

    the items in the receiver's list

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    getSelectionback to summary
    public String[] getSelection()

    Returns an array of Strings that are currently selected in the receiver. The order of the items is unspecified. 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:String[]

    an array representing the selection

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    getSelectionCountback to summary
    public int getSelectionCount()

    Returns the number of selected items contained in the receiver.

    Returns:int

    the number of selected items

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    getSelectionIndexback to summary
    public int getSelectionIndex()

    Returns the zero-relative index of the item which is currently selected in the receiver, or -1 if no item is selected.

    Returns:int

    the index of the selected item or -1

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    getSelectionIndicesback to summary
    public int[] getSelectionIndices()

    Returns the zero-relative indices of the items which are currently selected in the receiver. The order of the indices is unspecified. 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:int[]

    the array of indices of the selected items

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    getTextRendererback to summary
    pack-priv long getTextRenderer(long column)
    getTopIndexback to summary
    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:int

    the index of the top item

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    gtk_button_press_eventback to summary
    pack-priv long gtk_button_press_event(long widget, long event)

    Overrides org.eclipse.swt.widgets.Control.gtk_button_press_event.

    Annotations
    @Override
    gtk_button_release_eventback to summary
    pack-priv long gtk_button_release_event(long widget, long event)

    Overrides org.eclipse.swt.widgets.Control.gtk_button_release_event.

    Annotations
    @Override
    gtk_changedback to summary
    pack-priv long gtk_changed(long widget)

    Overrides org.eclipse.swt.widgets.Widget.gtk_changed.

    Annotations
    @Override
    gtk_gesture_press_eventback to summary
    pack-priv void gtk_gesture_press_event(long gesture, int n_press, double x, double y, long event)

    Overrides org.eclipse.swt.widgets.Control.gtk_gesture_press_event.

    Doc from org.eclipse.swt.widgets.Control.gtk_gesture_press_event.

    Handling multi-press event on GTK4

    Parameters
    gesture:long

    Doc from org.eclipse.swt.widgets.Widget.gtk_gesture_press_event.

    the corresponding controller responsible for capturing the event

    n_press:int

    Doc from org.eclipse.swt.widgets.Widget.gtk_gesture_press_event.

    how many touch/button presses happened with this one

    x:double

    Doc from org.eclipse.swt.widgets.Widget.gtk_gesture_press_event.

    the x coordinate, in widget allocation coordinates

    y:double

    Doc from org.eclipse.swt.widgets.Widget.gtk_gesture_press_event.

    the y coordinate, in widget allocation coordinates

    event:long

    Doc from org.eclipse.swt.widgets.Widget.gtk_gesture_press_event.

    the GdkEvent captured

    Annotations
    @Override
    gtk_key_press_eventback to summary
    pack-priv long gtk_key_press_event(long widget, long event)

    Overrides org.eclipse.swt.widgets.Control.gtk_key_press_event.

    Annotations
    @Override
    gtk_row_activatedback to summary
    pack-priv long gtk_row_activated(long tree, long path, long column)

    Overrides org.eclipse.swt.widgets.Widget.gtk_row_activated.

    Annotations
    @Override
    hookEventsback to summary
    pack-priv void hookEvents()

    Overrides org.eclipse.swt.widgets.Control.hookEvents.

    Annotations
    @Override
    indexOfback to summary
    public int indexOf(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:String

    the search item

    Returns:int

    the index of the item

    Exceptions
    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
    indexOfback to summary
    public int indexOf(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:String

    the search item

    start:int

    the zero-relative index at which to start the search

    Returns:int

    the index of the item

    Exceptions
    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
    isSelectedback to summary
    public boolean isSelected(int index)

    Returns true if the item is selected, and false otherwise. Indices out of range are ignored.

    Parameters
    index:int

    the index of the item

    Returns:boolean

    the selection state of the item at the index

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    keyPressDefaultSelectionHandlerback to summary
    pack-priv void keyPressDefaultSelectionHandler(long event, int key)

    Used to emulate DefaultSelection event. See Bug 312568.

    Parameters
    event:long

    the gtk key press event that was fired.

    paintWindowback to summary
    pack-priv long paintWindow()

    Overrides org.eclipse.swt.widgets.Control.paintWindow.

    Annotations
    @Override
    registerback to summary
    pack-priv void register()

    Overrides org.eclipse.swt.widgets.Scrollable.register.

    Annotations
    @Override
    releaseWidgetback to summary
    pack-priv void releaseWidget()

    Overrides org.eclipse.swt.widgets.Control.releaseWidget.

    Annotations
    @Override
    removeback to summary
    public void remove(int index)

    Removes the item from the receiver at the given zero-relative index.

    Parameters
    index:int

    the index for the item

    Exceptions
    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
    removeback to summary
    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:int

    the start of the range

    end:int

    the end of the range

    Exceptions
    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
    removeback to summary
    public void remove(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:String

    the item to remove

    Exceptions
    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
    removeback to summary
    public void remove(int[] indices)

    Removes the items from the receiver at the given zero-relative indices.

    Parameters
    indices:int[]

    the array of indices of the items

    Exceptions
    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
    removeAllback to summary
    public void removeAll()

    Removes all of the items from the receiver.

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    removeSelectionListenerback to summary
    public void removeSelectionListener(SelectionListener listener)

    Removes the listener from the collection of listeners who will be notified when the user changes the receiver's selection.

    Parameters
    listener:SelectionListener

    the listener which should no longer be notified

    Exceptions
    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
    selectback to summary
    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:int

    the index of the item to select

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    selectback to summary
    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:int

    the start of the range

    end:int

    the end of the range

    Exceptions
    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)
    selectback to summary
    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:int[]

    the array of indices for the items to select

    Exceptions
    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[])
    selectAllback to summary
    public void selectAll()

    Selects all of the items in the receiver.

    If the receiver is single-select, do nothing.

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    selectFocusIndexback to summary
    pack-priv void selectFocusIndex(int index)
    sendTreeDefaultSelectionback to summary
    pack-priv void sendTreeDefaultSelection()

    Used to emulate DefaultSelection event. See Bug 312568. Feature in GTK. 'row-activation' event comes before DoubleClick event. This is causing the editor not to get focus after double-click. The solution is to manually send the DefaultSelection event after a double-click, and to emulate it for Space/Return.

    setBoundsback to summary
    pack-priv int setBounds(int x, int y, int width, int height, boolean move, boolean resize)

    Overrides org.eclipse.swt.widgets.Control.setBounds.

    Annotations
    @Override
    setForegroundGdkRGBAback to summary
    pack-priv void setForegroundGdkRGBA(GdkRGBA rgba)

    Overrides org.eclipse.swt.widgets.Control.setForegroundGdkRGBA.

    Annotations
    @Override
    setItemback to summary
    public void setItem(int index, String string)

    Sets the text of the item in the receiver's list at the given zero-relative index to the string argument.

    Parameters
    index:int

    the index for the item

    string:String

    the new text for the item

    Exceptions
    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
    setItemsback to summary
    public void setItems(String... items)

    Sets the receiver's items to be the given array of items.

    Parameters
    items:String[]

    the array of items

    Exceptions
    IllegalArgumentException:
    • ERROR_NULL_ARGUMENT - if the items array is null
    • ERROR_INVALID_ARGUMENT - if an item in the items 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
    setSelectionback to summary
    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 selection is first cleared, then the new item is selected, and if necessary the receiver is scrolled to make the new selection visible. Indices that are out of range are ignored.

    Parameters
    index:int

    the index of the item to select

    Exceptions
    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)
    setSelectionback to summary
    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, and if necessary the receiver is scrolled to make the new selection visible.

    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:int

    the start index of the items to select

    end:int

    the end index of the items to select

    Exceptions
    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)
    setSelectionback to summary
    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, and if necessary the receiver is scrolled to make the new selection visible.

    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:int[]

    the indices of the items to select

    Exceptions
    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[])
    setSelectionback to summary
    public void setSelection(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, and if necessary the receiver is scrolled to make the new selection visible.

    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:String[]

    the array of items

    Exceptions
    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[])
    setTopIndexback to summary
    public void setTopIndex(int index)

    Sets 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 and removed.

    Parameters
    index:int

    the index of the top item

    Exceptions
    SWTException:
    • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    showSelectionback to summary
    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.

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