public class StringVariableSelectionDialog extends ElementListSelectionDialog
Clients may instantiate this class.
Modifier and Type | Class and Description |
---|---|
static class |
StringVariableSelectionDialog.VariableFilter
Base class for custom variable filters.
|
Window.IExceptionHandler
fFilteredList
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
CANCEL, OK, resizeHasOccurred
Constructor and Description |
---|
StringVariableSelectionDialog(Shell parent)
Constructs a new string substitution variable selection dialog.
|
Modifier and Type | Method and Description |
---|---|
void |
addVariableFilter(StringVariableSelectionDialog.VariableFilter filter)
Add the given variable filter.
|
protected void |
configureArgument()
Configures the argument for the selected variable.
|
protected Control |
createContents(Composite parent)
The
Dialog implementation of this Window
method 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 Control |
createDialogArea(Composite parent)
Creates and returns the contents of the upper part of this dialog (above
the button bar).
|
protected void |
editVariables()
Opens the preference dialog to the correct page an allows editing of variables
|
protected IDialogSettings |
getDialogBoundsSettings()
Gets the dialog settings that should be used for remembering the bounds
of the dialog, according to the dialog bounds strategy.
|
String |
getVariableExpression()
Returns the variable expression the user generated from this
dialog, or
null if none. |
protected void |
handleSelectionChanged()
Update variable description and argument button enablement.
|
protected void |
okPressed()
Notifies that the ok button of this dialog has been pressed.
|
void |
setFilters(StringVariableSelectionDialog.VariableFilter[] filters)
Sets the filters, replacing any previous filters.
|
protected void |
setListElements(Object[] elements)
Sets the elements of the list (widget).
|
computeResult, setElements
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
configureShell, createButtonBar, getFirstResult, setImage, setResult, setStatusLineAboveButtons, updateButtonsEnableState, updateStatus
createButtonsForButtonBar, getDialogBoundsStrategy, getInitialElementSelections, getInitialSelections, getMessage, getOkButton, getResult, isResizable, setDialogBoundsSettings, setInitialElementSelections, setInitialSelections, setMessage, setResult, setSelectionResult, setTitle
closeTray, createHelpControl, getLayout, getTray, handleShellCloseEvent, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable
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
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
public StringVariableSelectionDialog(Shell parent)
parent
- parent shellpublic String getVariableExpression()
null
if none.null
if nonepublic void addVariableFilter(StringVariableSelectionDialog.VariableFilter filter)
filter
- the filter to addpublic void setFilters(StringVariableSelectionDialog.VariableFilter[] filters)
filters
- an array of variable filters, use empty Array or null
to reset all Filters.protected void setListElements(Object[] elements)
AbstractElementListSelectionDialog
setListElements
in class AbstractElementListSelectionDialog
elements
- the elements of the list.protected Control createContents(Composite parent)
Dialog
Dialog
implementation of this Window
method 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 the createDialogArea
and
createButtonBar
methods to create the dialog area and
button bar, respectively. Overriding createDialogArea
and
createButtonBar
are recommended rather than overriding
this method.createContents
in class Dialog
parent
- the parent composite for the controls in this window. The type
of layout used is determined by getLayout()protected Control createDialogArea(Composite parent)
Dialog
The Dialog
implementation of this framework method creates
and returns a new Composite
with 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 super
as
in the following example:
Composite composite = (Composite) super.createDialogArea(parent); //add controls to composite as necessary return composite;
createDialogArea
in class ElementListSelectionDialog
parent
- the parent composite to contain the dialog areaprotected void editVariables()
protected void configureArgument()
protected void handleSelectionChanged()
handleSelectionChanged
in class AbstractElementListSelectionDialog
AbstractElementListSelectionDialog.handleSelectionChanged()
protected void okPressed()
Dialog
The Dialog
implementation of this framework method sets
this dialog's return code to Window.OK
and closes the
dialog. Subclasses may override.
okPressed
in class SelectionStatusDialog
protected IDialogSettings getDialogBoundsSettings()
SelectionDialog
SelectionDialog.setDialogBoundsSettings(IDialogSettings, int)
.getDialogBoundsSettings
in class SelectionDialog
null
if the dialog's bounds should not be
stored.Dialog.getDialogBoundsStrategy()
,
SelectionDialog.setDialogBoundsSettings(IDialogSettings, int)
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.