org.eclipse.capra.ui.office/src/org/eclipse/capra/ui/office/preferences/OfficePreferences.java

/*******************************************************************************
 * Copyright (c) 2016 Chalmers | University of Gothenburg, rt-labs 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:
 * 	   Chalmers | University of Gothenburg and rt-labs - initial API and implementation and/or initial documentation
 *******************************************************************************/

package org.eclipse.capra.ui.office.preferences;

import org.eclipse.capra.ui.office.Activator;
import org.eclipse.capra.ui.office.views.OfficeView;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.preference.PreferencePage;
import org.eclipse.swt.SWT;
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.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;

/**
 * Provides a preference page for Capra-Office, where a user can specify custom
 * settings for the Office feature.
 * 
 * Code adapted from:
 * http://help.eclipse.org/neon/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Fguide%2Fpreferences_prefs_implement.htm
 * 
 * @author Dusan Kalanj
 *
 */
public class OfficePreferences extends PreferencePage implements IWorkbenchPreferencePage {

	/**
	 * IDs of preferences
	 */
	public static final String CHAR_COUNT = "org.eclipse.capra.ui.office.preferences.charCount";
	public static final String EXCEL_COLUMN_RADIO_CHOICE = "org.eclipse.capra.ui.office.preferences.excelColumnRadioChoice";
	public static final String EXCEL_CUSTOM_COLUMN = "org.eclipse.capra.ui.office.preferences.excelCustomColumn";
	public static final String EXCEL_COLUMN_VALUE = "org.eclipse.capra.ui.office.preferences.excelColumnValue";
	public static final String WORD_FIELD_NAME = "org.eclipse.capra.ui.office.preferences.wordFieldId";

	/**
	 * Default preference values
	 */
	public static final String CHAR_COUNT_DEFAULT = "30";
	public static final boolean EXCEL_COLUMN_RADIO_ID_IS_LINE_NUMBER = true;
	public static final String EXCEL_CUSTOM_COLUMN_DEFAULT = "A";
	public static final String EXCEL_COLUMN_VALUE_DEFAULT = "0";
	public static final String WORD_FIELD_NAME_DEFAULT = "REQ";

	/**
	 * Description of controls
	 */
	private static final String CHAR_COUNT_DESC = "Number of characters that are shown per line in the Office view:";
	private static final String EXCEL_COLUMN_RADIO_CHOICE_DESC = "Setting the ID of Excel rows:";
	private static final String EXCEL_COLUMN_IS_LINE_NUMBER_OPTION_DESC = "Line number is used as ID";
	private static final String EXCEL_COLUMN_IS_CUSTOM_OPTION_DESC = "Custom ID column: ";
	private static final String EXCEL_COLUMN_IS_CUSTOM_OPTION_HINT = "(e.g. \"A\", \"BC\"...)";
	private static final String WORD_FIELD_NAME_DESC = "ID of Word fields to display: ";

	private static final int FIXED_TEXT_FIELD_WIDTH = 35;

	/**
	 * Controls
	 */
	private Text charCount;
	private Button excel_rowIdIsRowNumber;
	private Button excel_rowIdIsCustomColumn;
	private Text excel_customIdColumnName;
	private Text word_fieldName;

	/**
	 * Creates a swt widget that takes the numColumns of grid space inside the
	 * parent.
	 * 
	 * @param parent
	 *            the element that will hold the widget
	 * @param numColumns
	 *            the number of columns that the widget will take inside the
	 *            grid of the parent.
	 * @return the created widget
	 */
	private Composite createComposite(Composite parent, int numColumns) {
		Composite composite = new Composite(parent, SWT.NULL);

		GridLayout layout = new GridLayout();
		layout.numColumns = numColumns;
		composite.setLayout(layout);

		GridData data = new GridData();
		data.verticalAlignment = GridData.FILL;
		data.horizontalAlignment = GridData.FILL;
		composite.setLayoutData(data);

		return composite;
	}

	@Override
	public void init(IWorkbench workbench) {
		setPreferenceStore(Activator.getDefault().getPreferenceStore());
	}

	/**
	 * Saves the input values on click-apply or click-ok
	 */
	private void storeValues() {
		IPreferenceStore store = Activator.getDefault().getPreferenceStore();

		boolean idIsRowNumber;
		String idColumn;
		if (excel_rowIdIsRowNumber.getSelection()) {
			idColumn = EXCEL_COLUMN_VALUE_DEFAULT;
			excel_customIdColumnName.setText("");
			idIsRowNumber = true;
		} else {
			if (excel_customIdColumnName.getText().isEmpty())
				excel_customIdColumnName.setText(EXCEL_CUSTOM_COLUMN_DEFAULT);
			idColumn = excel_customIdColumnName.getText();
			idIsRowNumber = false;
		}

		store.setValue(CHAR_COUNT, charCount.getText());
		store.setValue(EXCEL_COLUMN_RADIO_CHOICE, idIsRowNumber);
		store.setValue(EXCEL_CUSTOM_COLUMN, excel_customIdColumnName.getText());
		store.setValue(EXCEL_COLUMN_VALUE, idColumn);
		store.setValue(WORD_FIELD_NAME, word_fieldName.getText());
	}

	/**
	 * Fills the text fields and radio buttons with stored values when the
	 * preference page is opened.
	 */
	private void initializeValues() {
		IPreferenceStore store = Activator.getDefault().getPreferenceStore();

		boolean idIsRowNumber = store.getBoolean(EXCEL_COLUMN_RADIO_CHOICE);
		if (idIsRowNumber) {
			excel_rowIdIsRowNumber.setSelection(true);
			excel_customIdColumnName.setText("");
			excel_customIdColumnName.setEnabled(false);
		} else {
			excel_rowIdIsCustomColumn.setSelection(true);
			excel_customIdColumnName.setText(store.getString(EXCEL_CUSTOM_COLUMN));
		}

		charCount.setText(store.getString(CHAR_COUNT));
		word_fieldName.setText(store.getString(WORD_FIELD_NAME));
	}

	/**
	 * Sets the default values if the user clicks on restore defaults option.
	 */
	private void initializeDefaults() {
		excel_rowIdIsRowNumber.setSelection(EXCEL_COLUMN_RADIO_ID_IS_LINE_NUMBER);
		excel_rowIdIsCustomColumn.setSelection(!EXCEL_COLUMN_RADIO_ID_IS_LINE_NUMBER);

		if (excel_rowIdIsRowNumber.getSelection()) {
			excel_customIdColumnName.setText("");
			excel_customIdColumnName.setEnabled(false);
		}
		charCount.setText(CHAR_COUNT_DEFAULT);

		word_fieldName.setText(WORD_FIELD_NAME_DEFAULT);
	}

	@Override
	protected Control createContents(Composite parent) {

		Composite compositeCharCount = createComposite(parent, 2);
		createLabel(compositeCharCount, CHAR_COUNT_DESC, 1);
		charCount = createTextField(compositeCharCount, 1, FIXED_TEXT_FIELD_WIDTH);

		Composite compositeExcelIdColumn = createComposite(parent, 2);
		createLabel(compositeExcelIdColumn, EXCEL_COLUMN_RADIO_CHOICE_DESC, 2);

		Composite compositeRadioButtons = createComposite(compositeExcelIdColumn, 3);
		excel_rowIdIsRowNumber = createRadioButton(compositeRadioButtons, EXCEL_COLUMN_IS_LINE_NUMBER_OPTION_DESC, 3);
		excel_rowIdIsCustomColumn = createRadioButton(compositeRadioButtons, EXCEL_COLUMN_IS_CUSTOM_OPTION_DESC, 1);
		excel_customIdColumnName = createTextField(compositeRadioButtons, 1, FIXED_TEXT_FIELD_WIDTH);
		createLabel(compositeRadioButtons, EXCEL_COLUMN_IS_CUSTOM_OPTION_HINT, 1);

		excel_rowIdIsRowNumber.addSelectionListener(new SelectionListener() {

			@Override
			public void widgetSelected(SelectionEvent e) {
				excel_customIdColumnName.setText("");
				excel_customIdColumnName.setEnabled(false);
			}

			@Override
			public void widgetDefaultSelected(SelectionEvent e) {
			}
		});

		excel_rowIdIsCustomColumn.addSelectionListener(new SelectionListener() {

			@Override
			public void widgetSelected(SelectionEvent e) {
				excel_customIdColumnName.setEnabled(true);
				excel_customIdColumnName.setText(EXCEL_CUSTOM_COLUMN_DEFAULT);
			}

			@Override
			public void widgetDefaultSelected(SelectionEvent e) {
			}
		});

		Composite compositeWordRequirementFieldName = createComposite(parent, 2);
		createLabel(compositeWordRequirementFieldName, WORD_FIELD_NAME_DESC, 1);
		word_fieldName = createTextField(compositeWordRequirementFieldName, 1, FIXED_TEXT_FIELD_WIDTH);

		initializeValues();

		return new Composite(parent, SWT.NULL);
	}

	/**
	 * Creates a label widget that takes the width of numOfColumns grid cells
	 * inside a parent.
	 * 
	 * @param parent
	 *            the element that will hold the label.
	 * @param text
	 *            the text of the label.
	 * @param numOfColumns
	 *            the width (in grid cells) of the label.
	 * @return newly created Label object
	 */
	private Label createLabel(Composite parent, String text, int numOfColumns) {
		Label label = new Label(parent, SWT.LEFT);
		label.setText(text);
		GridData data = new GridData();
		data.horizontalSpan = numOfColumns;
		data.horizontalAlignment = GridData.FILL;
		label.setLayoutData(data);
		return label;
	}

	/**
	 * Creates a Text widget that takes the width of numOfColumns grid cells
	 * inside a parent.
	 * 
	 * @param parent
	 *            the element that will hold the label.
	 * @param numOfColumns
	 *            the width (in grid cells) of the widget.
	 * @param minimumWidth
	 *            the minimum width of the Text widget.
	 * @return the newly created Text widget.
	 */
	private Text createTextField(Composite parent, int numOfColumns, int minimumWidth) {
		Text text = new Text(parent, SWT.SINGLE | SWT.BORDER);
		GridData data = new GridData();
		data.horizontalAlignment = GridData.FILL;
		data.grabExcessHorizontalSpace = true;
		data.verticalAlignment = GridData.CENTER;
		data.grabExcessVerticalSpace = false;
		data.horizontalSpan = numOfColumns;
		data.minimumWidth = minimumWidth;
		text.setLayoutData(data);
		return text;
	}

	/**
	 * Creates a Button widget that takes the width of numOfColumns grid cells
	 * inside a parent.
	 * 
	 * @param parent
	 *            the element that will hold the label.
	 * @param label
	 *            the text of the widget.
	 * @param numOfColumns
	 *            the width (in grid cells) of the widget.
	 * @return the newly created Button widget.
	 */
	private Button createRadioButton(Composite parent, String label, int numOfColumns) {
		Button button = new Button(parent, SWT.RADIO | SWT.LEFT);
		button.setText(label);
		GridData data = new GridData();
		data.horizontalSpan = numOfColumns;
		button.setLayoutData(data);
		return button;
	}

	@Override
	public void performDefaults() {
		super.performDefaults();
		initializeDefaults();
	}

	@Override
	public void performApply() {
		super.performApply();
		storeValues();
	}

	@Override
	public boolean performOk() {
		super.performOk();
		storeValues();
		OfficeView.getOpenedView().refreshView();
		return true;
	}
}