org.eclipse.ocl.examples.xtext.base.ui.wizards
Class AbstractFileNewWizard

java.lang.Object
  org.eclipse.jface.wizard.Wizard
      org.eclipse.ocl.examples.xtext.base.ui.wizards.AbstractFileNewWizard

All Implemented Interfaces:

org.eclipse.jface.wizard.IWizard, org.eclipse.ui.INewWizard, org.eclipse.ui.IWorkbenchWizard

Direct Known Subclasses:

AbstractOCLinEcoreFileNewWizard, CompleteOCLFileNewWizard, OCLstdlibFileNewWizard

public abstract class AbstractFileNewWizard
extends org.eclipse.jface.wizard.Wizard
implements org.eclipse.ui.INewWizard

Wizard allowing the user to create a new OCL rule file.

Since:

1.2

Field Summary

Fields inherited from class org.eclipse.jface.wizard.Wizard

DEFAULT_IMAGE

Constructor Summary

protected

AbstractFileNewWizard() Constructor

Method Summary

protected abstract AbstractFileDialog	createDialog(AbstractFileNewWizardPage wizardPage, org.eclipse.core.resources.IResource initialSelection)
AbstractFileNewWizardPage	createNewWizardPage(org.eclipse.core.resources.IResource initialSelection)
protected abstract java.lang.String	getEditorId()
abstract java.lang.String	getInitialContentsAsString(org.eclipse.core.resources.IFile newFile, AbstractFileDialog dialog) Returns a string containing the initial contents to be given to new complete OCL file resource instances.
abstract java.lang.String	getNewFileExtension() Returns the extension to display in the file name specification visual component group.
abstract java.lang.String	getNewFileLabel() Returns the label to display in the file name specification visual component group.
abstract java.lang.String	getNewFileName() Returns the name to display in the file name specification visual component group.
abstract java.lang.String	getPageDescription() Return the long description to appear in the dialog.
abstract java.lang.String	getPageSummary() Return the short description to appear in the dialog.
abstract java.lang.String	getPageTitle() Return the text to appear as the title in the window manager frame.
void	init(org.eclipse.ui.IWorkbench workbench, org.eclipse.jface.viewers.IStructuredSelection selection)
boolean	performFinish() Performs finish action of this wizard.

Methods inherited from class org.eclipse.jface.wizard.Wizard

addPage, addPages, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getShell, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.jface.wizard.IWizard

addPages, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer

Constructor Detail

AbstractFileNewWizard

protected AbstractFileNewWizard()

Constructor

Method Detail

createDialog

@NonNull
protected abstract AbstractFileDialog createDialog(@NonNull
                                                           AbstractFileNewWizardPage wizardPage,
                                                           @Nullable
                                                           org.eclipse.core.resources.IResource initialSelection)

createNewWizardPage

@NonNull
public AbstractFileNewWizardPage createNewWizardPage(@Nullable
                                                             org.eclipse.core.resources.IResource initialSelection)

getEditorId

protected abstract java.lang.String getEditorId()

getInitialContentsAsString

@NonNull
public abstract java.lang.String getInitialContentsAsString(@NonNull
                                                                    org.eclipse.core.resources.IFile newFile,
                                                                    @NonNull
                                                                    AbstractFileDialog dialog)

Returns a string containing the initial contents to be given to new complete OCL file resource instances.

Returns:

contents to be given to new complete OCL file resource instances

getNewFileExtension

@NonNull
public abstract java.lang.String getNewFileExtension()

Returns the extension to display in the file name specification visual component group.

Returns:

the extension to display in the file name specification visual component group

getNewFileName

@NonNull
public abstract java.lang.String getNewFileName()

Returns the name to display in the file name specification visual component group.

Returns:

the name to display in the file name specification visual component group

getNewFileLabel

@NonNull
public abstract java.lang.String getNewFileLabel()

Returns the label to display in the file name specification visual component group.

Returns:

the label to display in the file name specification visual component group

getPageDescription

@NonNull
public abstract java.lang.String getPageDescription()

Return the long description to appear in the dialog.

getPageSummary

@NonNull
public abstract java.lang.String getPageSummary()

Return the short description to appear in the dialog.

getPageTitle

@NonNull
public abstract java.lang.String getPageTitle()

Return the text to appear as the title in the window manager frame.

init

public void init(org.eclipse.ui.IWorkbench workbench,
                 org.eclipse.jface.viewers.IStructuredSelection selection)

Specified by:

init in interface org.eclipse.ui.IWorkbenchWizard

See Also:

IWorkbenchWizard.init(org.eclipse.ui.IWorkbench, org.eclipse.jface.viewers.IStructuredSelection)

performFinish

public boolean performFinish()

Performs finish action of this wizard.

Specified by:

performFinish in interface org.eclipse.jface.wizard.IWizard

Specified by:

performFinish in class org.eclipse.jface.wizard.Wizard

See Also:

Wizard.performFinish()