Java tutorial
/******************************************************************************* * Copyright (c) 2006, 2010 EclipseGuru 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: * EclipseGuru - initial API and implementation *******************************************************************************/ package org.eclipseguru.gwt.ui.properties; import org.eclipseguru.gwt.core.GwtCore; import org.eclipseguru.gwt.core.GwtModule; import org.eclipseguru.gwt.core.GwtProject; import org.eclipseguru.gwt.core.GwtUtil; import org.eclipseguru.gwt.core.launch.GwtLaunchConstants; import org.eclipseguru.gwt.core.preferences.GwtCorePreferenceConstants; import org.eclipse.core.resources.IContainer; import org.eclipse.core.resources.IFolder; import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.IResource; import org.eclipse.core.resources.IWorkspaceRoot; import org.eclipse.core.resources.IncrementalProjectBuilder; import org.eclipse.core.resources.ResourcesPlugin; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IAdaptable; import org.eclipse.core.runtime.IPath; import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.core.runtime.IStatus; import org.eclipse.core.runtime.OperationCanceledException; import org.eclipse.core.runtime.Path; import org.eclipse.core.runtime.Status; import org.eclipse.core.runtime.SubProgressMonitor; import org.eclipse.core.runtime.jobs.Job; import org.eclipse.core.runtime.preferences.IEclipsePreferences; import org.eclipse.debug.ui.StringVariableSelectionDialog; import org.eclipse.jdt.internal.corext.util.Messages; import org.eclipse.jdt.internal.ui.dialogs.StatusInfo; import org.eclipse.jdt.internal.ui.dialogs.StatusUtil; import org.eclipse.jdt.internal.ui.wizards.IStatusChangeListener; import org.eclipse.jdt.internal.ui.wizards.NewWizardMessages; import org.eclipse.jdt.internal.ui.wizards.TypedElementSelectionValidator; import org.eclipse.jdt.internal.ui.wizards.TypedViewerFilter; import org.eclipse.jdt.internal.ui.wizards.buildpaths.FolderSelectionDialog; import org.eclipse.jdt.internal.ui.wizards.dialogfields.ComboDialogField; import org.eclipse.jdt.internal.ui.wizards.dialogfields.DialogField; import org.eclipse.jdt.internal.ui.wizards.dialogfields.IDialogFieldListener; import org.eclipse.jdt.internal.ui.wizards.dialogfields.IListAdapter; import org.eclipse.jdt.internal.ui.wizards.dialogfields.IStringButtonAdapter; import org.eclipse.jdt.internal.ui.wizards.dialogfields.LayoutUtil; import org.eclipse.jdt.internal.ui.wizards.dialogfields.ListDialogField; import org.eclipse.jdt.internal.ui.wizards.dialogfields.SelectionButtonDialogField; import org.eclipse.jdt.internal.ui.wizards.dialogfields.StringButtonDialogField; import org.eclipse.jdt.internal.ui.wizards.dialogfields.StringDialogField; import org.eclipse.jface.dialogs.Dialog; import org.eclipse.jface.dialogs.IDialogConstants; import org.eclipse.jface.dialogs.MessageDialog; import org.eclipse.jface.viewers.ILabelProvider; import org.eclipse.jface.viewers.ITreeContentProvider; import org.eclipse.jface.viewers.ViewerFilter; import org.eclipse.jface.window.Window; import org.eclipse.osgi.util.NLS; import org.eclipse.swt.SWT; import org.eclipse.swt.layout.GridData; import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; import org.eclipse.swt.widgets.Display; import org.eclipse.swt.widgets.Group; import org.eclipse.ui.IWorkbenchPropertyPage; import org.eclipse.ui.dialogs.ISelectionStatusValidator; import org.eclipse.ui.dialogs.PropertyPage; import org.eclipse.ui.model.WorkbenchContentProvider; import org.eclipse.ui.model.WorkbenchLabelProvider; import org.eclipse.ui.views.navigator.ResourceComparator; import org.osgi.service.prefs.BackingStoreException; import java.util.ArrayList; import java.util.List; /** * Properties page for projects with GWT nature. */ public class ProjectProperties extends PropertyPage implements IWorkbenchPropertyPage, IStatusChangeListener { private final class DeploymentPathDialogFieldAdapter implements IDialogFieldListener { public void dialogFieldChanged(final DialogField field) { deploymentPathDialogFieldChanged(field); } } private final class HostedModeDialogFieldAdapter implements IDialogFieldListener { public void dialogFieldChanged(final DialogField field) { hostedModeDialogFieldChanged(field); } } private class JavascriptStyleDialogFieldAdapter implements IDialogFieldListener { // ---------- IDialogFieldListener -------- public void dialogFieldChanged(final DialogField field) { javascriptStyleDialogFieldChanged(field); } } private final class ModulesListDialogFieldAdapter implements IListAdapter { public void customButtonPressed(final ListDialogField field, final int index) { if (field != modulesListDialogField) { return; } switch (index) { case IDX_BUTTON_ML_ADD: break; case IDX_BUTTON_ML_REMOVE: break; } updateButtonEnabledState(); } public void doubleClicked(final ListDialogField field) { // nothing } public void selectionChanged(final ListDialogField field) { updateButtonEnabledState(); } } private class OutputLocationDialogFieldAdapter implements IStringButtonAdapter, IDialogFieldListener { // -------- IStringButtonAdapter -------- public void changeControlPressed(final DialogField field) { outputChangeControlPressed(field); } // ---------- IDialogFieldListener -------- public void dialogFieldChanged(final DialogField field) { outputDialogFieldChanged(field); } } private class VMArgsDialogFieldAdapter implements IStringButtonAdapter, IDialogFieldListener { // -------- IStringButtonAdapter -------- public void changeControlPressed(final DialogField field) { vmArgsChangeControlPressed(field); } // ---------- IDialogFieldListener -------- public void dialogFieldChanged(final DialogField field) { vmArgsDialogFieldChanged(field); } } private static final int IDX_BUTTON_ML_ADD = 0; private static final int IDX_BUTTON_ML_REMOVE = 1; private static final String[] BUTTONS_ML = new String[] { "Add...", "Remove" }; private SelectionButtonDialogField hostedModeDialogField; private ListDialogField modulesListDialogField; private StringButtonDialogField outputLocationDialogField; private StringDialogField deploymentPathDialogField; private StringButtonDialogField vmArgsDialogField; private ComboDialogField javascriptStyleDialogField; private GwtProject currentProject; private boolean isHosted; private IPath outputLocationPath; private IPath deploymentPath; private String javascriptStyle = ""; private String vmArgs = ""; private final StatusInfo outputLocationStatus = new StatusInfo(); private final StatusInfo deploymentPathStatus = new StatusInfo(); private final StatusInfo javascriptStyleStatus = new StatusInfo(); private final StatusInfo vmArgsStatus = new StatusInfo(); private boolean isRebuildNecessary; private SelectionButtonDialogField autoBuildModulesDialogField; private IContainer chooseContainer() { final IWorkspaceRoot workspaceRoot = ResourcesPlugin.getWorkspace().getRoot(); final Class[] acceptedClasses = new Class[] { IProject.class, IFolder.class }; final ISelectionStatusValidator validator = new TypedElementSelectionValidator(acceptedClasses, false); final IProject[] allProjects = workspaceRoot.getProjects(); final List<IProject> rejectedElements = new ArrayList<IProject>(allProjects.length); final GwtProject currProject = getProject(); for (int i = 0; i < allProjects.length; i++) { if (!allProjects[i].equals(currProject)) { rejectedElements.add(allProjects[i]); } } final ViewerFilter filter = new TypedViewerFilter(acceptedClasses, rejectedElements.toArray()); final ILabelProvider lp = new WorkbenchLabelProvider(); final ITreeContentProvider cp = new WorkbenchContentProvider(); IResource initSelection = null; if (outputLocationPath != null) { initSelection = currProject.getProjectResource().findMember(outputLocationPath); } final FolderSelectionDialog dialog = new FolderSelectionDialog(getShell(), lp, cp); dialog.setTitle(NewWizardMessages.BuildPathsBlock_ChooseOutputFolderDialog_title); dialog.setValidator(validator); dialog.setMessage(NewWizardMessages.BuildPathsBlock_ChooseOutputFolderDialog_description); dialog.addFilter(filter); dialog.setInput(workspaceRoot); dialog.setInitialSelection(initSelection); dialog.setComparator(new ResourceComparator(ResourceComparator.NAME)); if (dialog.open() == Window.OK) { return (IContainer) dialog.getFirstResult(); } return null; } @Override protected Control createContents(final Composite parent) { final Composite result = new Composite(parent, SWT.NONE); result.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true)); // the layout final GridLayout layout = new GridLayout(); result.setLayout(layout); // setup dialog fields createDialogFields(); initDialogFields(); updateButtonEnabledState(); // create controls based on assigned facets final Group deployment = new Group(result, SWT.NONE); deployment.setText("Deployment"); deployment.setLayoutData(new GridData(SWT.FILL, SWT.NONE, true, false)); //final IProject project = getProject().getProjectResource(); LayoutUtil.doDefaultLayout(deployment, new DialogField[] { outputLocationDialogField, autoBuildModulesDialogField, javascriptStyleDialogField, vmArgsDialogField }, false, 5, 5); LayoutUtil.setHorizontalGrabbing(outputLocationDialogField.getTextControl(deployment)); Dialog.applyDialogFont(result); return result; } /** * Creates the dialog fields */ private void createDialogFields() { hostedModeDialogField = new SelectionButtonDialogField(SWT.CHECK); hostedModeDialogField.setLabelText("Deploy using GWT's hosted mode."); hostedModeDialogField.setDialogFieldListener(new HostedModeDialogFieldAdapter()); final ModulesListDialogFieldAdapter moduleListAdapter = new ModulesListDialogFieldAdapter(); modulesListDialogField = new ListDialogField(moduleListAdapter, BUTTONS_ML, new WorkbenchLabelProvider()); modulesListDialogField .setLabelText("Additional GWT modules from projects included via J2EE Module Dependencies:"); final OutputLocationDialogFieldAdapter adapter = new OutputLocationDialogFieldAdapter(); outputLocationDialogField = new StringButtonDialogField(adapter); outputLocationDialogField.setButtonLabel("Browse..."); outputLocationDialogField.setDialogFieldListener(adapter); outputLocationDialogField.setLabelText("Output folder:"); autoBuildModulesDialogField = new SelectionButtonDialogField(SWT.CHECK); autoBuildModulesDialogField.setLabelText("Compile modules when project is built automatically"); deploymentPathDialogField = new StringDialogField(); deploymentPathDialogField.setDialogFieldListener(new DeploymentPathDialogFieldAdapter()); deploymentPathDialogField.setLabelText("Deployment path:"); javascriptStyleDialogField = new ComboDialogField(SWT.READ_ONLY); javascriptStyleDialogField.setLabelText("Compiler JavaScript Style:"); javascriptStyleDialogField.setItems(GwtLaunchConstants.JAVSCRIPT_STYLES); javascriptStyleDialogField.setDialogFieldListener(new JavascriptStyleDialogFieldAdapter()); vmArgsDialogField = new StringButtonDialogField(new VMArgsDialogFieldAdapter()); vmArgsDialogField.setLabelText("Compiler VM Args:"); vmArgsDialogField.setButtonLabel("Variables..."); vmArgsDialogField.setDialogFieldListener(adapter); } private void deploymentPathDialogFieldChanged(final DialogField field) { if (field == deploymentPathDialogField) { updateDeploymentLocationStatus(); isRebuildNecessary = true; } doStatusLineUpdate(); } /** * Schedules a rebuild. */ private void doFullBuild() { final Job buildJob = new Job("Building Projects...") { /* * (non-Javadoc) * @see * org.eclipse.core.runtime.jobs.Job#belongsTo(java.lang.Object) */ @Override public boolean belongsTo(final Object family) { return ResourcesPlugin.FAMILY_MANUAL_BUILD == family; } //$NON-NLS-1$ /* * (non-Javadoc) * @see * org.eclipse.core.runtime.jobs.Job#run(org.eclipse.core.runtime * .IProgressMonitor) */ @Override protected IStatus run(final IProgressMonitor monitor) { try { IProject[] projects = null; if (getProject() == null) { projects = ResourcesPlugin.getWorkspace().getRoot().getProjects(); } else { projects = new IProject[] { getProject().getProjectResource() }; } monitor.beginTask("", projects.length * 2); //$NON-NLS-1$ for (final IProject projectToBuild : projects) { if (!projectToBuild.isOpen()) { continue; } if (GwtProject.hasGwtNature(projectToBuild)) { projectToBuild.build(IncrementalProjectBuilder.FULL_BUILD, GwtCore.BUILDER_ID, null, new SubProgressMonitor(monitor, 1)); } else { monitor.worked(1); } } } catch (final CoreException e) { return e.getStatus(); } catch (final OperationCanceledException e) { return Status.CANCEL_STATUS; } finally { monitor.done(); } return Status.OK_STATUS; } }; buildJob.setRule(ResourcesPlugin.getWorkspace().getRuleFactory().buildRule()); buildJob.setUser(true); buildJob.schedule(); isRebuildNecessary = false; } private void doStatusLineUpdate() { if (Display.getCurrent() != null) { final IStatus res = findMostSevereStatus(); statusChanged(res); } } private IStatus findMostSevereStatus() { return StatusUtil.getMostSevere(new IStatus[] { outputLocationStatus, deploymentPathStatus, vmArgsStatus }); } /** * Returns the current compiler Javascript style. * * @return the compiler Javascript style */ public String getCompilerJavascriptStyle() { return javascriptStyleDialogField.getText(); } /** * Returns the current compiler VM arguments which will be added to the GWT * compiler Java runner as additional VM arguments. * * @return the VM arguments for the GWT compiler */ public String getCompilerVmArgs() { return vmArgsDialogField.getText(); } /** * @return Returns the current deployment path. Note that the path returned * must not be valid. */ public IPath getDeploymentPath() { return new Path(deploymentPathDialogField.getText()).makeAbsolute(); } /** * @return Returns the current output location. Note that the path returned * must not be valid. */ public IPath getOutputLocation() { return new Path(outputLocationDialogField.getText()).makeAbsolute(); } /** * Returns the project. * * @return the project */ public GwtProject getProject() { if (null == currentProject) { final IAdaptable adaptable = getElement(); if (adaptable instanceof IProject) { currentProject = GwtCore.create((IProject) adaptable); } else { currentProject = GwtCore.create((IProject) adaptable.getAdapter(IProject.class)); } if (null == currentProject) { throw new IllegalStateException("Project not found!"); } } return currentProject; } private void hostedModeDialogFieldChanged(final DialogField field) { if (field == hostedModeDialogField) { isHosted = hostedModeDialogField.isSelected(); isRebuildNecessary = true; } } /** * Initializes dialog fields with data from preferences */ private void initDialogFields() { final GwtProject project = getProject(); // hosted mode isHosted = GwtUtil.isHostedDeploymentMode(project); hostedModeDialogField.setSelection(isHosted); // output location outputLocationPath = GwtUtil.getOutputLocation(project); outputLocationDialogField.setText(outputLocationPath.makeRelative().toString()); outputLocationDialogField.enableButton(getProject().exists()); // automatic compile autoBuildModulesDialogField.setSelection(GwtUtil.isAutoBuildModules(project)); // included modules final GwtModule[] includedModules = project.getIncludedModules(); for (final GwtModule module : includedModules) { modulesListDialogField.addElement(module); } // deployment path deploymentPath = GwtUtil.getDeploymentPath(project); deploymentPathDialogField.setText(deploymentPath.makeAbsolute().toString()); // Javascript style javascriptStyle = GwtUtil.getCompilerJavascriptStyle(project); javascriptStyleDialogField.selectItem(javascriptStyle); // VM args vmArgs = GwtUtil.getCompilerVmArgs(project); vmArgsDialogField.setText(vmArgs); // no rebuild after fresh initialization isRebuildNecessary = false; } void javascriptStyleDialogFieldChanged(final DialogField field) { if (field == javascriptStyleDialogField) { updateJavascriptStyleStatus(); isRebuildNecessary = true; } doStatusLineUpdate(); } private void outputChangeControlPressed(final DialogField field) { if (field == outputLocationDialogField) { final IContainer container = chooseContainer(); if (container != null) { outputLocationDialogField.setText(container.getProjectRelativePath().makeRelative().toString()); } } } private void outputDialogFieldChanged(final DialogField field) { if (field == outputLocationDialogField) { updateOutputLocationStatus(); isRebuildNecessary = true; } doStatusLineUpdate(); } /* * (non-Javadoc) * @see org.eclipse.jface.preference.PreferencePage#performOk() */ @Override public boolean performOk() { final GwtProject project = getProject(); boolean build = false; if (isRebuildNecessary) { final MessageDialog dialog = new MessageDialog(getShell(), "Build Needed", null, "The deployment settings have changed. The project needs to be rebuilt for the changes to take effect. Do you want to rebuild now?", MessageDialog.QUESTION, new String[] { IDialogConstants.YES_LABEL, IDialogConstants.NO_LABEL, IDialogConstants.CANCEL_LABEL }, 2); switch (dialog.open()) { case 2: return false; case Window.OK: build = true; break; } } final IEclipsePreferences projectPreferences = project.getProjectPreferences(); if (null == projectPreferences) { return false; } // hosted mode projectPreferences.putBoolean(GwtCorePreferenceConstants.PREF_HOSTED_DEPLOY_MODE, isHosted); // output location if (project.getProjectResource().getFullPath().isPrefixOf(outputLocationPath)) { outputLocationPath = outputLocationPath.removeFirstSegments(1); } projectPreferences.put(GwtCorePreferenceConstants.PREF_OUTPUT_LOCATION, outputLocationPath.makeRelative().toString()); // module auto build final boolean autoBuildModules = autoBuildModulesDialogField.isSelected(); projectPreferences.putBoolean(GwtCorePreferenceConstants.PREF_AUTO_BUILD_MODULES, autoBuildModules); // modules list project.setIncludedModules(modulesListDialogField.getElements()); // deployment path projectPreferences.put(GwtCorePreferenceConstants.PREF_DEPLOYMENT_PATH, deploymentPath.makeAbsolute().toString()); // VM arguments final String compilerVmArgs = getCompilerVmArgs(); if ((null != compilerVmArgs) && (compilerVmArgs.trim().length() > 0)) { projectPreferences.put(GwtCorePreferenceConstants.PREF_COMPILER_VM_ARGS, compilerVmArgs); } else { projectPreferences.remove(GwtCorePreferenceConstants.PREF_COMPILER_VM_ARGS); } // style projectPreferences.put(GwtCorePreferenceConstants.PREF_COMPILER_JAVASCRIPT_STYLE, getCompilerJavascriptStyle()); // flush changes try { projectPreferences.flush(); } catch (final BackingStoreException e) { // problem with pref store - quietly ignore } // build if (build) { doFullBuild(); } return true; } /* * (non-Javadoc) * @see * org.eclipse.jdt.internal.ui.wizards.IStatusChangeListener#statusChanged * (org.eclipse.core.runtime.IStatus) */ public void statusChanged(final IStatus status) { setValid(!status.matches(IStatus.ERROR)); StatusUtil.applyToStatusLine(this, status); } private void updateButtonEnabledState() { final boolean itemSelected = modulesListDialogField.getSelectedElements().size() > 0; modulesListDialogField.enableButton(IDX_BUTTON_ML_REMOVE, itemSelected); } private void updateDeploymentLocationStatus() { deploymentPath = null; final String text = deploymentPathDialogField.getText(); if (text.startsWith(" ") || text.endsWith(" ")) { deploymentPathStatus.setError("The deployment path cannot start or end with a white space."); return; } deploymentPath = getDeploymentPath(); deploymentPathStatus.setOK(); } private void updateJavascriptStyleStatus() { javascriptStyle = ""; // TODO: validate JavaScript style // ... javascriptStyle = getCompilerJavascriptStyle(); javascriptStyleStatus.setOK(); } private void updateOutputLocationStatus() { outputLocationPath = null; final String text = outputLocationDialogField.getText(); if ("".equals(text)) { outputLocationStatus.setError(NewWizardMessages.BuildPathsBlock_error_EnterBuildPath); return; } outputLocationPath = getOutputLocation(); final IResource res = getProject().getProjectResource().findMember(outputLocationPath); if (res != null) { // if exists, must be a folder or project if (res.getType() == IResource.FILE) { outputLocationStatus.setError(NLS.bind(NewWizardMessages.BuildPathsBlock_error_InvalidBuildPath, outputLocationPath.toString())); return; } // must not be on classpath if ((res.getType() == IResource.FOLDER) && getProject().getJavaProject().isOnClasspath(res)) { outputLocationStatus.setError("Build output folder must be outside build path."); return; } } outputLocationStatus.setOK(); String pathStr = outputLocationDialogField.getText(); final Path outputPath = (new Path(pathStr)); pathStr = outputPath.lastSegment(); if (null != pathStr) { if (pathStr.equals(".settings") && (outputPath.segmentCount() == 2)) { outputLocationStatus.setWarning(NewWizardMessages.OutputLocation_SettingsAsLocation); } if ((pathStr.charAt(0) == '.') && (pathStr.length() > 1)) { outputLocationStatus .setWarning(Messages.format(NewWizardMessages.OutputLocation_DotAsLocation, pathStr)); } } } private void updateVmArgsStatus() { vmArgs = ""; // TODO: validate VM args (if required) // ... vmArgs = getCompilerVmArgs(); vmArgsStatus.setOK(); } private void vmArgsChangeControlPressed(final DialogField field) { if (field == vmArgsDialogField) { final StringVariableSelectionDialog dialog = new StringVariableSelectionDialog(getShell()); dialog.open(); final String variableExpression = dialog.getVariableExpression(); if (variableExpression == null) { return; } final int startSel = vmArgsDialogField.getTextControl(null).getSelection().x; final int lenSel = vmArgsDialogField.getTextControl(null).getSelectionCount(); final String currentText = getCompilerVmArgs(); String newText = ""; if (startSel > 0) { newText += currentText.substring(0, startSel); } newText += variableExpression + currentText.substring(startSel + lenSel); vmArgsDialogField.setText(newText); } } void vmArgsDialogFieldChanged(final DialogField field) { if (field == vmArgsDialogField) { updateVmArgsStatus(); isRebuildNecessary = true; } doStatusLineUpdate(); } }