| /******************************************************************************* |
| * Copyright (c) 2000, 2015 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: |
| * Frits Jalvingh <jal@etc.to> - Contribution for Bug 459831 - [launching] Support attaching external annotations to a JRE container |
| *******************************************************************************/ |
| package org.eclipse.jdt.internal.ui.wizards.buildpaths; |
| |
| import java.io.File; |
| import java.lang.reflect.InvocationTargetException; |
| import java.util.List; |
| |
| 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.DirectoryDialog; |
| import org.eclipse.swt.widgets.FileDialog; |
| import org.eclipse.swt.widgets.Label; |
| import org.eclipse.swt.widgets.Shell; |
| |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.core.runtime.IPath; |
| import org.eclipse.core.runtime.IProgressMonitor; |
| import org.eclipse.core.runtime.IStatus; |
| import org.eclipse.core.runtime.Path; |
| |
| import org.eclipse.core.resources.IResource; |
| import org.eclipse.core.resources.IWorkspace; |
| import org.eclipse.core.resources.IWorkspaceRoot; |
| import org.eclipse.core.resources.ResourcesPlugin; |
| |
| import org.eclipse.jface.dialogs.Dialog; |
| import org.eclipse.jface.layout.PixelConverter; |
| import org.eclipse.jface.operation.IRunnableWithProgress; |
| 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.ui.PlatformUI; |
| import org.eclipse.ui.model.WorkbenchContentProvider; |
| import org.eclipse.ui.model.WorkbenchLabelProvider; |
| |
| import org.eclipse.jdt.core.IClasspathAttribute; |
| import org.eclipse.jdt.core.IClasspathEntry; |
| import org.eclipse.jdt.core.IJavaProject; |
| import org.eclipse.jdt.core.JavaCore; |
| |
| import org.eclipse.jdt.internal.corext.util.Messages; |
| |
| import org.eclipse.jdt.internal.ui.IJavaHelpContextIds; |
| import org.eclipse.jdt.internal.ui.JavaPlugin; |
| import org.eclipse.jdt.internal.ui.dialogs.StatusInfo; |
| import org.eclipse.jdt.internal.ui.viewsupport.BasicElementLabels; |
| import org.eclipse.jdt.internal.ui.wizards.IStatusChangeListener; |
| import org.eclipse.jdt.internal.ui.wizards.NewWizardMessages; |
| 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.IStringButtonAdapter; |
| import org.eclipse.jdt.internal.ui.wizards.dialogfields.LayoutUtil; |
| import org.eclipse.jdt.internal.ui.wizards.dialogfields.SelectionButtonDialogField; |
| import org.eclipse.jdt.internal.ui.wizards.dialogfields.StringButtonDialogField; |
| |
| |
| /** |
| * UI to set the External Annotations path. Same implementation for both setting attachments for |
| * libraries from variable entries and for normal (internal or external) jar. |
| */ |
| public class ExternalAnnotationsAttachmentBlock { |
| |
| private final IStatusChangeListener fContext; |
| |
| private StringButtonDialogField fWorkspaceFileNameField; |
| private StringButtonDialogField fExternalFileNameField; |
| private SelectionButtonDialogField fExternalFolderButton; |
| private SelectionButtonDialogField fExternalRadio, fWorkspaceRadio; |
| |
| private IStatus fWorkspaceNameStatus; |
| private IStatus fExternalNameStatus; |
| |
| private final IWorkspaceRoot fWorkspaceRoot; |
| |
| private Control fSWTWidget; |
| |
| private final IPath fEntry; |
| |
| /** |
| * @param context listeners for status updates |
| * @param entry The entry to edit |
| */ |
| public ExternalAnnotationsAttachmentBlock(IStatusChangeListener context, IPath entry) { |
| fContext= context; |
| fEntry= entry == null ? Path.EMPTY : entry; |
| |
| fWorkspaceRoot= ResourcesPlugin.getWorkspace().getRoot(); |
| |
| fWorkspaceNameStatus= new StatusInfo(); |
| fExternalNameStatus= new StatusInfo(); |
| |
| AnnotationsAttachmentAdapter adapter= new AnnotationsAttachmentAdapter(); |
| |
| // create the dialog fields (no widgets yet) |
| fWorkspaceRadio= new SelectionButtonDialogField(SWT.RADIO); |
| fWorkspaceRadio.setDialogFieldListener(adapter); |
| fWorkspaceRadio.setLabelText(NewWizardMessages.AnnotationsAttachmentBlock_workspace_radiolabel); |
| |
| fWorkspaceFileNameField= new StringButtonDialogField(adapter); |
| fWorkspaceFileNameField.setDialogFieldListener(adapter); |
| fWorkspaceFileNameField.setLabelText(NewWizardMessages.AnnotationsAttachmentBlock_filename_workspace_label); |
| fWorkspaceFileNameField.setButtonLabel(NewWizardMessages.AnnotationsAttachmentBlock_filename_workspace_browse); |
| |
| fExternalRadio= new SelectionButtonDialogField(SWT.RADIO); |
| fExternalRadio.setDialogFieldListener(adapter); |
| fExternalRadio.setLabelText(NewWizardMessages.AnnotationsAttachmentBlock_external_radiolabel); |
| |
| fExternalFileNameField= new StringButtonDialogField(adapter); |
| fExternalFileNameField.setDialogFieldListener(adapter); |
| fExternalFileNameField.setLabelText(NewWizardMessages.AnnotationsAttachmentBlock_filename_external_label); |
| fExternalFileNameField.setButtonLabel(NewWizardMessages.AnnotationsAttachmentBlock_filename_externalfile_button); |
| |
| fExternalFolderButton= new SelectionButtonDialogField(SWT.PUSH); |
| fExternalFolderButton.setDialogFieldListener(adapter); |
| fExternalFolderButton.setLabelText(NewWizardMessages.AnnotationsAttachmentBlock_filename_externalfolder_button); |
| |
| setDefaults(); |
| } |
| |
| public void setDefaults() { |
| IPath annotationsAttachmentPath= fEntry; |
| String path= annotationsAttachmentPath == null ? null : annotationsAttachmentPath.toPortableString(); |
| |
| if (isWorkspacePath(annotationsAttachmentPath)) { |
| fWorkspaceRadio.setSelection(true); |
| fWorkspaceFileNameField.setText(path); |
| } else if (path != null && path.length() != 0) { |
| fExternalRadio.setSelection(true); |
| fExternalFileNameField.setText(path); |
| } else { |
| fWorkspaceRadio.setSelection(true); |
| fExternalRadio.setSelection(false); |
| } |
| } |
| |
| private boolean isWorkspacePath(IPath path) { |
| if (path == null || path.getDevice() != null) |
| return false; |
| IWorkspace workspace= ResourcesPlugin.getWorkspace(); |
| if (workspace == null) |
| return false; |
| return workspace.getRoot().findMember(path) != null; |
| } |
| |
| /** |
| * Gets the source attachment path chosen by the user |
| * @return the source attachment path |
| */ |
| public IPath getAnnotationsPath() { |
| return (getFilePath().segmentCount() == 0) ? null : getFilePath(); |
| } |
| |
| /** |
| * Creates the control |
| * @param parent the parent |
| * @return the created control |
| */ |
| public Control createControl(Composite parent) { |
| PixelConverter converter= new PixelConverter(parent); |
| |
| fSWTWidget= parent; |
| |
| Composite composite= new Composite(parent, SWT.NONE); |
| |
| GridLayout layout= new GridLayout(); |
| layout.marginHeight= 0; |
| layout.marginWidth= 0; |
| layout.numColumns= 4; |
| composite.setLayout(layout); |
| |
| |
| int widthHint= converter.convertWidthInCharsToPixels(60); |
| |
| GridData gd= new GridData(GridData.FILL, GridData.BEGINNING, false, false, 3, 1); |
| gd.widthHint= converter.convertWidthInCharsToPixels(50); |
| |
| Label message= new Label(composite, SWT.LEFT + SWT.WRAP); |
| message.setLayoutData(gd); |
| message.setText(NewWizardMessages.AnnotationsAttachmentBlock_message); |
| |
| fWorkspaceRadio.doFillIntoGrid(composite, 4); |
| |
| fWorkspaceFileNameField.doFillIntoGrid(composite, 4); |
| LayoutUtil.setWidthHint(fWorkspaceFileNameField.getTextControl(null), widthHint); |
| LayoutUtil.setHorizontalGrabbing(fWorkspaceFileNameField.getTextControl(null)); |
| |
| DialogField.createEmptySpace(composite, 4); |
| |
| fExternalRadio.doFillIntoGrid(composite, 4); |
| fExternalFileNameField.doFillIntoGrid(composite, 4); |
| LayoutUtil.setWidthHint(fExternalFileNameField.getTextControl(null), widthHint); |
| LayoutUtil.setHorizontalGrabbing(fExternalFileNameField.getTextControl(null)); |
| |
| DialogField.createEmptySpace(composite, 1); |
| |
| fExternalFolderButton.doFillIntoGrid(composite, 1); |
| |
| LayoutUtil.setHorizontalIndent(fWorkspaceFileNameField.getLabelControl(null)); |
| LayoutUtil.setHorizontalIndent(fExternalFileNameField.getLabelControl(null)); |
| |
| fWorkspaceRadio.attachDialogField(fWorkspaceFileNameField); |
| fExternalRadio.attachDialogFields(new DialogField[] { fExternalFileNameField, fExternalFolderButton }); |
| |
| Dialog.applyDialogFont(composite); |
| |
| PlatformUI.getWorkbench().getHelpSystem().setHelp(composite, IJavaHelpContextIds.EXTERNAL_ANNOTATIONS_ATTACHMENT_DIALOG); |
| return composite; |
| } |
| |
| |
| private class AnnotationsAttachmentAdapter implements IStringButtonAdapter, IDialogFieldListener { |
| |
| // -------- IStringButtonAdapter -------- |
| public void changeControlPressed(DialogField field) { |
| attachmentChangeControlPressed(field); |
| } |
| |
| // ---------- IDialogFieldListener -------- |
| public void dialogFieldChanged(DialogField field) { |
| attachmentDialogFieldChanged(field); |
| } |
| } |
| |
| private void attachmentChangeControlPressed(DialogField field) { |
| if (field == fWorkspaceFileNameField) { |
| IPath jarFilePath= chooseInternal(); |
| if (jarFilePath != null) { |
| fWorkspaceFileNameField.setText(jarFilePath.toString()); |
| } |
| } else if (field == fExternalFileNameField) { |
| IPath jarFilePath= chooseExtJarFile(); |
| if (jarFilePath != null) { |
| fExternalFileNameField.setText(jarFilePath.toString()); |
| } |
| } |
| } |
| |
| // ---------- IDialogFieldListener -------- |
| |
| private void attachmentDialogFieldChanged(DialogField field) { |
| if (field == fWorkspaceFileNameField) { |
| fWorkspaceNameStatus= updateFileNameStatus(fWorkspaceFileNameField); |
| } else if (field == fExternalFileNameField) { |
| fExternalNameStatus= updateFileNameStatus(fExternalFileNameField); |
| } else if (field == fExternalFolderButton) { |
| IPath folderPath= chooseExtFolder(); |
| if (folderPath != null) { |
| fExternalFileNameField.setText(folderPath.toString()); |
| } |
| return; |
| } |
| doStatusLineUpdate(); |
| } |
| |
| private void doStatusLineUpdate() { |
| IStatus status; |
| boolean isWorkSpace= fWorkspaceRadio.isSelected(); |
| if (isWorkSpace) { |
| fWorkspaceFileNameField.enableButton(canBrowseFileName()); |
| status= fWorkspaceNameStatus; |
| } else { |
| fExternalFileNameField.enableButton(canBrowseFileName()); |
| status= fExternalNameStatus; |
| } |
| fContext.statusChanged(status); |
| } |
| |
| private boolean canBrowseFileName() { // FIXME remove |
| return true; |
| } |
| |
| private IStatus updateFileNameStatus(StringButtonDialogField field) { |
| StatusInfo status= new StatusInfo(); |
| |
| String fileName= field.getText(); |
| if (fileName.length() == 0) { |
| // no external annotations file defined |
| return status; |
| } else { |
| if (!Path.EMPTY.isValidPath(fileName)) { |
| status.setError(NewWizardMessages.AnnotationsAttachmentBlock_filename_error_notvalid); |
| return status; |
| } |
| IPath filePath= Path.fromOSString(fileName); |
| IPath resolvedPath; |
| File file= filePath.toFile(); |
| IResource res= fWorkspaceRoot.findMember(filePath); |
| boolean exists; |
| if (res != null) { |
| IPath location= res.getLocation(); |
| if (location != null) { |
| exists= location.toFile().exists(); |
| } else { |
| exists= res.exists(); |
| } |
| } else { |
| exists= file.exists(); |
| } |
| if (!exists) { |
| String message= Messages.format(NewWizardMessages.AnnotationsAttachmentBlock_filename_error_filenotexists, BasicElementLabels.getPathLabel(filePath, false)); |
| status.setError(message); |
| return status; |
| } |
| if (!filePath.isAbsolute()) { |
| String message= Messages.format(NewWizardMessages.AnnotationsAttachmentBlock_filename_error_notabsolute, BasicElementLabels.getPathLabel(filePath, false)); |
| status.setError(message); |
| return status; |
| } |
| } |
| return status; |
| } |
| |
| private IPath getFilePath() { |
| String filePath= fWorkspaceRadio.isSelected() ? fWorkspaceFileNameField.getText() : fExternalFileNameField.getText(); |
| return Path.fromOSString(filePath).makeAbsolute(); |
| } |
| |
| /* |
| * Opens a dialog to choose a jar from the file system. |
| */ |
| private IPath chooseExtJarFile() { |
| IPath currPath= getFilePath(); |
| if (currPath.segmentCount() == 0) { |
| currPath= fEntry; |
| } |
| |
| if (ArchiveFileFilter.isArchivePath(currPath, true)) { |
| currPath= currPath.removeLastSegments(1); |
| } |
| |
| FileDialog dialog= new FileDialog(getShell()); |
| dialog.setText(NewWizardMessages.AnnotationsAttachmentBlock_extjardialog_text); |
| dialog.setFilterExtensions(ArchiveFileFilter.JAR_ZIP_FILTER_EXTENSIONS); |
| dialog.setFilterPath(currPath.toOSString()); |
| String res= dialog.open(); |
| if (res != null) { |
| return Path.fromOSString(res).makeAbsolute(); |
| } |
| return null; |
| } |
| |
| private IPath chooseExtFolder() { |
| IPath currPath= getFilePath(); |
| if (currPath.segmentCount() == 0) { |
| currPath= fEntry; |
| } |
| if (ArchiveFileFilter.isArchivePath(currPath, true)) { |
| currPath= currPath.removeLastSegments(1); |
| } |
| |
| DirectoryDialog dialog= new DirectoryDialog(getShell()); |
| dialog.setMessage(NewWizardMessages.AnnotationsAttachmentBlock_extfolderdialog_message); |
| dialog.setText(NewWizardMessages.AnnotationsAttachmentBlock_extfolderdialog_text); |
| dialog.setFilterPath(currPath.toOSString()); |
| String res= dialog.open(); |
| if (res != null) { |
| return Path.fromOSString(res).makeAbsolute(); |
| } |
| return null; |
| } |
| |
| /* |
| * Opens a dialog to choose an internal jar. |
| */ |
| private IPath chooseInternal() { |
| String initSelection= fWorkspaceFileNameField.getText(); |
| |
| ViewerFilter filter= new ArchiveFileFilter((List<IResource>) null, false, false); |
| |
| ILabelProvider lp= new WorkbenchLabelProvider(); |
| ITreeContentProvider cp= new WorkbenchContentProvider(); |
| |
| IResource initSel= null; |
| if (initSelection.length() > 0) { |
| initSel= fWorkspaceRoot.findMember(new Path(initSelection)); |
| } |
| if (initSel == null) { |
| initSel= fWorkspaceRoot.findMember(fEntry); |
| } |
| |
| FolderSelectionDialog dialog= new FolderSelectionDialog(getShell(), lp, cp); |
| dialog.setAllowMultiple(false); |
| dialog.addFilter(filter); |
| dialog.setTitle(NewWizardMessages.AnnotationsAttachmentBlock_intjardialog_title); |
| dialog.setMessage(NewWizardMessages.AnnotationsAttachmentBlock_intjardialog_message); |
| dialog.setInput(fWorkspaceRoot); |
| dialog.setInitialSelection(initSel); |
| if (dialog.open() == Window.OK) { |
| IResource res= (IResource) dialog.getFirstResult(); |
| return res.getFullPath(); |
| } |
| return null; |
| } |
| |
| private Shell getShell() { |
| if (fSWTWidget != null) { |
| return fSWTWidget.getShell(); |
| } |
| return JavaPlugin.getActiveWorkbenchShell(); |
| } |
| |
| /** |
| * Takes a path and replaces the beginning with a variable name |
| * (if the beginning matches with the variables value) |
| * @param path the path |
| * @param varName the variable |
| * @return the modified path |
| */ |
| private IPath modifyPath(IPath path, String varName) { |
| if (varName == null || path == null) { |
| return null; |
| } |
| if (path.isEmpty()) { |
| return new Path(varName); |
| } |
| |
| IPath varPath= JavaCore.getClasspathVariable(varName); |
| if (varPath != null) { |
| if (varPath.isPrefixOf(path)) { |
| path= path.removeFirstSegments(varPath.segmentCount()); |
| } else { |
| path= new Path(path.lastSegment()); |
| } |
| } else { |
| path= new Path(path.lastSegment()); |
| } |
| return new Path(varName).append(path); |
| } |
| |
| |
| /** |
| * Creates a runnable that sets the annotations attachment by modifying the project's classpath. |
| * @param shell the shell |
| * @param newEntry the new entry |
| * @param jproject the Java project |
| * @param containerPath the path of the parent container or <code>null</code> if the element is not in a container |
| * @param isReferencedEntry <code>true</code> iff the entry has a {@link IClasspathEntry#getReferencingEntry() referencing entry} |
| * @return return the runnable |
| */ |
| public static IRunnableWithProgress getRunnable(final Shell shell, final IClasspathEntry newEntry, final IJavaProject jproject, final IPath containerPath, final boolean isReferencedEntry) { |
| return new IRunnableWithProgress() { |
| public void run(IProgressMonitor monitor) throws InvocationTargetException { |
| try { |
| String[] changedAttributes= { IClasspathAttribute.EXTERNAL_ANNOTATION_PATH }; |
| BuildPathSupport.modifyClasspathEntry(shell, newEntry, changedAttributes, jproject, containerPath, isReferencedEntry, monitor); |
| } catch (CoreException e) { |
| throw new InvocationTargetException(e); |
| } |
| } |
| }; |
| } |
| } |