/*******************************************************************************
* Copyright (c) 2004, 2010 Jeff Pound 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:
* Jeff Pound - initial API and implementation
* Tasktop Technologies - improvements
* Tomasz Zarna (IBM) - fixes for bug 364240
*******************************************************************************/
package org.eclipse.mylyn.tasks.ui.wizards;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.wizard.WizardPage;
import org.eclipse.mylyn.commons.ui.CommonImages;
import org.eclipse.mylyn.commons.workbench.editors.CommonTextSupport;
import org.eclipse.mylyn.internal.tasks.core.data.FileTaskAttachmentSource;
import org.eclipse.mylyn.internal.tasks.ui.TasksUiPlugin;
import org.eclipse.mylyn.internal.tasks.ui.editors.RichTextEditor;
import org.eclipse.mylyn.internal.tasks.ui.editors.TaskEditorExtensions;
import org.eclipse.mylyn.internal.tasks.ui.wizards.Messages;
import org.eclipse.mylyn.tasks.core.data.TaskAttachmentMapper;
import org.eclipse.mylyn.tasks.core.data.TaskAttachmentModel;
import org.eclipse.mylyn.tasks.ui.TasksUiImages;
import org.eclipse.mylyn.tasks.ui.editors.AbstractTaskEditorExtension;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.ActiveShellExpression;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.contexts.IContextActivation;
import org.eclipse.ui.contexts.IContextService;
import org.eclipse.ui.handlers.IHandlerService;
/**
* A wizard page to enter details of a new attachment.
*
* @author Jeff Pound
* @author Mik Kersten
* @author Steffen Pingel
* @since 3.0
*/
public class TaskAttachmentPage extends WizardPage {
private Button attachContextButton;
private RichTextEditor commentEditor;
private Text descriptionText;
private Combo contentTypeList;
private Text fileNameText;
private Button isPatchButton;
private final TaskAttachmentModel model;
private boolean needsDescription;
private final TaskAttachmentMapper taskAttachment;
private boolean first = true;
private IContextService contextService;
private IContextActivation commentContext;
private CommonTextSupport textSupport;
private boolean needsReplaceExisting;
private Button replaceExistingButton;
public TaskAttachmentPage(TaskAttachmentModel model) {
super("AttachmentDetails"); //$NON-NLS-1$
this.model = model;
this.taskAttachment = TaskAttachmentMapper.createFrom(model.getAttribute());
setTitle(Messages.TaskAttachmentPage_Attachment_Details);
setNeedsDescription(true);
}
public void createControl(Composite parent) {
Composite composite = new Composite(parent, SWT.NONE);
GridLayout gridLayout = new GridLayout();
gridLayout.numColumns = 3;
composite.setLayout(gridLayout);
setControl(composite);
composite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
composite.setLayout(new GridLayout(3, false));
new Label(composite, SWT.NONE).setText(Messages.TaskAttachmentPage_File);
fileNameText = new Text(composite, SWT.BORDER);
fileNameText.setLayoutData(new GridData(SWT.FILL, SWT.TOP, true, false, 2, 1));
if (needsReplaceExisting) {
new Label(composite, SWT.NONE);
replaceExistingButton = new Button(composite, SWT.CHECK);
replaceExistingButton.setLayoutData(new GridData(SWT.DEFAULT, SWT.DEFAULT, false, false, 2, 1));
replaceExistingButton.setText(Messages.TaskAttachmentPage_Replace_existing_attachment_Label);
replaceExistingButton.addSelectionListener(new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent e) {
taskAttachment.setReplaceExisting(replaceExistingButton.getSelection());
validate();
}
});
}
if (needsDescription) {
new Label(composite, SWT.NONE).setText(Messages.TaskAttachmentPage_Description);
descriptionText = new Text(composite, SWT.BORDER);
descriptionText.setLayoutData(new GridData(SWT.FILL, SWT.TOP, true, false, 2, 1));
descriptionText.addModifyListener(new ModifyListener() {
public void modifyText(ModifyEvent e) {
taskAttachment.setDescription(descriptionText.getText().trim());
validate();
}
});
}
Label label = new Label(composite, SWT.NONE);
label.setLayoutData(new GridData(SWT.LEFT, SWT.FILL, false, false));
label.setText(Messages.TaskAttachmentPage_Comment);
AbstractTaskEditorExtension extension = TaskEditorExtensions.getTaskEditorExtension(model.getTaskRepository());
if (extension != null) {
String contextId = extension.getEditorContextId();
if (contextId != null) {
contextService = (IContextService) PlatformUI.getWorkbench().getService(IContextService.class);
if (contextService != null) {
commentContext = contextService.activateContext(contextId, new ActiveShellExpression(getShell()));
}
}
}
commentEditor = new RichTextEditor(getModel().getTaskRepository(), SWT.V_SCROLL | SWT.BORDER | SWT.WRAP,
contextService, extension, getModel().getTask()) {
@Override
protected void valueChanged(String value) {
apply();
};
};
commentEditor.createControl(composite, null);
commentEditor.getControl().setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 2, 1));
IHandlerService handlerService = (IHandlerService) PlatformUI.getWorkbench().getService(IHandlerService.class);
if (handlerService != null) {
textSupport = new CommonTextSupport(handlerService);
textSupport.install(commentEditor.getViewer(), true);
}
new Label(composite, SWT.NONE).setText(Messages.TaskAttachmentPage_Content_Type);// .setBackground(parent.getBackground());
contentTypeList = new Combo(composite, SWT.BORDER | SWT.DROP_DOWN | SWT.READ_ONLY);
contentTypeList.setLayoutData(new GridData(SWT.DEFAULT, SWT.DEFAULT, false, false, 2, 1));
String[] contentTypes = FileTaskAttachmentSource.getContentTypes();
int selection = 0;
for (int i = 0; i < contentTypes.length; i++) {
String next = contentTypes[i];
contentTypeList.add(next);
if (next.equalsIgnoreCase(model.getContentType())) {
selection = i;
}
}
/* Update attachment on select content type */
contentTypeList.addSelectionListener(new SelectionListener() {
public void widgetDefaultSelected(SelectionEvent e) {
// ignore
}
public void widgetSelected(SelectionEvent e) {
taskAttachment.setContentType(contentTypeList.getItem(contentTypeList.getSelectionIndex()));
validate();
}
});
contentTypeList.select(selection);
taskAttachment.setContentType(contentTypeList.getItem(selection));
// TODO: is there a better way to pad?
new Label(composite, SWT.NONE);
isPatchButton = new Button(composite, SWT.CHECK);
isPatchButton.setLayoutData(new GridData(SWT.DEFAULT, SWT.DEFAULT, false, false, 2, 1));
isPatchButton.setText(Messages.TaskAttachmentPage_Patch);
// TODO: is there a better way to pad?
new Label(composite, SWT.NONE);
attachContextButton = new Button(composite, SWT.CHECK);
attachContextButton.setLayoutData(new GridData(SWT.DEFAULT, SWT.DEFAULT, false, false, 2, 1));
attachContextButton.setText(Messages.TaskAttachmentPage_ATTACHE_CONTEXT);
attachContextButton.setImage(CommonImages.getImage(TasksUiImages.CONTEXT_ATTACH));
attachContextButton.setEnabled(TasksUiPlugin.getContextStore().hasContext(model.getTask()));
/*
* Attachment file name listener, update the local attachment
* accordingly
*/
fileNameText.addModifyListener(new ModifyListener() {
public void modifyText(ModifyEvent e) {
// determine type by extension
taskAttachment.setFileName(fileNameText.getText());
setContentTypeFromFilename(fileNameText.getText());
validate();
}
});
/* Listener for isPatch */
isPatchButton.addSelectionListener(new SelectionAdapter() {
private int lastSelected;
@Override
public void widgetSelected(SelectionEvent e) {
taskAttachment.setPatch(isPatchButton.getSelection());
if (isPatchButton.getSelection()) {
lastSelected = contentTypeList.getSelectionIndex();
contentTypeList.select(0);
contentTypeList.setEnabled(false);
if (attachContextButton.isEnabled()) {
attachContextButton.setSelection(true);
}
} else {
contentTypeList.setEnabled(true);
contentTypeList.select(lastSelected);
}
validate();
}
});
attachContextButton.addSelectionListener(new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent e) {
validate();
}
});
validate();
setErrorMessage(null);
if (descriptionText != null) {
descriptionText.setFocus();
} else {
commentEditor.getControl().setFocus();
}
Dialog.applyDialogFont(composite);
}
private void validate() {
apply();
if (fileNameText != null && "".equals(fileNameText.getText().trim())) { //$NON-NLS-1$
setMessage(Messages.TaskAttachmentPage_Enter_a_file_name);
setPageComplete(false);
} else if (descriptionText != null && "".equals(descriptionText.getText().trim())) { //$NON-NLS-1$
setMessage(Messages.TaskAttachmentPage_Enter_a_description);
setPageComplete(false);
} else {
setMessage(Messages.TaskAttachmentPage_Verify_the_content_type_of_the_attachment);
setPageComplete(true);
}
}
public TaskAttachmentModel getModel() {
return model;
}
private void apply() {
taskAttachment.applyTo(model.getAttribute());
model.setComment(commentEditor.getText());
model.setAttachContext(attachContextButton.getSelection());
model.setContentType(taskAttachment.getContentType());
}
private void setContentType(String contentType) {
String[] typeList = contentTypeList.getItems();
for (int i = 0; i < typeList.length; i++) {
if (typeList[i].equals(contentType)) {
contentTypeList.select(i);
taskAttachment.setContentType(contentType);
validate();
break;
}
}
}
private void setContentTypeFromFilename(String fileName) {
setContentType(FileTaskAttachmentSource.getContentTypeFromFilename(fileName));
}
private void setFilePath(String path) {
fileNameText.setText(path);
taskAttachment.setFileName(path);
if (path.endsWith(".patch")) { //$NON-NLS-1$
isPatchButton.setSelection(true);
taskAttachment.setPatch(true);
if (attachContextButton.isEnabled()) {
attachContextButton.setSelection(true);
}
}
validate();
}
public void setNeedsDescription(boolean supportsDescription) {
this.needsDescription = supportsDescription;
}
/**
* @deprecated Use {@link #needsDescription()} instead
*/
@Deprecated
public boolean supportsDescription() {
return needsDescription();
}
/**
* Returns true if the page has a description field.
*
* @since 3.4
* @see #setDescription(String)
*/
public boolean needsDescription() {
return needsDescription;
}
@Override
public void setVisible(boolean visible) {
if (visible) {
if (!fileNameText.getText().equals(taskAttachment.getFileName())) {
fileNameText.setText(taskAttachment.getFileName() == null ? "" : taskAttachment.getFileName()); //$NON-NLS-1$
if (fileNameText.getText().length() == 0) {
setFilePath(getModel().getSource().getName());
setContentType(getModel().getSource().getContentType());
}
}
}
super.setVisible(visible);
if (first) {
if (descriptionText != null) {
descriptionText.setFocus();
} else {
commentEditor.getControl().setFocus();
}
first = false;
}
}
@Override
public void dispose() {
super.dispose();
if (contextService != null && commentContext != null) {
contextService.deactivateContext(commentContext);
commentContext = null;
}
if (textSupport != null) {
textSupport.dispose();
}
}
/**
* Set to true if the page needs a check box for replacing existing attachments. Must be called before the page is
* constructed, it has no effect otherwise.
* <p>
* This flag is set to false by default.
* </p>
*
* @since 3.4
* @see #needsReplaceExisting()
*/
public void setNeedsReplaceExisting(boolean needsReplaceExisting) {
this.needsReplaceExisting = needsReplaceExisting;
}
/**
* Returns true, if the page has a check box to replace existing attachments.
*
* @since 3.4
* @see #setNeedsReplaceExisting(boolean)
*/
public boolean needsReplaceExisting() {
return needsReplaceExisting;
}
}