org.eclipse.swt.custom

Class PopupList

java.lang.Object

org.eclipse.swt.custom.PopupList

public class PopupList
extends java.lang.Object

A PopupList is a list of selectable items that appears in its own shell positioned above its parent shell. It is used for selecting items when editing a Table cell (similar to the list that appears when you open a Combo box). The list will be positioned so that it does not run off the screen and the largest number of items are visible. It may appear above the current cursor location or below it depending how close you are to the edge of the screen.

See Also:

Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) List	list
(package private) int	minimumWidth
(package private) Shell	shell

Constructor Summary

Constructors

Constructor and Description
PopupList(Shell parent) Creates a PopupList above the specified shell.
PopupList(Shell parent, int style) Creates a PopupList above the specified shell.

Method Summary

Methods

Modifier and Type	Method and Description
private static int	checkStyle(int style)
Font	getFont() Gets the widget font.
java.lang.String[]	getItems() Gets the items.
int	getMinimumWidth() Gets the minimum width of the list.
java.lang.String	open(Rectangle rect) Launches the Popup List, waits for an item to be selected and then closes the PopupList.
void	select(java.lang.String string) Selects an item with text that starts with specified String.
void	setFont(Font font) Sets the widget font.
void	setItems(java.lang.String[] strings) Sets all items.
void	setMinimumWidth(int width) Sets the minimum width of the list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

shell

Shell shell

list

List list

minimumWidth

int minimumWidth

Constructor Detail

PopupList

public PopupList(Shell parent)

Creates a PopupList above the specified shell.

Parameters:

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

PopupList

public PopupList(Shell parent,
         int style)

Creates a PopupList above the specified shell.

Parameters:

parent - a widget which will be the parent of the new instance (cannot be null)

style - the style of widget to construct

Since:

3.0

Method Detail

checkStyle

private static int checkStyle(int style)

getFont

public Font getFont()

Gets the widget font.

Returns:

the widget font

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

getItems

public java.lang.String[] getItems()

Gets the items.

This operation will fail if the items cannot be queried from the OS.

Returns:

the items in the widget

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

getMinimumWidth

public int getMinimumWidth()

Gets the minimum width of the list.

Returns:

the minimum width of the list

open

public java.lang.String open(Rectangle rect)

Launches the Popup List, waits for an item to be selected and then closes the PopupList.

Parameters:

rect - the initial size and location of the PopupList; the dialog will be positioned so that it does not run off the screen and the largest number of items are visible

Returns:

the text of the selected item or null if no item is selected

select

public void select(java.lang.String string)

Selects an item with text that starts with specified String.

If the item is not currently selected, it is selected. If the item at an index is selected, it remains selected. If the string is not matched, it is ignored.

Parameters:

string - the text of the 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

setFont

public void setFont(Font font)

Sets the widget font.

When new font is null, the font reverts to the default system font for the widget.

Parameters:

font - the new font (or null)

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

setItems

public void setItems(java.lang.String[] strings)

Sets all items.

The previous selection is cleared. The previous items are deleted. The new items are added. The top index is set to 0.

Parameters:

strings - the array of items This operation will fail when an item is null or could not be added in the OS.

Throws:

java.lang.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

setMinimumWidth

public void setMinimumWidth(int width)

Sets the minimum width of the list.

Parameters:

width - the minimum width of the list