Class SaveablePartDialog
- java.lang.Object
-
- org.eclipse.jface.window.Window
-
- org.eclipse.jface.dialogs.Dialog
-
- org.eclipse.jface.dialogs.TrayDialog
-
- org.eclipse.team.ui.SaveablePartDialog
-
- All Implemented Interfaces:
IShellProvider
- Direct Known Subclasses:
ParticipantPageDialog
@Deprecated public class SaveablePartDialog extends TrayDialog
Deprecated.Clients should use a subclass ofCompareEditorInputandCompareUI.openCompareDialog(org.eclipse.compare.CompareEditorInput)A dialog that displays aISaveableWorkbenchPartand ensures that changes made to the input are saved when the dialog is closed.- Since:
- 3.0
- See Also:
ISaveableWorkbenchPart,SaveablePartAdapter
-
-
Nested Class Summary
-
Nested classes/interfaces 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, resizeHasOccurred
-
-
Constructor Summary
Constructors Constructor Description SaveablePartDialog(Shell shell, ISaveableWorkbenchPart input)Deprecated.Creates a dialog with the given title and input.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleanclose()Deprecated.Closes this window, disposes its shell, and removes this window from its window manager (if it has one).protected voidconfigureShell(Shell newShell)Deprecated.Configures the given shell in preparation for opening this window in it.protected voidcreateButtonsForButtonBar(Composite parent)Deprecated.Adds buttons to this dialog's button bar.protected ControlcreateDialogArea(Composite parent2)Deprecated.Creates and returns the contents of the upper part of this dialog (above the button bar).protected IDialogSettingsgetDialogBoundsSettings()Deprecated.Gets the dialog settings that should be used for remembering the bounds of of the dialog, according to the dialog bounds strategy.protected PointgetInitialSize()Deprecated.Returns the initial size to use for the shell.protected ISaveableWorkbenchPartgetInput()Deprecated.Return the input to the dialog.voidsetHelpContextId(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, handleShellCloseEvent, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable
-
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, buttonPressed, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, createContents, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsStrategy, getImage, getInitialLocation, getOKButton, initializeBounds, initializeDialogUnits, isResizable, okPressed, 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, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager
-
-
-
-
Constructor Detail
-
SaveablePartDialog
public SaveablePartDialog(Shell shell, ISaveableWorkbenchPart input)
Deprecated.Creates a dialog with the given title and input. The input is not created until the dialog is opened.- Parameters:
shell- the parent shell ornullto create a top level shell.input- the part to show in the dialog.
-
-
Method Detail
-
createButtonsForButtonBar
protected void createButtonsForButtonBar(Composite parent)
Deprecated.Description copied from class:DialogAdds buttons to this dialog's button bar.The
Dialogimplementation of this framework method adds standard ok and cancel buttons using thecreateButtonframework method. These standard buttons will be accessible fromgetCancelButton, andgetOKButton. Subclasses may override.Note: The common button order is: {other buttons}, OK, Cancel. On some platforms,
Dialog.initializeBounds()will move the default button to the right.- Overrides:
createButtonsForButtonBarin classDialog- Parameters:
parent- the button bar composite
-
createDialogArea
protected Control createDialogArea(Composite parent2)
Deprecated.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 classDialog- Parameters:
parent2- the parent composite to contain the dialog area- Returns:
- the dialog area control
-
close
public boolean close()
Deprecated.Description copied from class:WindowCloses this window, disposes its shell, and removes this window from its window manager (if it has one).This framework method may be extended (
super.closemust be called).Note that in order to prevent recursive calls to this method it does not call
Shell#close(). As a resultShellListeners will not receive ashellClosedevent.- Overrides:
closein classDialog- Returns:
trueif the window is (or was already) closed, andfalseif it is still open- See Also:
Window.close()
-
getInput
protected ISaveableWorkbenchPart getInput()
Deprecated.Return the input to the dialog.- Returns:
- the input to the dialog
- Since:
- 3.2
-
getDialogBoundsSettings
protected IDialogSettings getDialogBoundsSettings()
Deprecated.Description copied from class:DialogGets the dialog settings that should be used for remembering the bounds of of the dialog, according to the dialog bounds strategy.- Overrides:
getDialogBoundsSettingsin classDialog- Returns:
- settings the dialog settings used to store the dialog's location
and/or size, or
nullif the dialog's bounds should never be stored. - See Also:
Dialog.getDialogBoundsStrategy()
-
setHelpContextId
public void setHelpContextId(String contextId)
Deprecated.Set the help content id of this dialog.- Parameters:
contextId- the help context id
-
configureShell
protected void configureShell(Shell newShell)
Deprecated.Description copied from class:WindowConfigures the given shell in preparation for opening this window in it.The default implementation of this framework method sets the shell's image and gives it a grid layout. Subclasses may extend or reimplement.
- Overrides:
configureShellin classWindow- Parameters:
newShell- the shell
-
getInitialSize
protected Point getInitialSize()
Deprecated.Description copied from class:DialogReturns the initial size to use for the shell. Overridden to check whether a size has been stored in dialog settings. If a size has been stored, it is returned.- Overrides:
getInitialSizein classDialog- Returns:
- the initial size of the shell
- See Also:
Dialog.getDialogBoundsSettings(),Dialog.getDialogBoundsStrategy()
-
-