null. If the errorMessage is
* null then clear any error state.
* @param infoOnly
* the message is an informational message, but the dialog
* cannot continue
*
*/
public void reportError(String errorMessage, boolean infoOnly);
}
private static String BROWSE_LABEL = IDEWorkbenchMessages.ProjectLocationSelectionDialog_browseLabel;
private static final int SIZING_TEXT_FIELD_WIDTH = 250;
private static final String FILE_SCHEME = "file"; //$NON-NLS-1$
private static final String SAVED_LOCATION_ATTR = "OUTSIDE_LOCATION"; //$NON-NLS-1$
private Label locationLabel;
private Text locationPathField;
private Button browseButton;
private IErrorMessageReporter errorReporter;
private String projectName = IDEResourceInfoUtils.EMPTY_STRING;
private String userPath = IDEResourceInfoUtils.EMPTY_STRING;
private Button useDefaultsButton;
private IProject existingProject;
private FileSystemSelectionArea fileSystemSelectionArea;
/**
* Create a new instance of the receiver.
*
* @param reporter
* @param composite
* @param startProject
*/
public ProjectContentsLocationArea(IErrorMessageReporter reporter,
Composite composite, IProject startProject) {
errorReporter = reporter;
projectName = startProject.getName();
existingProject = startProject;
createContents(composite, false);
}
/**
* Set the project to base the contents off of.
*
* @param existingProject
*/
public void setExistingProject(IProject existingProject) {
projectName = existingProject.getName();
this.existingProject = existingProject;
}
/**
* Create a new instance of a ProjectContentsLocationArea.
*
* @param reporter
* @param composite
*/
public ProjectContentsLocationArea(IErrorMessageReporter reporter,
Composite composite) {
errorReporter = reporter;
// If it is a new project always start enabled
createContents(composite, true);
}
/**
* Set enable status on all widgets used to display project location area.
*/
public void setEnabled(boolean enabled) {
locationLabel.setEnabled(enabled);
browseButton.setEnabled(enabled);
useDefaultsButton.setEnabled(enabled);
}
/**
* Create the contents of the receiver.
*
* @param composite
* @param defaultEnabled
*/
private void createContents(Composite composite, boolean defaultEnabled) {
int columns = 4;
// project specification group
Composite projectGroup = new Composite(composite, SWT.NONE);
GridLayout layout = new GridLayout();
layout.numColumns = columns;
projectGroup.setLayout(layout);
projectGroup.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
useDefaultsButton = new Button(projectGroup, SWT.CHECK | SWT.RIGHT);
useDefaultsButton
.setText(IDEWorkbenchMessages.ProjectLocationSelectionDialog_useDefaultLabel);
useDefaultsButton.setSelection(defaultEnabled);
GridData buttonData = new GridData();
buttonData.horizontalSpan = columns;
useDefaultsButton.setLayoutData(buttonData);
createUserEntryArea(projectGroup, defaultEnabled);
useDefaultsButton.addSelectionListener(new SelectionAdapter() {
public void widgetSelected(SelectionEvent e) {
boolean useDefaults = useDefaultsButton.getSelection();
if (useDefaults) {
userPath = locationPathField.getText();
locationPathField.setText(TextProcessor
.process(getDefaultPathDisplayString()));
} else {
locationPathField.setText(TextProcessor.process(userPath));
}
String error = checkValidLocation();
errorReporter.reportError(error,
error != null && error.equals(IDEWorkbenchMessages.WizardNewProjectCreationPage_projectLocationEmpty));
setUserAreaEnabled(!useDefaults);
}
});
setUserAreaEnabled(!defaultEnabled);
}
/**
* Return whether or not we are currently showing the default location for
* the project.
*
* @return boolean
*/
public boolean isDefault() {
return useDefaultsButton.getSelection();
}
/**
* Create the area for user entry.
*
* @param composite
* @param defaultEnabled
*/
private void createUserEntryArea(Composite composite, boolean defaultEnabled) {
// location label
locationLabel = new Label(composite, SWT.NONE);
locationLabel
.setText(IDEWorkbenchMessages.ProjectLocationSelectionDialog_locationLabel);
// project location entry field
locationPathField = new Text(composite, SWT.BORDER);
GridData data = new GridData(GridData.FILL_HORIZONTAL);
data.widthHint = SIZING_TEXT_FIELD_WIDTH;
data.horizontalSpan = 2;
locationPathField.setLayoutData(data);
// browse button
browseButton = new Button(composite, SWT.PUSH);
browseButton.setText(BROWSE_LABEL);
browseButton.addSelectionListener(new SelectionAdapter() {
public void widgetSelected(SelectionEvent event) {
handleLocationBrowseButtonPressed();
}
});
createFileSystemSelection(composite);
if (defaultEnabled) {
locationPathField.setText(TextProcessor
.process(getDefaultPathDisplayString()));
} else {
if (existingProject == null) {
locationPathField.setText(IDEResourceInfoUtils.EMPTY_STRING);
} else {
locationPathField.setText(TextProcessor.process(existingProject
.getLocation().toOSString()));
}
}
locationPathField.addModifyListener(new ModifyListener() {
/*
* (non-Javadoc)
*
* @see org.eclipse.swt.events.ModifyListener#modifyText(org.eclipse.swt.events.ModifyEvent)
*/
public void modifyText(ModifyEvent e) {
errorReporter.reportError(checkValidLocation(), false);
}
});
}
/**
* Create the file system selection area.
*
* @param composite
*/
private void createFileSystemSelection(Composite composite) {
// Always use the default if that is all there is.
if (FileSystemSupportRegistry.getInstance().hasOneFileSystem()) {
return;
}
new Label(composite, SWT.NONE);
fileSystemSelectionArea = new FileSystemSelectionArea();
fileSystemSelectionArea.createContents(composite);
}
/**
* Return the path we are going to display. If it is a file URI then remove
* the file prefix.
*
* @return String
*/
private String getDefaultPathDisplayString() {
URI defaultURI = null;
if (existingProject != null) {
defaultURI = existingProject.getLocationURI();
}
// Handle files specially. Assume a file if there is no project to query
if (defaultURI == null || defaultURI.getScheme().equals(FILE_SCHEME)) {
return Platform.getLocation().append(projectName).toOSString();
}
return defaultURI.toString();
}
/**
* Set the enablement state of the receiver.
*
* @param enabled
*/
private void setUserAreaEnabled(boolean enabled) {
locationLabel.setEnabled(enabled);
locationPathField.setEnabled(enabled);
browseButton.setEnabled(enabled);
if (fileSystemSelectionArea != null) {
fileSystemSelectionArea.setEnabled(enabled);
}
}
/**
* Return the browse button. Usually referenced in order to set the layout
* data for a dialog.
*
* @return Button
*/
public Button getBrowseButton() {
return browseButton;
}
private IDialogSettings getDialogSettings() {
IDialogSettings ideDialogSettings = IDEWorkbenchPlugin.getDefault().getDialogSettings();
IDialogSettings result = ideDialogSettings.getSection(getClass().getName());
if (result == null) {
result = ideDialogSettings.addNewSection(getClass().getName());
}
return result;
}
/**
* Open an appropriate directory browser
*/
private void handleLocationBrowseButtonPressed() {
String selectedDirectory = null;
String dirName = getPathFromLocationField();
if (!dirName.equals(IDEResourceInfoUtils.EMPTY_STRING)) {
IFileInfo info;
info = IDEResourceInfoUtils.getFileInfo(dirName);
if (info == null || !(info.exists()))
dirName = IDEResourceInfoUtils.EMPTY_STRING;
} else {
String value = getDialogSettings().get(SAVED_LOCATION_ATTR);
if (value != null) {
dirName = value;
}
}
FileSystemConfiguration config = getSelectedConfiguration();
if (config== null || config.equals(
FileSystemSupportRegistry.getInstance()
.getDefaultConfiguration())) {
DirectoryDialog dialog = new DirectoryDialog(locationPathField
.getShell(), SWT.SHEET);
dialog
.setMessage(IDEWorkbenchMessages.ProjectLocationSelectionDialog_directoryLabel);
dialog.setFilterPath(dirName);
selectedDirectory = dialog.open();
} else {
URI uri = getSelectedConfiguration().getContributor()
.browseFileSystem(dirName, browseButton.getShell());
if (uri != null)
selectedDirectory = uri.toString();
}
if (selectedDirectory != null) {
updateLocationField(selectedDirectory);
getDialogSettings().put(SAVED_LOCATION_ATTR, selectedDirectory);
}
}
/**
* Update the location field based on the selected path.
*
* @param selectedPath
*/
private void updateLocationField(String selectedPath) {
locationPathField.setText(TextProcessor.process(selectedPath));
}
/**
* Return the path on the location field.
*
* @return String
*/
private String getPathFromLocationField() {
URI fieldURI;
try {
fieldURI = new URI(locationPathField.getText());
} catch (URISyntaxException e) {
return locationPathField.getText();
}
return fieldURI.getPath();
}
/**
* Check if the entry in the widget location is valid. If it is valid return
* null. Otherwise return a string that indicates the problem.
*
* @return String
*/
public String checkValidLocation() {
String locationFieldContents = locationPathField.getText();
if (locationFieldContents.length() == 0) {
return IDEWorkbenchMessages.WizardNewProjectCreationPage_projectLocationEmpty;
}
URI newPath = getProjectLocationURI();
if (newPath == null) {
return IDEWorkbenchMessages.ProjectLocationSelectionDialog_locationError;
}
if (existingProject != null) {
URI projectPath = existingProject.getLocationURI();
if (projectPath != null && URIUtil.equals(projectPath, newPath)) {
return IDEWorkbenchMessages.ProjectLocationSelectionDialog_locationIsSelf;
}
}
if (!isDefault()) {
IStatus locationStatus = ResourcesPlugin.getWorkspace()
.validateProjectLocationURI(existingProject, newPath);
if (!locationStatus.isOK()) {
return locationStatus.getMessage();
}
}
return null;
}
/**
* Get the URI for the location field if possible.
*
* @return URI or null if it is not valid.
*/
public URI getProjectLocationURI() {
FileSystemConfiguration configuration = getSelectedConfiguration();
if (configuration == null) {
return null;
}
return configuration.getContributor().getURI(
locationPathField.getText());
}
/**
* Return the selected contributor
*
* @return FileSystemConfiguration or null if it cannot be
* determined.
*/
private FileSystemConfiguration getSelectedConfiguration() {
if (fileSystemSelectionArea == null) {
return FileSystemSupportRegistry.getInstance()
.getDefaultConfiguration();
}
return fileSystemSelectionArea.getSelectedConfiguration();
}
/**
* Set the text to the default or clear it if not using the defaults.
*
* @param newName
* the name of the project to use. If null use the
* existing project name.
*/
public void updateProjectName(String newName) {
projectName = newName;
if (isDefault()) {
locationPathField.setText(TextProcessor
.process(getDefaultPathDisplayString()));
}
}
/**
* Return the location for the project. If we are using defaults then return
* the workspace root so that core creates it with default values.
*
* @return String
*/
public String getProjectLocation() {
if (isDefault()) {
return Platform.getLocation().toOSString();
}
return locationPathField.getText();
}
/**
* Sets a value for a non default location.
* @param location
*/
public void setNonDefaultLocation(IPath location) {
useDefaultsButton.setSelection(false);
locationPathField.setText(TextProcessor.process(location.toOSString()));
String error = checkValidLocation();
errorReporter.reportError(error,
error != null &&
error.equals(
IDEWorkbenchMessages.WizardNewProjectCreationPage_projectLocationEmpty));
setUserAreaEnabled(true);
}
/**
* Sets the use defaults button on.
* @param b
*/
public void setUseDefault(boolean b) {
useDefaultsButton.setSelection(b);
setUserAreaEnabled(!b);
}
}
sdk/com.xilinx.sdk.ui.dialogs/src/com/xilinx/sdk/ui/dialogs/WizardNewProjectCreationPage.java 0000444 0036461 0000144 00000033652 11365672562 032451 0 ustar velusamy users /**
* Xilinx: Copy of WizardNewProjectCreationPage.java from org.eclipse.ui.dialogs.
* Modified to make projectNameField protected, so that derived classes can
* auto-suggest project names.
*/
package com.xilinx.sdk.ui.dialogs;
/*******************************************************************************
* Copyright (c) 2000, 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Jakub Jurkiewicz * This page may be used by clients as-is; it may be also be subclassed to suit. *
** Example usage: *
* mainPage = new WizardNewProjectCreationPage("basicNewProjectPage");
* mainPage.setTitle("Project");
* mainPage.setDescription("Create a new project resource.");
*
*
*/
@SuppressWarnings("restriction")
public class WizardNewProjectCreationPage extends WizardPage {
// initial value stores
private String initialProjectFieldValue;
// widgets
protected Text projectNameField;
private ProjectContentsLocationArea locationArea;
private WorkingSetGroup workingSetGroup;
// constants
private static final int SIZING_TEXT_FIELD_WIDTH = 250;
/**
* Creates a new project creation wizard page.
*
* @param pageName the name of this page
*/
public WizardNewProjectCreationPage(String pageName) {
super(pageName);
setPageComplete(false);
}
/**
* Creates a new project creation wizard page.
*
* @param pageName
* @param selection
* @param workingSetTypes
*
* @deprecated default placement of the working set group has been removed.
* If you wish to use the working set block please call
* {@link #createWorkingSetGroup(Composite, IStructuredSelection, String[])}
* in your overridden {@link #createControl(Composite)}
* implementation.
* @since 3.4
*/
public WizardNewProjectCreationPage(String pageName,
IStructuredSelection selection, String[] workingSetTypes) {
this(pageName);
}
/** (non-Javadoc)
* Method declared on IDialogPage.
*/
public void createControl(Composite parent) {
Composite composite = new Composite(parent, SWT.NULL);
initializeDialogUnits(parent);
PlatformUI.getWorkbench().getHelpSystem().setHelp(composite,
IIDEHelpContextIds.NEW_PROJECT_WIZARD_PAGE);
composite.setLayout(new GridLayout());
composite.setLayoutData(new GridData(GridData.FILL_BOTH));
createProjectNameGroup(composite);
locationArea = new ProjectContentsLocationArea(getErrorReporter(), composite);
if (initialProjectFieldValue != null) {
locationArea.updateProjectName(initialProjectFieldValue);
}
// Scale the button based on the rest of the dialog
setButtonLayoutData(locationArea.getBrowseButton());
setPageComplete(validatePage());
// Show description on opening
setErrorMessage(null);
setMessage(null);
setControl(composite);
Dialog.applyDialogFont(composite);
}
/**
* Create a working set group for this page. This method can only be called
* once.
*
* @param composite
* the composite in which to create the group
* @param selection
* the current workbench selection
* @param supportedWorkingSetTypes
* an array of working set type IDs that will restrict what types
* of working sets can be chosen in this group
* @return the created group. If this method has been called previously the
* original group will be returned.
* @since 3.4
*/
public WorkingSetGroup createWorkingSetGroup(Composite composite,
IStructuredSelection selection, String[] supportedWorkingSetTypes) {
if (workingSetGroup != null)
return workingSetGroup;
workingSetGroup = new WorkingSetGroup(composite, selection,
supportedWorkingSetTypes);
return workingSetGroup;
}
/**
* Get an error reporter for the receiver.
* @return IErrorMessageReporter
*/
private IErrorMessageReporter getErrorReporter() {
return new IErrorMessageReporter(){
/* (non-Javadoc)
* @see org.eclipse.ui.internal.ide.dialogs.ProjectContentsLocationArea.IErrorMessageReporter#reportError(java.lang.String)
*/
public void reportError(String errorMessage, boolean infoOnly) {
if (infoOnly) {
setMessage(errorMessage, IStatus.INFO);
setErrorMessage(null);
}
else
setErrorMessage(errorMessage);
boolean valid = errorMessage == null;
if(valid) {
valid = validatePage();
}
setPageComplete(valid);
}
};
}
/**
* Creates the project name specification controls.
*
* @param parent the parent composite
*/
private final void createProjectNameGroup(Composite parent) {
// project specification group
Composite projectGroup = new Composite(parent, SWT.NONE);
GridLayout layout = new GridLayout();
layout.numColumns = 2;
projectGroup.setLayout(layout);
projectGroup.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
// new project label
Label projectLabel = new Label(projectGroup, SWT.NONE);
projectLabel.setText(IDEWorkbenchMessages.WizardNewProjectCreationPage_nameLabel);
projectLabel.setFont(parent.getFont());
// new project name entry field
projectNameField = new Text(projectGroup, SWT.BORDER);
GridData data = new GridData(GridData.FILL_HORIZONTAL);
data.widthHint = SIZING_TEXT_FIELD_WIDTH;
projectNameField.setLayoutData(data);
projectNameField.setFont(parent.getFont());
// Set the initial value first before listener
// to avoid handling an event during the creation.
if (initialProjectFieldValue != null) {
projectNameField.setText(initialProjectFieldValue);
}
Listener nameModifyListener = new Listener() {
public void handleEvent(Event e) {
setLocationForSelection();
boolean valid = validatePage();
setPageComplete(valid);
}
};
projectNameField.addListener(SWT.Modify, nameModifyListener);
}
/**
* Returns the current project location path as entered by
* the user, or its anticipated initial value.
* Note that if the default has been returned the path
* in a project description used to create a project
* should not be set.
*
* @return the project location path or its anticipated initial value.
*/
public IPath getLocationPath() {
return new Path(locationArea.getProjectLocation());
}
/**
/**
* Returns the current project location URI as entered by
* the user, or null if a valid project location
* has not been entered.
*
* @return the project location URI, or null
* @since 3.2
*/
public URI getLocationURI() {
return locationArea.getProjectLocationURI();
}
/**
* Creates a project resource handle for the current project name field
* value. The project handle is created relative to the workspace root.
*
* This method does not create the project resource; this is the
* responsibility of IProject::create invoked by the new
* project resource wizard.
*
null
* if no project name is known
*/
public String getProjectName() {
if (projectNameField == null) {
return initialProjectFieldValue;
}
return getProjectNameFieldValue();
}
/**
* Returns the value of the project name field
* with leading and trailing spaces removed.
*
* @return the project name in the field
*/
private String getProjectNameFieldValue() {
if (projectNameField == null) {
return ""; //$NON-NLS-1$
}
return projectNameField.getText().trim();
}
/**
* Sets the initial project name that this page will use when
* created. The name is ignored if the createControl(Composite)
* method has already been called. Leading and trailing spaces
* in the name are ignored.
* Providing the name of an existing project will not necessarily
* cause the wizard to warn the user. Callers of this method
* should first check if the project name passed already exists
* in the workspace.
*
* @param name initial project name for this page
*
* @see IWorkspace#validateName(String, int)
*
*/
public void setInitialProjectName(String name) {
if (name == null) {
initialProjectFieldValue = null;
} else {
initialProjectFieldValue = name.trim();
if(locationArea != null) {
locationArea.updateProjectName(name.trim());
}
}
}
/**
* Set the location to the default location if we are set to useDefaults.
*/
void setLocationForSelection() {
locationArea.updateProjectName(getProjectNameFieldValue());
}
/**
* Returns whether this page's controls currently all contain valid
* values.
*
* @return true if all controls are valid, and
* false if at least one is invalid
*/
protected boolean validatePage() {
IWorkspace workspace = IDEWorkbenchPlugin.getPluginWorkspace();
String projectFieldContents = getProjectNameFieldValue();
if (projectFieldContents.equals("")) { //$NON-NLS-1$
setErrorMessage(null);
setMessage(IDEWorkbenchMessages.WizardNewProjectCreationPage_projectNameEmpty);
return false;
}
IStatus nameStatus = workspace.validateName(projectFieldContents,
IResource.PROJECT);
if (!nameStatus.isOK()) {
setErrorMessage(nameStatus.getMessage());
return false;
}
IProject handle = getProjectHandle();
if (handle.exists()) {
setErrorMessage(IDEWorkbenchMessages.WizardNewProjectCreationPage_projectExistsMessage);
return false;
}
IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(
getProjectNameFieldValue());
locationArea.setExistingProject(project);
String validLocationMessage = locationArea.checkValidLocation();
if (validLocationMessage != null) { // there is no destination location given
setErrorMessage(validLocationMessage);
return false;
}
setErrorMessage(null);
setMessage(null);
return true;
}
/*
* see @DialogPage.setVisible(boolean)
*/
public void setVisible(boolean visible) {
super.setVisible(visible);
if (visible) {
projectNameField.setFocus();
}
}
/**
* Returns the useDefaults.
* @return boolean
*/
public boolean useDefaults() {
return locationArea.isDefault();
}
/**
* Return the selected working sets, if any. If this page is not configured
* to interact with working sets this will be an empty array.
*
* @return the selected working sets
* @since 3.4
*/
public IWorkingSet[] getSelectedWorkingSets() {
return workingSetGroup == null ? new IWorkingSet[0] : workingSetGroup
.getSelectedWorkingSets();
}
}