org.eclipse.sphinx.emf.workspace.ui.wizards.pages

Class NewModelFileCreationPage<T extends IMetaModelDescriptor>

java.lang.Object

org.eclipse.jface.dialogs.DialogPage

org.eclipse.jface.wizard.WizardPage

org.eclipse.ui.dialogs.WizardNewFileCreationPage

org.eclipse.sphinx.emf.workspace.ui.wizards.pages.NewModelFileCreationPage<T>

All Implemented Interfaces:

org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage, org.eclipse.swt.widgets.Listener

public class NewModelFileCreationPage<T extends IMetaModelDescriptor>
extends org.eclipse.ui.dialogs.WizardNewFileCreationPage

Basic main page for a wizard that creates a file resource. The new model file is to be created based on the given new model file properties (metamodel, ePackage and eClassifier).

This page may be used by clients as it is; it may also be subclassed to suit. Subclasses may override validatePage(), getFileExtensionErrorMessage(), getRequiredProjectNatureErrorMessage(), hasRequiredProjectNature(), setVisible(), getDefaultFileExtension(), etc.

Field Summary

Fields

Modifier and Type	Field and Description
protected InitialModelProperties<T>	initialModelProperties
protected IProjectWorkspacePreference<T>	metaModelVersionPreference
protected boolean	noValidFileExtensionsForContentTypeIdFoundProblemLoggedOnce
protected org.eclipse.jface.viewers.IStructuredSelection	selection

Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

Constructors

Constructor and Description
NewModelFileCreationPage(java.lang.String pageId, org.eclipse.jface.viewers.IStructuredSelection selection, InitialModelProperties<T> initialModelProperties) Creates a new instance of new model file creation wizard page.
NewModelFileCreationPage(java.lang.String pageId, org.eclipse.jface.viewers.IStructuredSelection selection, IProjectWorkspacePreference<T> metaModelVersionPreference) Creates a new instance of the new model file creation wizard page.
NewModelFileCreationPage(java.lang.String pageId, org.eclipse.jface.viewers.IStructuredSelection selection, IProjectWorkspacePreference<T> metaModelVersionPreference, InitialModelProperties<T> initialModelProperties) Creates a new instance of new model file creation wizard page.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	convertFileExtensionsToString(java.util.Collection<java.lang.String> fileExtensions) Converts the given collection of file extensions into a string.
protected void	createAdditionalControls(org.eclipse.swt.widgets.Composite parent) Creates controls for specific project creation options to be placed behind those for file name, container and advanced options (which are created by WizardNewFileCreationPage.createControl(Composite)).
void	createControl(org.eclipse.swt.widgets.Composite parent)
protected java.lang.String	createFileName(java.lang.String baseName, java.lang.String extension, int number) Creates a name for the new file to be created using provided base name, extension and number.
org.eclipse.core.resources.IProject	getContainerProject() Returns the project behind the containing resource as entered or selected by the user.
protected java.lang.String	getContentTypeId() Returns the content type identifier for the metamodel descriptor behind the new model file properties
protected java.lang.String	getDefaultBaseName() Gets the default base name of the new file, a string "default" by default.
protected java.lang.String	getDefaultFileExtension() Returns the default file extension of the new model file to be created.
protected java.lang.String	getFileExtensionErrorMessage(java.util.Collection<java.lang.String> validFileExtensions)
protected java.lang.String	getMatchingMetaModelVersionErrorMessage()
protected T	getMetaModelDescriptor() Returns the metamodel descriptor of the new file to be created.
protected java.lang.String	getMetaModelName()
org.eclipse.core.resources.IFile	getNewFile() Returns the new file behind the current file name as entered or selected by the user.
protected java.lang.String	getRequiredProjectNatureErrorMessage()
protected java.lang.String	getRequiredProjectTypeName()
protected java.lang.String	getUniqueDefaultFileName(org.eclipse.core.resources.IContainer container) Returns a unique default name for the new file to be created which is composed of its default base name and the default extension.
protected java.util.Collection<java.lang.String>	getValidFileExtensions() Returns the valid file extensions for model files.
protected boolean	hasMatchingMetaModelVersion(org.eclipse.core.resources.IProject project) Checks if the metamodel version of the specified project matches that of the model file to be created
protected boolean	hasRequiredProjectNature(org.eclipse.core.resources.IProject project) Checks if the specified project has the required nature that has been provided to this NewModelFileCreationPage.
void	setRequiredProjectTypeName(java.lang.String requiredProjectTypeName)
void	setVisible(boolean visible)
protected boolean	validatePage()

Methods inherited from class org.eclipse.ui.dialogs.WizardNewFileCreationPage

createAdvancedControls, createFile, createFileHandle, createLinkTarget, createNewFile, createRule, getContainerFullPath, getFileExtension, getFileName, getInitialContents, getNewFileLabel, handleAdvancedButtonSelect, handleEvent, initialPopulateContainerNameField, setAllowExistingResources, setContainerFullPath, setFileExtension, setFileName, 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

selection

protected org.eclipse.jface.viewers.IStructuredSelection selection

metaModelVersionPreference

protected IProjectWorkspacePreference<T extends IMetaModelDescriptor> metaModelVersionPreference

initialModelProperties

protected InitialModelProperties<T extends IMetaModelDescriptor> initialModelProperties

noValidFileExtensionsForContentTypeIdFoundProblemLoggedOnce

protected boolean noValidFileExtensionsForContentTypeIdFoundProblemLoggedOnce

Constructor Detail

NewModelFileCreationPage

public NewModelFileCreationPage(java.lang.String pageId,
                        org.eclipse.jface.viewers.IStructuredSelection selection,
                        IProjectWorkspacePreference<T> metaModelVersionPreference)

Creates a new instance of the new model file creation wizard page.

Parameters:

pageId - the name of the page

selection - the current resource selection

metaModelVersionPreference - the metamodel version preference

NewModelFileCreationPage

public NewModelFileCreationPage(java.lang.String pageId,
                        org.eclipse.jface.viewers.IStructuredSelection selection,
                        InitialModelProperties<T> initialModelProperties)

Creates a new instance of new model file creation wizard page.

Parameters:

pageId - the name of the page

selection - the current resource selection

initialModelProperties - the chosen initial model properties (metamodel, EPackage and EClassifier) to be used as basis for creating the initial model of the new model file

NewModelFileCreationPage

public NewModelFileCreationPage(java.lang.String pageId,
                        org.eclipse.jface.viewers.IStructuredSelection selection,
                        IProjectWorkspacePreference<T> metaModelVersionPreference,
                        InitialModelProperties<T> initialModelProperties)

Creates a new instance of new model file creation wizard page.

Parameters:

pageId - the name of the page

selection - the current resource selection

metaModelVersionPreference - the metamodel version preference

initialModelProperties - the chosen initial model properties (metamodel, EPackage and EClassifier) to be used as basis for creating the initial model of the new model file

Method Detail

createControl

public void createControl(org.eclipse.swt.widgets.Composite parent)

Specified by:

createControl in interface org.eclipse.jface.dialogs.IDialogPage

Overrides:

createControl in class org.eclipse.ui.dialogs.WizardNewFileCreationPage

createAdditionalControls

protected void createAdditionalControls(org.eclipse.swt.widgets.Composite parent)

Creates controls for specific project creation options to be placed behind those for file name, container and advanced options (which are created by WizardNewFileCreationPage.createControl(Composite)).

This implementation does nothing.

This method may be overridden by subclasses to provide custom implementations.

Parameters:

parent - the parent composite

See Also:

WizardNewFileCreationPage.createControl(Composite)

getContainerProject

public org.eclipse.core.resources.IProject getContainerProject()

Returns the project behind the containing resource as entered or selected by the user.

Returns:

the container project or null if it is not yet known

getNewFile

public org.eclipse.core.resources.IFile getNewFile()

Returns the new file behind the current file name as entered or selected by the user.

Returns:

the new file or null if it is not yet known

getUniqueDefaultFileName

protected java.lang.String getUniqueDefaultFileName(org.eclipse.core.resources.IContainer container)

Returns a unique default name for the new file to be created which is composed of its default base name and the default extension. If this file name already exists new file names are generated by appending an integer number to the default base name (or to the default extension if the default base name is omitted) until a new file name has been found that is not yet used.

See Also:

getDefaultBaseName(), getDefaultFileExtension()

createFileName

protected java.lang.String createFileName(java.lang.String baseName,
                              java.lang.String extension,
                              int number)

Creates a name for the new file to be created using provided base name, extension and number.

Parameters:

baseName - the base name of the new file, or null if new file should have no base name

extension - the extension of the new file, or null if new file should have no extension

number - a non-negative number to be appended to the new file's base name - or to its extension in case that the former is omitted - or -1 if no number should be appended at all

Returns:

the new file name

getDefaultBaseName

protected java.lang.String getDefaultBaseName()

Gets the default base name of the new file, a string "default" by default.

getDefaultFileExtension

protected java.lang.String getDefaultFileExtension()

Returns the default file extension of the new model file to be created.

Returns:

the first string value of File Extension defined for the content type by default. If more than one file extensions are defined for the content type, the clients should provide their specific overridden methods.

getContentTypeId

protected java.lang.String getContentTypeId()

Returns the content type identifier for the metamodel descriptor behind the new model file properties

getRequiredProjectTypeName

protected java.lang.String getRequiredProjectTypeName()

setRequiredProjectTypeName

public void setRequiredProjectTypeName(java.lang.String requiredProjectTypeName)

getMetaModelDescriptor

protected T getMetaModelDescriptor()

Returns the metamodel descriptor of the new file to be created.

Returns:

the new file's metamodel descriptor

getMetaModelName

protected java.lang.String getMetaModelName()

setVisible

public void setVisible(boolean visible)

Specified by:

setVisible in interface org.eclipse.jface.dialogs.IDialogPage

Overrides:

setVisible in class org.eclipse.ui.dialogs.WizardNewFileCreationPage

validatePage

protected boolean validatePage()

Overrides:

validatePage in class org.eclipse.ui.dialogs.WizardNewFileCreationPage

hasRequiredProjectNature

protected boolean hasRequiredProjectNature(org.eclipse.core.resources.IProject project)

Checks if the specified project has the required nature that has been provided to this NewModelFileCreationPage.

Parameters:

project - the project to be checked; must not be null and must be accessible

Returns:

true if specified project has the required nature or no nature is required, false otherwise.

hasMatchingMetaModelVersion

protected boolean hasMatchingMetaModelVersion(org.eclipse.core.resources.IProject project)

Checks if the metamodel version of the specified project matches that of the model file to be created

Parameters:

project - the project to be checked; must not be null and must be accessible

Returns:

true if specified project's metamodel version matches that of the model file to be created or no metamodel version preference, false otherwise.

getValidFileExtensions

protected java.util.Collection<java.lang.String> getValidFileExtensions()

Returns the valid file extensions for model files. They are retrieved from the content type to be used when creating new model file.

Returns:

A collection of valid file extensions for model files

getRequiredProjectNatureErrorMessage

protected java.lang.String getRequiredProjectNatureErrorMessage()

getMatchingMetaModelVersionErrorMessage

protected java.lang.String getMatchingMetaModelVersionErrorMessage()

getFileExtensionErrorMessage

protected java.lang.String getFileExtensionErrorMessage(java.util.Collection<java.lang.String> validFileExtensions)

convertFileExtensionsToString

protected java.lang.String convertFileExtensionsToString(java.util.Collection<java.lang.String> fileExtensions)

Converts the given collection of file extensions into a string.

Parameters:

fileExtensions - the collection of file extensions to be converted

Returns:

the file extensions as string