|
Eclipse Platform Release 3.1 |
|||||||||||
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.ui.dialogs.SelectionDialog
org.eclipse.ui.ide.dialogs.PathVariableSelectionDialog
A selection dialog which shows the path variables defined in the
workspace.
The getResult
method returns the name(s) of the
selected path variable(s).
This class may be instantiated; it is not intended to be subclassed.
Example:
PathVariableSelectionDialog dialog = new PathVariableSelectionDialog(getShell(), IResource.FOLDER); dialog.open(); String[] result = (String[]) dialog.getResult();
Nested Class Summary |
---|
Nested classes inherited from class org.eclipse.jface.window.Window |
---|
Window.IExceptionHandler |
Field Summary |
---|
Fields inherited from class org.eclipse.jface.dialogs.Dialog |
---|
blockedHandler, buttonBar, dialogArea, DLG_IMG_ERROR, 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 | |
---|---|
PathVariableSelectionDialog(Shell parentShell,
int variableType)
Creates a path variable selection dialog. |
Method Summary | |
---|---|
protected void |
buttonPressed(int buttonId)
Notifies that this dialog's button with the given id has been pressed. |
boolean |
close()
Closes this window, disposes its shell, and removes this window from its window manager (if it has one). |
protected void |
configureShell(Shell shell)
Configures the given shell in preparation for opening this window in it. |
protected void |
createButtonsForButtonBar(Composite parent)
Adds buttons to this dialog's button bar. |
protected Control |
createDialogArea(Composite parent)
Creates and returns the contents of the upper part of this dialog (above the button bar). |
protected void |
okPressed()
Notifies that the ok button of this dialog has been pressed. |
Methods inherited from class org.eclipse.ui.dialogs.SelectionDialog |
---|
createMessageArea, getInitialElementSelections, getInitialSelections, getMessage, getOkButton, getResult, setInitialElementSelections, setInitialSelections, setMessage, setResult, setSelectionResult, setTitle |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PathVariableSelectionDialog(Shell parentShell, int variableType)
parentShell
- the parent shellvariableType
- the type of variables that are displayed in
this dialog. IResource.FILE
and/or IResource.FOLDER
logically ORed together.Method Detail |
protected void buttonPressed(int buttonId)
Dialog
The Dialog
implementation of this framework method calls
okPressed
if the ok button is the pressed, and
cancelPressed
if the cancel button is the pressed. All
other button presses are ignored. Subclasses may override to handle other
buttons, but should call super.buttonPressed
if the
default handling of the ok and cancel buttons is desired.
buttonPressed
in class Dialog
buttonId
- the id of the button that was pressed (see
IDialogConstants.*_ID
constants)protected void configureShell(Shell shell)
Window
The default implementation of this framework method sets the shell's image and gives it a grid layout. Subclasses may extend or reimplement.
configureShell
in class SelectionDialog
protected void createButtonsForButtonBar(Composite parent)
Dialog
The Dialog
implementation of this framework method adds
standard ok and cancel buttons using the createButton
framework method. These standard buttons will be accessible from
getCancelButton
, and getOKButton
.
Subclasses may override.
createButtonsForButtonBar
in class SelectionDialog
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 Dialog
parent
- the parent composite to contain the dialog area
public boolean close()
Window
This framework method may be extended (super.close
must
be called).
close
in class Dialog
Window.close()
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 Dialog
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.