org.eclipse.eavp.viz.service.widgets

Class ComboDialog

java.lang.Object

org.eclipse.jface.window.Window

org.eclipse.jface.dialogs.Dialog

org.eclipse.eavp.viz.service.widgets.ComboDialog

All Implemented Interfaces:

org.eclipse.jface.window.IShellProvider

public class ComboDialog
extends org.eclipse.jface.dialogs.Dialog

This class provides a custom dialog backed by a JFace ComboViewer. The underlying combo or drop-down-list widget can be either read-only or manually editable (meaning you can type a new value).

In normal use, the dialog's various properties should be set before opening. The selected value can be retrieved via getValue().

If the widget is manually editable, sub-classes should override validateSelection(String) and call the super class method to determine if the selected value is one of the allowed values before attempting additional validation of the input.

Author:

Jordan Deyton

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jface.window.Window

org.eclipse.jface.window.Window.IExceptionHandler

Field Summary

Fields inherited from class org.eclipse.jface.dialogs.Dialog

blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS

Fields inherited from class org.eclipse.jface.window.Window

CANCEL, OK

Constructor Summary

Constructors

Constructor and Description
ComboDialog(org.eclipse.swt.widgets.Shell parentShell, boolean readOnly) Creates a new dialog centered around a combo widget.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getValue() Gets the selected value from the dialog's combo widget.
boolean	setAllowedValues(java.util.List<java.lang.String> allowedValues) Sets the list of allowed values that will be put into the dialog's combo widget.
boolean	setErrorText(java.lang.String text) Sets the text that is displayed in the combo widget's error decorator.
boolean	setInfoText(java.lang.String text) Sets the text that is displayed in the dialog above the combo widget.
boolean	setInitialValue(java.lang.String value) Sets the initial value that will be selected in the combo widget when the dialog is opened.
boolean	setTitle(java.lang.String text) Sets the title text for the dialog.

Methods inherited from class org.eclipse.jface.dialogs.Dialog

applyDialogFont, close, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, create, getBlockedHandler, getImage, setBlockedHandler, shortenText

Methods inherited from class org.eclipse.jface.window.Window

getDefaultImage, getDefaultImages, getDefaultOrientation, getReturnCode, getShell, getWindowManager, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setWindowManager

Methods inherited from class java.lang.Object

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

Constructor Detail

ComboDialog

public ComboDialog(org.eclipse.swt.widgets.Shell parentShell,
                   boolean readOnly)

Creates a new dialog centered around a combo widget. The dialog's returned value corresponds to the validated selection from the combo widget.

Parameters:

parentShell - The parent shell for the new dialog.

readOnly - If true, then the dialog will use a read-only combo. Otherwise, it uses an editable combo widget (it has a drop-down list, but can be manually edited).

Method Detail

getValue

public java.lang.String getValue()

Gets the selected value from the dialog's combo widget.

Returns:

The validated value selected from the combo widget, or or null if a selection was not made or the dialog was cancelled.

setAllowedValues

public boolean setAllowedValues(java.util.List<java.lang.String> allowedValues)

Sets the list of allowed values that will be put into the dialog's combo widget.

Parameters:

allowedValues - The list of allowed values. If this list is null, contains null, or is not different, this list will be ignored.

Returns:

True if the list of allowed values was updated, false otherwise.

setErrorText

public boolean setErrorText(java.lang.String text)

Sets the text that is displayed in the combo widget's error decorator. This text will be displayed when the combo's current selection is invalid.

Parameters:

text - The new text to display in the combo widget's error decorator. Must not be null.

Returns:

True if the error text was updated, false otherwise.

setInfoText

public boolean setInfoText(java.lang.String text)

Sets the text that is displayed in the dialog above the combo widget.

Parameters:

text - The new text to display in the dialog above the combo widget. Must not be null.

Returns:

True if the info text was updated, false otherwise.

setInitialValue

public boolean setInitialValue(java.lang.String value)

Sets the initial value that will be selected in the combo widget when the dialog is opened.

Parameters:

value - The initial value. This will be validated before being placed in the combo widget.

Returns:

True if the initial value changed, false otherwise.

setTitle

public boolean setTitle(java.lang.String text)

Sets the title text for the dialog.

Parameters:

text - The new text to display in the dialog's title bar.

Returns:

True if the title text was updated, false otherwise.