org.eclipse.mylyn.reviews.r4e.ui/src/org/eclipse/mylyn/reviews/r4e/ui/internal/dialogs/SendNotificationInputDialog.java

// $codepro.audit.disable com.instantiations.assist.eclipse.analysis.audit.rule.effectivejava.alwaysOverridetoString.alwaysOverrideToString, com.instantiations.assist.eclipse.analysis.audit.rule.effectivejava.constructorsOnlyInvokeFinalMethods, useForLoop, com.instantiations.assist.eclipse.analysis.deserializeabilitySecurity, com.instantiations.assist.eclipse.analysis.disallowReturnMutable, com.instantiations.assist.eclipse.analysis.enforceCloneableUsageSecurity, explicitThisUsage
/*******************************************************************************
 * Copyright (c) 2011 Ericsson Research Canada
 * 
 * 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
 * 
 * Description:
 * 
 * This class implements the dialog used to choose the email/notification type to send
 * 
 * Contributors:
 *   Sebastien Dubois - Created for Mylyn Review R4E project
 *   
 ******************************************************************************/

package org.eclipse.mylyn.reviews.r4e.ui.internal.dialogs;

import java.util.Iterator;

import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.mylyn.reviews.r4e.ui.internal.model.R4EUIReviewBasic;
import org.eclipse.mylyn.reviews.r4e.ui.internal.utils.R4EUIConstants;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.forms.FormDialog;
import org.eclipse.ui.forms.IManagedForm;
import org.eclipse.ui.forms.events.ExpansionAdapter;
import org.eclipse.ui.forms.events.ExpansionEvent;
import org.eclipse.ui.forms.widgets.ExpandableComposite;
import org.eclipse.ui.forms.widgets.FormToolkit;
import org.eclipse.ui.forms.widgets.ScrolledForm;
import org.eclipse.ui.forms.widgets.Section;

// ------------------------------------------------------------------------
// Constants
// ------------------------------------------------------------------------

/**
 * @author lmcdubo
 * @version $Revision: 1.0 $
 */
public class SendNotificationInputDialog extends FormDialog implements ISendNotificationInputDialog {

	// ------------------------------------------------------------------------
	// Constants
	// ------------------------------------------------------------------------

	/**
	 * Field SEND_MAIL_DIALOG_TITLE. (value is ""Send Notification"")
	 */
	private static final String SEND_MAIL_DIALOG_TITLE = "Send Notification";

	/**
	 * Field BASIC_PARAMS_HEADER_MSG. (value is ""Which notification type do you want to send?"")
	 */
	private static final String BASIC_PARAMS_HEADER_MSG = "Which notification type do you want to send?";

	/**
	 * Field REVIEW_COMPLETION. (value is ""Notify of Review Completion"")
	 */
	private static final String REVIEW_COMPLETION = "Notify of Review Completion";

	/**
	 * Field REVIEW_PROGRESS. (value is ""Notify of Review Progress"")
	 */
	private static final String REVIEW_PROGRESS = "Notify of Review Progress";

	/**
	 * Field QUESTION. (value is ""Ask Question to Participant"")
	 */
	private static final String QUESTION = "Ask Question to Participant";

	/**
	 * Field MEETING_REQUEST. (value is ""Send Meeting Request"")
	 */
	private static final String MEETING_REQUEST = "Send Meeting Request";

	/**
	 * Field UPDATED_REVIEW_ITEMS. (value is ""Notify Participants of Updated Items Ready for Review"")
	 */
	private static final String UPDATED_REVIEW_ITEMS = "Notify Participants of Updated Items Ready for Review";

	// ------------------------------------------------------------------------
	// Member variables
	// ------------------------------------------------------------------------

	/**
	 * Field fElement.
	 */
	private final ISelection fSource;

	/**
	 * Field fMessageType.
	 */
	private int fMessageType;

	/**
	 * Field fItemsReadyButton.
	 */
	private Button fItemsUpdatedButton = null;

	/**
	 * Field fProgressButton.
	 */
	private Button fProgressButton = null;

	/**
	 * Field fCompletionButton.
	 */
	private Button fCompletionButton = null;

	/**
	 * Field fQuestionButton.
	 */
	private Button fQuestionButton = null;

	/**
	 * Field fMeetingButton.
	 */
	private Button fMeetingButton = null;

	// ------------------------------------------------------------------------
	// Constructors
	// ------------------------------------------------------------------------

	/**
	 * Constructor for SendNotificationInputDialog.
	 * 
	 * @param aParentShell
	 *            Shell
	 */
	public SendNotificationInputDialog(Shell aParentShell, ISelection aSource) {
		super(aParentShell);
		fSource = aSource;
		setBlockOnOpen(true);
	}

	// ------------------------------------------------------------------------
	// Methods
	// ------------------------------------------------------------------------

	/**
	 * Method buttonPressed.
	 * 
	 * @param buttonId
	 *            int
	 * @see org.eclipse.jface.dialogs.Dialog#buttonPressed(int)
	 */
	@Override
	protected void buttonPressed(int buttonId) {
		if (buttonId == IDialogConstants.OK_ID) {
			fMessageType = R4EUIConstants.INVALID_VALUE;
			if (null != fItemsUpdatedButton && fItemsUpdatedButton.getSelection()) {
				fMessageType = R4EUIConstants.MESSAGE_TYPE_ITEMS_READY;
			} else if (null != fProgressButton && fProgressButton.getSelection()) {
				fMessageType = R4EUIConstants.MESSAGE_TYPE_PROGRESS;
			} else if (null != fCompletionButton && fCompletionButton.getSelection()) {
				fMessageType = R4EUIConstants.MESSAGE_TYPE_COMPLETION;
			} else if (fQuestionButton.getSelection()) {
				fMessageType = R4EUIConstants.MESSAGE_TYPE_QUESTION;
			} else if (fMeetingButton.getSelection()) {
				fMessageType = R4EUIConstants.MESSAGE_TYPE_MEETING;
			}
		} else {
			fMessageType = R4EUIConstants.INVALID_VALUE;
		}
		super.buttonPressed(buttonId);
	}

	/**
	 * Method configureShell.
	 * 
	 * @param shell
	 *            Shell
	 * @see org.eclipse.jface.window.Window#configureShell(org.eclipse.swt.widgets.Shell)
	 */
	@Override
	protected void configureShell(Shell shell) {
		super.configureShell(shell);
		shell.setText(SEND_MAIL_DIALOG_TITLE);
		shell.setMinimumSize(R4EUIConstants.DIALOG_DEFAULT_WIDTH, R4EUIConstants.DIALOG_DEFAULT_HEIGHT);
	}

	/**
	 * Configures the dialog form and creates form content. Clients should override this method.
	 * 
	 * @param mform
	 *            the dialog form
	 */
	@Override
	protected void createFormContent(final IManagedForm mform) {

		final FormToolkit toolkit = mform.getToolkit();
		final ScrolledForm sform = mform.getForm();
		sform.setExpandVertical(true);
		final Composite composite = sform.getBody();
		final GridLayout layout = new GridLayout(1, false);
		composite.setLayout(layout);

		//Basic parameters section
		final Section basicSection = toolkit.createSection(composite, Section.DESCRIPTION
				| ExpandableComposite.TITLE_BAR | ExpandableComposite.TWISTIE | ExpandableComposite.EXPANDED);
		final GridData basicSectionGridData = new GridData(GridData.FILL, GridData.FILL, true, false);
		basicSectionGridData.horizontalSpan = 4;
		basicSection.setLayoutData(basicSectionGridData);
		basicSection.setText(R4EUIConstants.BASIC_PARAMS_HEADER);
		basicSection.setDescription(BASIC_PARAMS_HEADER_MSG);
		basicSection.addExpansionListener(new ExpansionAdapter() {
			@Override
			public void expansionStateChanged(ExpansionEvent e) {
				getShell().setSize(getShell().computeSize(SWT.DEFAULT, SWT.DEFAULT));
			}
		});

		final Composite basicSectionClient = toolkit.createComposite(basicSection);
		basicSectionClient.setLayout(layout);
		basicSection.setClient(basicSectionClient);

		fCompletionButton = toolkit.createButton(basicSectionClient, REVIEW_COMPLETION, SWT.RADIO);
		fCompletionButton.setToolTipText(R4EUIConstants.NOTIFICATION_COMPLETION_TOOLTIP);
		fCompletionButton.setLayoutData(new GridData(GridData.BEGINNING, GridData.BEGINNING, false, false));

		fQuestionButton = toolkit.createButton(basicSectionClient, QUESTION, SWT.RADIO);
		fQuestionButton.setToolTipText(R4EUIConstants.NOTIFICATION_QUESTION_TOOLTIP);
		fQuestionButton.setLayoutData(new GridData(GridData.BEGINNING, GridData.BEGINNING, false, false));

		fItemsUpdatedButton = toolkit.createButton(basicSectionClient, UPDATED_REVIEW_ITEMS, SWT.RADIO);
		fItemsUpdatedButton.setToolTipText(R4EUIConstants.NOTIFICATION_ITEMS_UPDATED_TOOLTIP);
		fItemsUpdatedButton.setLayoutData(new GridData(GridData.BEGINNING, GridData.BEGINNING, false, false));

		fProgressButton = toolkit.createButton(basicSectionClient, REVIEW_PROGRESS, SWT.RADIO);
		fProgressButton.setToolTipText(R4EUIConstants.NOTIFICATION_PROGRESS_TOOLTIP);
		fProgressButton.setLayoutData(new GridData(GridData.BEGINNING, GridData.BEGINNING, false, false));

		fMeetingButton = toolkit.createButton(basicSectionClient, MEETING_REQUEST, SWT.RADIO);
		fMeetingButton.setToolTipText(R4EUIConstants.MEETING_REQUEST_TOOLTIP);
		fMeetingButton.setLayoutData(new GridData(GridData.BEGINNING, GridData.BEGINNING, false, false));

		//Act differently depending on the type of selection we get
		if (fSource instanceof IStructuredSelection) {
			//Iterate through all selections
			for (final Iterator<?> iterator = ((IStructuredSelection) fSource).iterator(); iterator.hasNext();) {
				Object selection = iterator.next();
				if (selection instanceof R4EUIReviewBasic) {
					fCompletionButton.setEnabled(true);
					fQuestionButton.setEnabled(true);
					fItemsUpdatedButton.setEnabled(true);
					fProgressButton.setEnabled(true);
					fMeetingButton.setEnabled(true);
					if (((R4EUIReviewBasic) selection).isUserReviewed()) {
						fCompletionButton.setSelection(true);
					} else {
						fProgressButton.setSelection(true);
					}
					return;
				}
			}
		}
		fCompletionButton.setEnabled(false);
		fQuestionButton.setEnabled(true);
		fQuestionButton.setSelection(true);
		fItemsUpdatedButton.setEnabled(false);
		fProgressButton.setEnabled(false);
		fMeetingButton.setEnabled(false);
	}

	/**
	 * Method isResizable.
	 * 
	 * @return boolean
	 */
	@Override
	protected boolean isResizable() {
		return true;
	}

	/**
	 * Method getMessageTypeValue
	 * 
	 * @return the message type value
	 */
	public int getMessageTypeValue() {
		return fMessageType;
	}
}