|
Eclipse Platform Release 3.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.jface.window.Window org.eclipse.jface.dialogs.Dialog org.eclipse.jface.dialogs.TitleAreaDialog org.eclipse.ui.dialogs.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.
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.TitleAreaDialog |
DLG_IMG_TITLE_BANNER, DLG_IMG_TITLE_ERROR, INFO_MESSAGE, WARNING_MESSAGE |
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 | |
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). |
IPath | getResult()
Returns the full path entered by the user. |
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(String originalName)
Set the original file name to use. |
Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog |
getInitialSize, getTitleArea, getTitleImageLabel, setErrorMessage, setMessage, setMessage, setTitle, setTitleAreaColor, setTitleImage |
Methods inherited from class org.eclipse.jface.window.Window |
canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getInitialLocation, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setExceptionHandler, setReturnCode, setShellStyle, setWindowManager |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SaveAsDialog(Shell parentShell)
Method Detail |
protected void configureShell(Shell shell)
The default implementation of this framework method sets the shell's image and gives it a grid layout. Subclasses may extend or reimplement.
protected Control createContents(Composite parent)
public boolean close()
protected void createButtonsForButtonBar(Composite parent)
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.
protected Control createDialogArea(Composite parent)
The Dialog implementation of this framework method creates and returns a new Composite with no margins and spacing. Subclasses should override.
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.
protected void okPressed()
The Dialog implementation of this framework method sets this dialog's return code to Window.OK and closes the dialog. Subclasses may override.
protected void setDialogComplete(boolean value)
public void setOriginalFile(IFile originalFile)
public void setOriginalName(String originalName)
|
Eclipse Platform Release 3.0 | ||||||||||
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, 2004. All rights reserved.