org.eclipse.m2e.core.ui.internal.wizards

Class MavenProjectWizardLocationPage

java.lang.Object

org.eclipse.jface.dialogs.DialogPage

org.eclipse.jface.wizard.WizardPage

org.eclipse.m2e.core.ui.internal.wizards.AbstractMavenWizardPage

org.eclipse.m2e.core.ui.internal.wizards.MavenProjectWizardLocationPage

All Implemented Interfaces:

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

public class MavenProjectWizardLocationPage
extends AbstractMavenWizardPage

Wizard page used to specify project location and working set.

Field Summary

Fields inherited from class org.eclipse.m2e.core.ui.internal.wizards.AbstractMavenWizardPage

dialogSettings, MAX_HISTORY, resolverConfigurationComponent

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

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

Constructors

Constructor and Description
MavenProjectWizardLocationPage(ProjectImportConfiguration configuration, String title, String description, List<org.eclipse.ui.IWorkingSet> workingSets) Creates Maven project location page.

Method Summary

Modifier and Type	Method and Description
protected void	createAdditionalControls(org.eclipse.swt.widgets.Composite container) Create additional controls
void	createControl(org.eclipse.swt.widgets.Composite parent) This wizard page contains a component to query the project name and a MavenLocationComponent which allows to specify whether the project should be created in the workspace or at some given external location.
void	dispose() Saves the history when the page is disposed.
org.eclipse.core.runtime.IPath	getLocationPath() Returns the path of the location where the project is to be created.
boolean	isInWorkspace() Returns whether the user has chosen to create the project in the workspace or at an external location.
void	setLocationPath(org.eclipse.core.runtime.IPath location)
void	setVisible(boolean visible) Loads the advanced settings data when the page is displayed.
protected void	validate() Validates the contents of this wizard page.

Methods inherited from class org.eclipse.m2e.core.ui.internal.wizards.AbstractMavenWizardPage

addFieldWithHistory, createAdvancedSettings, getImportConfiguration, validateArtifactIdInput, validateGroupIdInput

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, 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

getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp

Constructor Detail

MavenProjectWizardLocationPage

public MavenProjectWizardLocationPage(ProjectImportConfiguration configuration,
                                      String title,
                                      String description,
                                      List<org.eclipse.ui.IWorkingSet> workingSets)

Creates Maven project location page.

Parameters:

title - location page title text

description - location page description text

Method Detail

createControl

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

This wizard page contains a component to query the project name and a MavenLocationComponent which allows to specify whether the project should be created in the workspace or at some given external location.

createAdditionalControls

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

Create additional controls

dispose

public void dispose()

Description copied from class: AbstractMavenWizardPage

Saves the history when the page is disposed.

Specified by:

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

Overrides:

dispose in class AbstractMavenWizardPage

isInWorkspace

public boolean isInWorkspace()

Returns whether the user has chosen to create the project in the workspace or at an external location.

Returns:

true if the project is to be created in the workspace, false if it should be created at an external location.

getLocationPath

public org.eclipse.core.runtime.IPath getLocationPath()

Returns the path of the location where the project is to be created. According to the user input, the path either points to the workspace or to a valid user specified location on the filesystem.

Returns:

The path of the location where to create the project. Is never null.

setLocationPath

public void setLocationPath(org.eclipse.core.runtime.IPath location)

setVisible

public void setVisible(boolean visible)

Loads the advanced settings data when the page is displayed.

Specified by:

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

Overrides:

setVisible in class AbstractMavenWizardPage

validate

protected void validate()

Validates the contents of this wizard page.

Feedback about the validation is given to the user by displaying error messages or informative messages on the wizard page. Depending on the provided user input, the wizard page is marked as being complete or not.

If some error or missing input is detected in the user input, an error message or informative message, respectively, is displayed to the user. If the user input is complete and correct, the wizard page is marked as begin complete to allow the wizard to proceed. To that end, the following conditions must be met:

• The user must have provided a project name.
• The project name must be a valid project resource identifier.
• A project with the same name must not exist.
• A valid project location path must have been specified.

See Also:

IWorkspace.validateName(java.lang.String, int), IWorkspace.validateProjectLocation(org.eclipse.core.resources.IProject, org.eclipse.core.runtime.IPath), DialogPage.setMessage(java.lang.String), WizardPage.setErrorMessage(java.lang.String), WizardPage.setPageComplete(boolean)