|
Eclipse Platform Release 3.6 |
|||||||||
| 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.jface.dialogs.TitleAreaDialog
org.eclipse.ui.dialogs.SaveAsDialog
public class SaveAsDialog
A standard "Save As" dialog which solicits a path from the user. The
getResult method returns the path. Note that the folder
at the specified path might not exist and might need to be created.
This class may be instantiated; it is not intended to be subclassed.
ContainerGenerator| 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.TitleAreaDialog |
|---|
DLG_IMG_TITLE_BANNER, DLG_IMG_TITLE_ERROR, INFO_MESSAGE, WARNING_MESSAGE |
| 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 | |
|---|---|
SaveAsDialog(Shell parentShell)
Creates a new Save As dialog for no specific file. |
|
| Method Summary | |
|---|---|
boolean |
close()
The SaveAsDialog implementation of this Window
method disposes of the banner image when the dialog is closed. |
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 |
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 IDialogSettings |
getDialogBoundsSettings()
Gets the dialog settings that should be used for remembering the bounds of of the dialog, according to the dialog bounds strategy. |
IPath |
getResult()
Returns the full path entered by the user. |
protected boolean |
isResizable()
Returns a boolean indicating whether the dialog should be considered resizable when the shell style is initially set. |
protected void |
okPressed()
Notifies that the ok button of this dialog has been pressed. |
protected void |
setDialogComplete(boolean value)
Sets the completion state of this dialog and adjusts the enable state of the Ok button accordingly. |
void |
setOriginalFile(IFile originalFile)
Sets the original file to use. |
void |
setOriginalName(java.lang.String originalName)
Set the original file name to use. |
| Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog |
|---|
getErrorMessage, getInitialSize, getMessage, getTitleArea, getTitleImageLabel, setErrorMessage, setMessage, setMessage, setTitle, setTitleAreaColor, setTitleImage |
| 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 SaveAsDialog(Shell parentShell)
parentShell - the parent shell| Method Detail |
|---|
protected void configureShell(Shell shell)
WindowThe 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 Windowshell - the shellprotected Control createContents(Composite parent)
DialogDialog 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 TitleAreaDialogparent - the parent composite for the controls in this window. The type
of layout used is determined by getLayout()
public boolean close()
SaveAsDialog implementation of this Window
method disposes of the banner image when the dialog is closed.
close in class TrayDialogtrue if the window is (or was already) closed, and
false if it is still openWindow.close()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 Dialogparent - the button bar compositeprotected Control createDialogArea(Composite parent)
TitleAreaDialog
The Dialog implementation of this framework method creates
and returns a new Composite with no margins and spacing.
Subclasses should override.
createDialogArea in class TitleAreaDialogparent - The parent composite to contain the dialog area
public IPath getResult()
Note that the file and container might not exist and would need to be created.
See the IFile.create method and the
ContainerGenerator class.
null if Cancel was pressedprotected 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 Dialogprotected void setDialogComplete(boolean value)
value - true if this dialog is compelete, and
false otherwisepublic void setOriginalFile(IFile originalFile)
originalFile - the original filepublic void setOriginalName(java.lang.String originalName)
setOriginalFile
when the original resource is not an IFile.
Must be called before create.
originalName - default file nameprotected IDialogSettings getDialogBoundsSettings()
Dialog
getDialogBoundsSettings in class Dialognull if the dialog's bounds should
never be stored.Dialog.getDialogBoundsStrategy()protected boolean isResizable()
Dialogfalse, but also sets a style bit for a
SWT.RESIZE border, the style bit will be honored.
isResizable in class Dialog
|
Eclipse Platform Release 3.6 |
|||||||||
| 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, 2010. All rights reserved.