|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.dialogs.DialogPage
org.eclipse.jface.wizard.WizardPage
org.eclipse.ui.dialogs.WizardNewFileCreationPage
org.eclipse.gmf.runtime.diagram.ui.resources.editor.ide.wizards.EditorWizardPage
public abstract class EditorWizardPage
Field Summary | |
---|---|
protected IFile |
diagramFile
the diagram file for the newlt created diagram |
protected boolean |
openNewlyCreatedDiagramEditor
A flag indicating whether or not to open the editor of the newly created diagram The default is true |
protected IWorkbench |
workbench
workbench |
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider |
---|
ERROR, INFORMATION, NONE, WARNING |
Constructor Summary | |
---|---|
EditorWizardPage(java.lang.String pageName,
IWorkbench aWorkbench,
IStructuredSelection selection)
EditorWizardPage constructor |
Method Summary | |
---|---|
IFile |
createAndOpenDiagram(IPath containerPath,
java.lang.String fileName,
java.io.InputStream initialContents,
java.lang.String kind,
IWorkbenchWindow dWindow,
IProgressMonitor progressMonitor,
boolean saveDiagram)
|
void |
createControl(Composite parent)
|
boolean |
doFinish(IProgressMonitor monitor)
|
boolean |
finish()
Performs the operations necessary to create and open the diagram |
protected java.lang.String |
getDefaultFileName()
|
IFile |
getDiagramFile()
Accessor for the diagram's file |
abstract DiagramFileCreator |
getDiagramFileCreator()
|
protected java.lang.String |
getDiagramKind()
|
java.lang.String |
getFileName()
Returns the current file name as entered by the user, or its anticipated initial value. |
protected java.io.InputStream |
getInitialContents()
|
IStructuredSelection |
getSelection()
Accessor for selected elements |
protected void |
initialPopulateContainerNameField()
|
boolean |
isOpenNewlyCreatedDiagramEditor()
Answers whether or not this Wizard will open the editor of the newly created diagram |
void |
setOpenNewlyCreatedDiagramEditor(boolean openNewlyCreatedDiagramEditor)
Sets a flag indicating whether or not the newly created diagram editor should be opened |
protected boolean |
validatePage()
|
Methods inherited from class org.eclipse.ui.dialogs.WizardNewFileCreationPage |
---|
createAdvancedControls, createFile, createFileHandle, createLinkTarget, createNewFile, createRule, getContainerFullPath, getFileExtension, getNewFileLabel, handleAdvancedButtonSelect, handleEvent, setAllowExistingResources, setContainerFullPath, setFileExtension, setFileName, setVisible, validateLinkedResource |
Methods inherited from class org.eclipse.jface.wizard.WizardPage |
---|
canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString |
Methods inherited from class org.eclipse.jface.dialogs.DialogPage |
---|
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage |
---|
dispose, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp |
Field Detail |
---|
protected final IWorkbench workbench
protected IFile diagramFile
protected boolean openNewlyCreatedDiagramEditor
Constructor Detail |
---|
public EditorWizardPage(java.lang.String pageName, IWorkbench aWorkbench, IStructuredSelection selection)
pageName
- the page nameaWorkbench
- workbench the workbench this page will be displayed inselection
- selection the current selectionMethod Detail |
---|
public boolean doFinish(IProgressMonitor monitor)
monitor
- the IProgressMonitor
to use to indicate progress and check for cancellation
public IFile createAndOpenDiagram(IPath containerPath, java.lang.String fileName, java.io.InputStream initialContents, java.lang.String kind, IWorkbenchWindow dWindow, IProgressMonitor progressMonitor, boolean saveDiagram)
containerPath
- fileName
- initialContents
- kind
- dWindow
- progressMonitor
- saveDiagram
-
public boolean isOpenNewlyCreatedDiagramEditor()
public void setOpenNewlyCreatedDiagramEditor(boolean openNewlyCreatedDiagramEditor)
openNewlyCreatedDiagramEditor
- The openNewlyCreatedDiagramEditor to set.public boolean finish()
public final IFile getDiagramFile()
protected java.lang.String getDefaultFileName()
public abstract DiagramFileCreator getDiagramFileCreator()
protected java.lang.String getDiagramKind()
protected java.io.InputStream getInitialContents()
getInitialContents
in class WizardNewFileCreationPage
public java.lang.String getFileName()
getFileName
in class WizardNewFileCreationPage
null
if no file name is knownprotected boolean validatePage()
validatePage
in class WizardNewFileCreationPage
public final IStructuredSelection getSelection()
public void createControl(Composite parent)
createControl
in interface IDialogPage
createControl
in class WizardNewFileCreationPage
protected void initialPopulateContainerNameField()
initialPopulateContainerNameField
in class WizardNewFileCreationPage
|
Runtime | |||||||||
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., Borland Software Corp., and others 2005,2006. All rights reserved.