|
Eclipse Platform Release 3.3 |
|||||||||||
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.team.ui.SaveablePartDialog
CompareEditorInput
and CompareUI.openCompareDialog(org.eclipse.compare.CompareEditorInput)
A dialog that displays a ISaveableWorkbenchPart
and
ensures that changes made to the input are saved when the dialog is closed.
ISaveableWorkbenchPart
,
SaveablePartAdapter
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, 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 | |
---|---|
SaveablePartDialog(Shell shell,
ISaveableWorkbenchPart input)
Deprecated. Creates a dialog with the given title and input. |
Method Summary | |
---|---|
boolean |
close()
Deprecated. Closes this window, disposes its shell, and removes this window from its window manager (if it has one). |
protected void |
configureShell(Shell newShell)
Deprecated. Configures the given shell in preparation for opening this window in it. |
protected void |
createButtonsForButtonBar(Composite parent)
Deprecated. Adds buttons to this dialog's button bar. |
protected Control |
createDialogArea(Composite parent2)
Deprecated. Creates and returns the contents of the upper part of this dialog (above the button bar). |
protected IDialogSettings |
getDialogBoundsSettings()
Deprecated. Gets the dialog settings that should be used for remembering the bounds of of the dialog, according to the dialog bounds strategy. |
protected Point |
getInitialSize()
Deprecated. Returns the initial size to use for the shell. |
protected ISaveableWorkbenchPart |
getInput()
Deprecated. Return the input to the dialog. |
void |
setHelpContextId(String contextId)
Deprecated. Set the help content id of this dialog. |
Methods inherited from class org.eclipse.jface.dialogs.TrayDialog |
---|
closeTray, createButtonBar, 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 SaveablePartDialog(Shell shell, ISaveableWorkbenchPart input)
shell
- the parent shell or null
to create a top level shell.input
- the part to show in the dialog.Method Detail |
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 Dialog
parent
- the button bar compositeprotected Control createDialogArea(Composite parent2)
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
parent2
- 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 TrayDialog
protected ISaveableWorkbenchPart getInput()
protected IDialogSettings getDialogBoundsSettings()
Dialog
getDialogBoundsSettings
in class Dialog
null
if the dialog's bounds should
never be stored.Dialog.getDialogBoundsStrategy()
public void setHelpContextId(String contextId)
contextId
- the help context idprotected void configureShell(Shell newShell)
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 Window
newShell
- the shellprotected Point getInitialSize()
Dialog
getInitialSize
in class Dialog
Dialog.getDialogBoundsSettings()
,
Dialog.getDialogBoundsStrategy()
|
Eclipse Platform Release 3.3 |
|||||||||||
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, 2007. All rights reserved.