|
org.eclipse.gmf.runtime.diagram.ui.resources.editor.ide.wizards
Class EditorWizardPage
java.lang.Object
org.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
-
All Implemented Interfaces:
-
IDialogPage,
IMessageProvider,
IWizardPage,
Listener
-
public abstract class EditorWizardPage
- extends
WizardNewFileCreationPage
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
|
workbench
protected final
IWorkbench workbench
- workbench
diagramFile
protected
IFile diagramFile
- the diagram file for the newlt created diagram
openNewlyCreatedDiagramEditor
protected boolean openNewlyCreatedDiagramEditor
- A flag indicating whether or not to open the editor of the newly created diagram
The default is true
EditorWizardPage
public EditorWizardPage(java.lang.String pageName,
IWorkbench aWorkbench,
IStructuredSelection selection)
- EditorWizardPage constructor
-
Parameters:
-
pageName - the page name -
aWorkbench - workbench the workbench this page will be displayed in -
selection - selection the current selection
doFinish
public boolean doFinish(
IProgressMonitor monitor)
-
-
Parameters:
-
monitor - the IProgressMonitor to use to indicate progress and check for cancellation
-
Returns:
- boolean indicating whether the creation and opening the Diagram was successful
createAndOpenDiagram
public
IFile createAndOpenDiagram(
IPath containerPath,
java.lang.String fileName,
java.io.InputStream initialContents,
java.lang.String kind,
IWorkbenchWindow dWindow,
IProgressMonitor progressMonitor,
boolean saveDiagram)
-
-
Parameters:
-
containerPath - -
fileName - -
initialContents - -
kind - -
dWindow - -
progressMonitor - -
saveDiagram -
-
Returns:
-
isOpenNewlyCreatedDiagramEditor
public boolean isOpenNewlyCreatedDiagramEditor()
- Answers whether or not this Wizard will open the editor of the newly created diagram
-
-
Returns:
- Returns the openNewlyCreatedDiagramEditor.
setOpenNewlyCreatedDiagramEditor
public void setOpenNewlyCreatedDiagramEditor(boolean openNewlyCreatedDiagramEditor)
- Sets a flag indicating whether or not the newly created diagram editor should be opened
-
-
Parameters:
-
openNewlyCreatedDiagramEditor - The openNewlyCreatedDiagramEditor to set.
finish
public boolean finish()
- Performs the operations necessary to create and open the diagram
-
-
Returns:
- boolean indicating whether the creation and opening the Diagram was successful
getDiagramFile
public final
IFile getDiagramFile()
- Accessor for the diagram's file
-
-
Returns:
- IFile the file owning the diagram
getDefaultFileName
protected java.lang.String getDefaultFileName()
-
-
Returns:
- the default file name
getDiagramFileCreator
public abstract
DiagramFileCreator getDiagramFileCreator()
-
-
Returns:
- the diagram file creator
getDiagramKind
protected java.lang.String getDiagramKind()
-
-
Returns:
- the diagram kind
getInitialContents
protected java.io.InputStream getInitialContents()
-
-
Overrides:
-
getInitialContents
in class
WizardNewFileCreationPage
-
getFileName
public java.lang.String getFileName()
- Returns the current file name as entered by the user, or its anticipated
initial value.
-
-
Overrides:
-
getFileName
in class
WizardNewFileCreationPage
-
-
Returns:
- the file name, its anticipated initial value, or
null
if no file name is known
validatePage
protected boolean validatePage()
-
-
Overrides:
-
validatePage
in class
WizardNewFileCreationPage
-
getSelection
public final
IStructuredSelection getSelection()
- Accessor for selected elements
-
-
Returns:
- IStructuredSelection the selection holding the elements to be displayed on the diagram
createControl
public void createControl(
Composite parent)
-
-
Specified by:
-
createControl
in interface
IDialogPage
-
Overrides:
-
createControl
in class
WizardNewFileCreationPage
-
initialPopulateContainerNameField
protected void initialPopulateContainerNameField()
-
-
Overrides:
-
initialPopulateContainerNameField
in class
WizardNewFileCreationPage
-
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.
|
|