PopupList

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 <a href="http://www.eclipse.org/swt/">Sample code and further information</a>

class PopupList {

Shell shell;

List list;

int minimumWidth;

this(Shell parent);

this(Shell parent, int style);

Font getFont();

String[] getItems();

int getMinimumWidth();

String open(Rectangle rect);

void select(String string);

void setFont(Font font);

void setItems(String[] strings);

void setMinimumWidth(int width);

}

Constructors

this this(Shell parent): Creates a PopupList above the specified shell. * @param parent a Shell control which will be the parent of the new instance (cannot be null)
this this(Shell parent, int style): Creates a PopupList above the specified shell. * @param parent a widget which will be the parent of the new instance (cannot be null) @param style the style of widget to construct * @since 3.0

Members

Functions

getFont Font getFont(): Gets the widget font. @return the widget font * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> </ul>
getItems String[] getItems(): Gets the items. This operation will fail if the items cannot be queried from the OS. * @return the items in the widget * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> </ul>
getMinimumWidth int getMinimumWidth(): Gets the minimum width of the list. * @return the minimum width of the list
open String open(Rectangle rect): Launches the Popup List, waits for an item to be selected and then closes the PopupList. * @param 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 * @return the text of the selected item or null if no item is selected
select void select(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. * @param string the text of the item * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> </ul>
setFont void setFont(Font font): Sets the widget font. When new font is null, the font reverts to the default system font for the widget. * @param font the new font (or null) * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> </ul>
setItems void setItems(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. * @param strings the array of items * This operation will fail when an item is null or could not be added in the OS. * @exception IllegalArgumentException <ul> <li>ERROR_INVALID_ARGUMENT - if an item in the items array is null</li> </ul> @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> </ul>
setMinimumWidth void setMinimumWidth(int width): Sets the minimum width of the list. * @param width the minimum width of the list

PopupList

Constructors

Members

Functions

Meta

Source