com.ibm.xtools.common.ui.wizards

Class NewModelFromExistingModelPage

java.lang.Object

org.eclipse.jface.dialogs.DialogPage

org.eclipse.jface.wizard.WizardPage

com.ibm.xtools.common.ui.wizards.AbstractNewModelPage

com.ibm.xtools.common.ui.wizards.NewModelFromExistingModelPage

All Implemented Interfaces:

org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage

public class NewModelFromExistingModelPage
extends AbstractNewModelPage

A new model wizard page which creates a new model from an existing model.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isFileNameRedefined
protected static int	MAX_RECENTLY_USED
protected boolean	modelSelectionValid
protected static java.lang.String	RECENTLY_USED_MODELS
protected java.util.List<java.lang.String>	recentlyOpenedModels
protected org.eclipse.swt.widgets.Combo	recentlyUsedModelsCombo
protected java.lang.String	setFilename
protected org.eclipse.core.resources.IFile	sourceModel

Fields inherited from class com.ibm.xtools.common.ui.wizards.AbstractNewModelPage

browseButton, containerControl, DESCRIPTION_MINIMUM_WIDTH, fileNameControl, helpID, IMAGE_MAX_HEIGHT, IMAGE_MAX_WIDTH, resourceContainer, selection

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

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

Constructors

Constructor and Description
NewModelFromExistingModelPage(java.lang.String pageName, org.eclipse.jface.viewers.IStructuredSelection selection)

Method Summary

Modifier and Type	Method and Description
void	createControl(org.eclipse.swt.widgets.Composite parent)
protected FilteredFileSelectionDialog	createFileSelectionDialog() Create a FilderedFileSelectionDialog to browse for valid model files.
protected boolean	finishPage(org.eclipse.core.runtime.IProgressMonitor monitor) Creates the model template from the valid user input
protected java.lang.String[]	getFileExtensions() Return the array of valid file extensions to used to filter elements out of the browse dialog.
protected java.lang.String	getModelFileExtension() Lazily instantiates the EXTENSION field to avoid premature plugin loading.
org.eclipse.jface.wizard.IWizardPage	getNextPage() Returns the first next page.
protected org.eclipse.core.resources.IFile	getSourceModelResource(java.lang.String relativePath) Gets the IFile object for the relativePath
protected void	handleBrowseModel() Solicits model file from user
protected void	handleNewModelSelected(java.lang.String relativePath) Called whenever a new model file is being selected as a source.
protected void	handleNewRelativePath(java.lang.String relativePath)
protected boolean	isModelSelectionValid()
protected void	readPageSettings() Read the wizard page settings for the recently used models.
protected void	savePageSettings() Save the wizard page settings for the recently used models.
protected void	setModelSelectionValid(boolean modelSelectionValid)
static java.lang.String	toAbsolutePath(java.lang.String relativePath) Converts a relative workspace path into an absolute workspace path
static java.lang.String	toRelativePath(java.lang.String absolutePath) Converts an absolute workspace path into a relative workspace path
protected boolean	validateModelSelection()
protected boolean	validatePage() A page is considered validated if both the filename and container are OK.

Methods inherited from class com.ibm.xtools.common.ui.wizards.AbstractNewModelPage

createContainerControlGroup, createFileNameLabel, createProject, getContainerPath, getContainerText, getContainingProjectName, getDefaultDirectoryName, getFileName, handleBrowse, initialPopulateContainerNameField, isProjectWizard, makeAndAppendFilename, makeFilename, preFinishPage, removeProject, setHelpID, setVisible, updateContainer, validateContainer, validateFilename

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

canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, 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

RECENTLY_USED_MODELS

protected static final java.lang.String RECENTLY_USED_MODELS

See Also:

Constant Field Values

MAX_RECENTLY_USED

protected static final int MAX_RECENTLY_USED

See Also:

Constant Field Values

recentlyOpenedModels

protected java.util.List<java.lang.String> recentlyOpenedModels

modelSelectionValid

protected boolean modelSelectionValid

recentlyUsedModelsCombo

protected org.eclipse.swt.widgets.Combo recentlyUsedModelsCombo

sourceModel

protected org.eclipse.core.resources.IFile sourceModel

isFileNameRedefined

protected boolean isFileNameRedefined

setFilename

protected java.lang.String setFilename

Constructor Detail

NewModelFromExistingModelPage

public NewModelFromExistingModelPage(java.lang.String pageName,
                                     org.eclipse.jface.viewers.IStructuredSelection selection)

Method Detail

getNextPage

public org.eclipse.jface.wizard.IWizardPage getNextPage()

Returns the first next page.

Specified by:

getNextPage in interface org.eclipse.jface.wizard.IWizardPage

Overrides:

getNextPage in class org.eclipse.jface.wizard.WizardPage

readPageSettings

protected void readPageSettings()

Read the wizard page settings for the recently used models.

savePageSettings

protected void savePageSettings()

Save the wizard page settings for the recently used models.

createControl

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

Specified by:

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

Overrides:

createControl in class AbstractNewModelPage

getFileExtensions

protected java.lang.String[] getFileExtensions()

Return the array of valid file extensions to used to filter elements out of the browse dialog.

Returns:

array of file extensions

createFileSelectionDialog

protected FilteredFileSelectionDialog createFileSelectionDialog()

Create a FilderedFileSelectionDialog to browse for valid model files.

Returns:

a FilderedFileSelectionDialog

handleBrowseModel

protected void handleBrowseModel()

Solicits model file from user

handleNewRelativePath

protected void handleNewRelativePath(java.lang.String relativePath)

handleNewModelSelected

protected void handleNewModelSelected(java.lang.String relativePath)

Called whenever a new model file is being selected as a source.

Parameters:

relativePath - a source model relative path

getSourceModelResource

protected org.eclipse.core.resources.IFile getSourceModelResource(java.lang.String relativePath)

Gets the IFile object for the relativePath

Returns:

IFile the resource for the relativePath

finishPage

protected boolean finishPage(org.eclipse.core.runtime.IProgressMonitor monitor)

Creates the model template from the valid user input

Overrides:

finishPage in class AbstractNewModelPage

Returns:

boolean true if successful, otherwise false

isModelSelectionValid

protected boolean isModelSelectionValid()

Returns:

Returns the modelSelectionValid.

setModelSelectionValid

protected void setModelSelectionValid(boolean modelSelectionValid)

Parameters:

modelSelectionValid - The modelSelectionValid to set.

validateModelSelection

protected boolean validateModelSelection()

validatePage

protected boolean validatePage()

Description copied from class: AbstractNewModelPage

A page is considered validated if both the filename and container are OK. The function has been written in one line since the two functions in validatePage are not meant to be called one after the other if the first one fails.

Overrides:

validatePage in class AbstractNewModelPage

Returns:

true if page is valid, false if not.

toAbsolutePath

public static java.lang.String toAbsolutePath(java.lang.String relativePath)

Converts a relative workspace path into an absolute workspace path

Parameters:

relativePath - the relative workspace path

Returns:

String the absolute workspace path

toRelativePath

public static java.lang.String toRelativePath(java.lang.String absolutePath)

Converts an absolute workspace path into a relative workspace path

Parameters:

absolutePath - the absolute workspace path

Returns:

String the relative workspace path

getModelFileExtension

protected java.lang.String getModelFileExtension()

Description copied from class: AbstractNewModelPage

Lazily instantiates the EXTENSION field to avoid premature plugin loading.

Specified by:

getModelFileExtension in class AbstractNewModelPage

Returns:

the file extension for model files