|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
org.eclipse.jface.dialogs.TrayDialog
org.eclipse.ui.dialogs.SelectionDialog
org.eclipse.ui.dialogs.SelectionStatusDialog
org.eclipse.ui.dialogs.AbstractElementListSelectionDialog
org.eclipse.ui.dialogs.ElementListSelectionDialog
org.eclipse.debug.ui.StringVariableSelectionDialog
A dialog that prompts the user to choose and configure a string substitution variable.
Clients may instantiate this class.
Nested Class Summary |
Nested classes 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 |
Constructor Summary | |
StringVariableSelectionDialog(Shell parent)
Constructs a new string substitution variable selection dialog. |
Method Summary | |
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. |
Methods inherited from class org.eclipse.ui.dialogs.ElementListSelectionDialog |
computeResult, setElements |
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 |
close, closeTray, createHelpControl, getLayout, getTray, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public StringVariableSelectionDialog(Shell parent)
parent
- parent shellMethod Detail |
public String getVariableExpression()
null
if none.
null
if noneprotected 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
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
protected 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)
|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.