com.ibm.xtools.common.ui.wizards

Class AbstractNewModelPage

java.lang.Object

org.eclipse.jface.dialogs.DialogPage

org.eclipse.jface.wizard.WizardPage

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

All Implemented Interfaces:

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

Direct Known Subclasses:

NewModelFromExistingModelPage, NewModelFromTemplatePage

public abstract class AbstractNewModelPage
extends org.eclipse.jface.wizard.WizardPage

An abstract generalization of the new model wizard model creation pages.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.swt.widgets.Button	browseButton The container browse button.
protected org.eclipse.swt.widgets.Text	containerControl Container text box
protected static int	DESCRIPTION_MINIMUM_WIDTH Minimum width for description
protected org.eclipse.swt.widgets.Text	fileNameControl File name text box
protected java.lang.String	helpID
protected static int	IMAGE_MAX_HEIGHT For the image size as icons
protected static int	IMAGE_MAX_WIDTH For the image size as icons
protected org.eclipse.core.resources.IContainer	resourceContainer
protected org.eclipse.jface.viewers.IStructuredSelection	selection The selection, used by the new model wizard

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

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

Constructors

Constructor and Description
AbstractNewModelPage(java.lang.String pageName, org.eclipse.jface.viewers.IStructuredSelection selection) Creates a new file creation wizard page.

Method Summary

Modifier and Type	Method and Description
protected void	createContainerControlGroup(org.eclipse.swt.widgets.Composite parent) Creates the controls including buttons tree and table controls that appear in the dialog box.
void	createControl(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.swt.widgets.Label	createFileNameLabel(org.eclipse.swt.widgets.Composite parent) Create file name label.
static boolean	createProject(org.eclipse.core.resources.IProject newProject, java.net.URI newProjectLocation, org.eclipse.core.runtime.IProgressMonitor monitor, org.eclipse.jface.wizard.IWizardContainer wizard, org.eclipse.core.resources.IProject[] refProjects) Create the new project.
protected boolean	finishPage(org.eclipse.core.runtime.IProgressMonitor monitor)
protected org.eclipse.core.runtime.IPath	getContainerPath() Returns the container path
protected java.lang.String	getContainerText() Return the container text.
protected java.lang.String	getContainingProjectName() Return the name of the project which should contain the new resource.
protected java.lang.String	getDefaultDirectoryName()
protected java.lang.String	getFileName() Returns the text inside the filename control in this wizard page.
protected abstract java.lang.String	getModelFileExtension() Lazily instantiates the EXTENSION field to avoid premature plugin loading.
protected void	handleBrowse() Handle the click of Browse button.
protected void	initialPopulateContainerNameField() The container should be set based on the resource selected by the user.
protected boolean	isProjectWizard()
protected org.eclipse.core.resources.IFile	makeAndAppendFilename(int i, java.lang.String originalFileName) Makes a IFile filename based on the containerControl's filename.
protected java.lang.String	makeFilename(java.lang.String originalFilename) Makes a String filename that's valid and that doesn't exist based on the originalFilename.
protected boolean	preFinishPage()
static void	removeProject(boolean deleteContents, org.eclipse.core.resources.IProject newProject, org.eclipse.core.runtime.IProgressMonitor monitor) Remove the project we have created.
void	setHelpID(java.lang.String helpID) Sets the help ID of this page.
void	setVisible(boolean visible)
protected void	updateContainer(java.lang.String newContainer) Update the container.
protected boolean	validateContainer() Checks the container name in containerControl for validity
protected boolean	validateFilename() Checks the filename in filenameControl for validity
protected boolean	validatePage() A page is considered validated if both the filename and container are OK.

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

DESCRIPTION_MINIMUM_WIDTH

protected static final int DESCRIPTION_MINIMUM_WIDTH

Minimum width for description

See Also:

Constant Field Values

IMAGE_MAX_WIDTH

protected static final int IMAGE_MAX_WIDTH

For the image size as icons

See Also:

Constant Field Values

IMAGE_MAX_HEIGHT

protected static final int IMAGE_MAX_HEIGHT

For the image size as icons

See Also:

Constant Field Values

containerControl

protected org.eclipse.swt.widgets.Text containerControl

Container text box

fileNameControl

protected org.eclipse.swt.widgets.Text fileNameControl

File name text box

browseButton

protected org.eclipse.swt.widgets.Button browseButton

The container browse button.

selection

protected org.eclipse.jface.viewers.IStructuredSelection selection

The selection, used by the new model wizard

resourceContainer

protected org.eclipse.core.resources.IContainer resourceContainer

helpID

protected java.lang.String helpID

Constructor Detail

AbstractNewModelPage

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

Creates a new file creation wizard page. If the initial resource selection contains exactly one container resource then it will be used as the default container resource.

Parameters:

pageName - the name of the page

selection - the current resource selection

Method Detail

setHelpID

public void setHelpID(java.lang.String helpID)

Sets the help ID of this page.

Parameters:

helpID - the help ID of this page

isProjectWizard

protected boolean isProjectWizard()

createControl

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

createContainerControlGroup

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

Creates the controls including buttons tree and table controls that appear in the dialog box.

Parameters:

parent - the parent composite to be treated as the controls' parent

createFileNameLabel

protected org.eclipse.swt.widgets.Label createFileNameLabel(org.eclipse.swt.widgets.Composite parent)

Create file name label.

Parameters:

parent -

handleBrowse

protected void handleBrowse()

Handle the click of Browse button.

setVisible

public void setVisible(boolean visible)

Specified by:

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

Overrides:

setVisible in class org.eclipse.jface.dialogs.DialogPage

updateContainer

protected void updateContainer(java.lang.String newContainer)

Update the container. Call this after the Browse button has been pressed followed by OK. Also call this when the dialog is initially shown.

Parameters:

newContainer - a string that contains the name of the new container

getContainingProjectName

protected java.lang.String getContainingProjectName()

Return the name of the project which should contain the new resource.

Returns:

the name of the project which should contain the new resource

getContainerText

protected java.lang.String getContainerText()

Return the container text.

Returns:

the container text

validateFilename

protected boolean validateFilename()

Checks the filename in filenameControl for validity

Returns:

true if validated, false if not

validateContainer

protected boolean validateContainer()

Checks the container name in containerControl for validity

Returns:

true if validated, false if not

makeAndAppendFilename

protected org.eclipse.core.resources.IFile makeAndAppendFilename(int i,
                                                                 java.lang.String originalFileName)

Makes a IFile filename based on the containerControl's filename. The filename will contain the integer i except if i is 0. Positive integers expected, but this is not checked since it's not critical if a negative integer is given.

Parameters:

i - the integer to append the filename with

originalFileName - the original file name

Returns:

the file

makeFilename

protected java.lang.String makeFilename(java.lang.String originalFilename)

Makes a String filename that's valid and that doesn't exist based on the originalFilename. This function appends numbers after the original filename if necessary.

Parameters:

originalFilename - the original filename without extension

Returns:

the filename

initialPopulateContainerNameField

protected void initialPopulateContainerNameField()

The container should be set based on the resource selected by the user.

getFileName

protected java.lang.String getFileName()

Returns the text inside the filename control in this wizard page.

Returns:

String with the text inside the filename control, should not contain path

getContainerPath

protected org.eclipse.core.runtime.IPath getContainerPath()

Returns the container path

Returns:

IPath of the container

validatePage

protected boolean validatePage()

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.

Returns:

true if page is valid, false if not.

getModelFileExtension

protected abstract java.lang.String getModelFileExtension()

Lazily instantiates the EXTENSION field to avoid premature plugin loading.

Returns:

the file extension for model files

preFinishPage

protected boolean preFinishPage()

finishPage

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

createProject

public static boolean createProject(org.eclipse.core.resources.IProject newProject,
                                    java.net.URI newProjectLocation,
                                    org.eclipse.core.runtime.IProgressMonitor monitor,
                                    org.eclipse.jface.wizard.IWizardContainer wizard,
                                    org.eclipse.core.resources.IProject[] refProjects)

Create the new project.

Parameters:

newProject - the new project.

newProjectLocation - the new project location.

monitor - the progress monitor.

removeProject

public static void removeProject(boolean deleteContents,
                                 org.eclipse.core.resources.IProject newProject,
                                 org.eclipse.core.runtime.IProgressMonitor monitor)

Remove the project we have created.

Parameters:

newProject - the new project to remove.

getDefaultDirectoryName

protected java.lang.String getDefaultDirectoryName()