Package org.eclipse.debug.ui
Class StringVariableSelectionDialog
-
- All Implemented Interfaces:
IShellProvider
public class StringVariableSelectionDialog extends ElementListSelectionDialog
A dialog that prompts the user to choose and configure a string substitution variable.Clients may instantiate this class.
- Since:
- 3.1
- Restriction:
- This class is not intended to be subclassed by clients.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classStringVariableSelectionDialog.VariableFilterBase class for custom variable filters.-
Nested classes/interfaces inherited from class org.eclipse.jface.window.Window
Window.IExceptionHandler
-
-
Field Summary
-
Fields inherited from class org.eclipse.ui.dialogs.AbstractElementListSelectionDialog
fFilteredList
-
Fields inherited from class org.eclipse.jface.dialogs.Dialog
blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, 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, resizeHasOccurred
-
-
Constructor Summary
Constructors Constructor Description StringVariableSelectionDialog(Shell parent)Constructs a new string substitution variable selection dialog.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddVariableFilter(StringVariableSelectionDialog.VariableFilter filter)Add the given variable filter.protected voidconfigureArgument()Configures the argument for the selected variable.protected ControlcreateContents(Composite parent)TheDialogimplementation of thisWindowmethod creates and lays out the top level composite for the dialog, and determines the appropriate horizontal and vertical dialog units based on the font size.protected ControlcreateDialogArea(Composite parent)Creates and returns the contents of the upper part of this dialog (above the button bar).protected voideditVariables()Opens the preference dialog to the correct page an allows editing of variablesprotected IDialogSettingsgetDialogBoundsSettings()Gets the dialog settings that should be used for remembering the bounds of the dialog, according to the dialog bounds strategy.StringgetVariableExpression()Returns the variable expression the user generated from this dialog, ornullif none.protected voidhandleSelectionChanged()Update variable description and argument button enablement.protected voidokPressed()Notifies that the ok button of this dialog has been pressed.voidsetFilters(StringVariableSelectionDialog.VariableFilter[] filters)Sets the filters, replacing any previous filters.protected voidsetListElements(Object[] elements)Sets the elements of the list (widget).-
Methods inherited from class org.eclipse.ui.dialogs.ElementListSelectionDialog
computeResult, setElements
-
Methods inherited from class org.eclipse.ui.dialogs.AbstractElementListSelectionDialog
cancelPressed, create, createFilteredList, createFilterText, createMessageArea, getFilter, getFoldedElements, getSelectedElements, getSelectionIndex, getSelectionIndices, getValidator, handleDefaultSelected, handleElementsChanged, handleEmptyList, isCaseIgnored, open, setAllowDuplicates, setEmptyListMessage, setEmptySelectionMessage, setFilter, setIgnoreCase, setMatchEmptyString, setMultipleSelection, setSelection, setSize, setValidator, updateOkState, validateCurrentSelection
-
Methods inherited from class org.eclipse.ui.dialogs.SelectionStatusDialog
configureShell, createButtonBar, getFirstResult, setImage, setResult, setStatusLineAboveButtons, updateButtonsEnableState, updateStatus
-
Methods inherited from class org.eclipse.ui.dialogs.SelectionDialog
createButtonsForButtonBar, getDialogBoundsStrategy, getInitialElementSelections, getInitialSelections, getMessage, getOkButton, getResult, isResizable, setDialogBoundsSettings, setInitialElementSelections, setInitialSelections, setMessage, setResult, setSelectionResult, setTitle
-
Methods inherited from class org.eclipse.jface.dialogs.TrayDialog
closeTray, createHelpControl, getLayout, getTray, handleShellCloseEvent, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable
-
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, buttonPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, createButton, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getImage, getInitialLocation, getInitialSize, getOKButton, initializeBounds, initializeDialogUnits, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText
-
Methods inherited from class org.eclipse.jface.window.Window
canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager
-
-
-
-
Constructor Detail
-
StringVariableSelectionDialog
public StringVariableSelectionDialog(Shell parent)
Constructs a new string substitution variable selection dialog.- Parameters:
parent- parent shell
-
-
Method Detail
-
getVariableExpression
public String getVariableExpression()
Returns the variable expression the user generated from this dialog, ornullif none.- Returns:
- variable expression the user generated from this
dialog, or
nullif none
-
addVariableFilter
public void addVariableFilter(StringVariableSelectionDialog.VariableFilter filter)
Add the given variable filter. Has no effect if the given filter has already been added. Must be called before the dialog is opened.- Parameters:
filter- the filter to add- Since:
- 3.6
-
setFilters
public void setFilters(StringVariableSelectionDialog.VariableFilter[] filters)
Sets the filters, replacing any previous filters. Must be called before the dialog is opened.- Parameters:
filters- an array of variable filters, use empty Array ornullto reset all Filters.- Since:
- 3.6
-
setListElements
protected void setListElements(Object[] elements)
Description copied from class:AbstractElementListSelectionDialogSets the elements of the list (widget).- Overrides:
setListElementsin classAbstractElementListSelectionDialog- Parameters:
elements- the elements of the list.
-
createContents
protected Control createContents(Composite parent)
Description copied from class:DialogTheDialogimplementation of thisWindowmethod creates and lays out the top level composite for the dialog, and determines the appropriate horizontal and vertical dialog units based on the font size. It then calls thecreateDialogAreaandcreateButtonBarmethods to create the dialog area and button bar, respectively. OverridingcreateDialogAreaandcreateButtonBarare recommended rather than overriding this method.- Overrides:
createContentsin classDialog- Parameters:
parent- the parent composite for the controls in this window. The type of layout used is determined by getLayout()- Returns:
- the control that will be returned by subsequent calls to getContents()
-
createDialogArea
protected Control createDialogArea(Composite parent)
Description copied from class:DialogCreates and returns the contents of the upper part of this dialog (above the button bar).The
Dialogimplementation of this framework method creates and returns a newCompositewith standard margins and spacing.The returned control's layout data must be an instance of
GridData. This method must not modify the parent's layout.Subclasses must override this method but may call
superas in the following example:Composite composite = (Composite) super.createDialogArea(parent); //add controls to composite as necessary return composite;
- Overrides:
createDialogAreain classElementListSelectionDialog- Parameters:
parent- the parent composite to contain the dialog area- Returns:
- the dialog area control
-
editVariables
protected void editVariables()
Opens the preference dialog to the correct page an allows editing of variables
-
configureArgument
protected void configureArgument()
Configures the argument for the selected variable.
-
handleSelectionChanged
protected void handleSelectionChanged()
Update variable description and argument button enablement.- Overrides:
handleSelectionChangedin classAbstractElementListSelectionDialog- See Also:
AbstractElementListSelectionDialog.handleSelectionChanged()
-
okPressed
protected void okPressed()
Description copied from class:DialogNotifies that the ok button of this dialog has been pressed.The
Dialogimplementation of this framework method sets this dialog's return code toWindow.OKand closes the dialog. Subclasses may override.- Overrides:
okPressedin classSelectionStatusDialog
-
getDialogBoundsSettings
protected IDialogSettings getDialogBoundsSettings()
Description copied from class:SelectionDialogGets the dialog settings that should be used for remembering the bounds of the dialog, according to the dialog bounds strategy. Overridden to provide the dialog settings that were set usingSelectionDialog.setDialogBoundsSettings(IDialogSettings, int).- Overrides:
getDialogBoundsSettingsin classSelectionDialog- Returns:
- the dialog settings used to store the dialog's location and/or size,
or
nullif the dialog's bounds should not be stored. - See Also:
Dialog.getDialogBoundsStrategy(),SelectionDialog.setDialogBoundsSettings(IDialogSettings, int)
-
-