org.eclipse.rmf.reqif10.pror.editor/src/org/eclipse/rmf/reqif10/pror/editor/agilegrid/ProrCellEditor.java

/*******************************************************************************
 * Copyright (c) 2011, 2013 Formal Mind GmbH and University of Dusseldorf.
 * 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:
 *     Michael Jastram - initial API and implementation
 ******************************************************************************/
package org.eclipse.rmf.reqif10.pror.editor.agilegrid;

import org.agilemore.agilegrid.AgileGrid;
import org.agilemore.agilegrid.Cell;
import org.agilemore.agilegrid.EditorActivationEvent;
import org.agilemore.agilegrid.editors.TextCellEditor;
import org.eclipse.emf.edit.domain.EditingDomain;
import org.eclipse.jface.action.IStatusLineManager;
import org.eclipse.rmf.reqif10.AttributeValue;
import org.eclipse.rmf.reqif10.SpecHierarchy;
import org.eclipse.rmf.reqif10.common.util.ReqIF10Util;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.events.TraverseEvent;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.IEditorSite;
import org.eclipse.ui.IViewSite;
import org.eclipse.ui.IWorkbenchPartSite;
import org.eclipse.ui.PlatformUI;

/**
 * A Cell Editor that propagates errors from the Validator to the UI.
 * 
 * @author jastram
 * 
 */
public abstract class ProrCellEditor extends TextCellEditor {

	protected AttributeValue attributeValue;
	protected final EditingDomain editingDomain;
	protected Object affectedObject;
	protected Object parent;

	public ProrCellEditor(AgileGrid agileGrid, EditingDomain editingDomain,
			Object parent,
			Object affectedObject) {
		super(agileGrid, SWT.WRAP);
		this.editingDomain = editingDomain;
		this.affectedObject = affectedObject;
		this.parent = parent;
	}

	/**
	 * In addition to the default behavior, updates status bar and cell font
	 * color.
	 */
	@Override
	protected boolean isCorrect(Object value) {
		boolean result = super.isCorrect(value);
		setStatusBar(getErrorMessage());
		setErrorColor(result);
		return result;
	}

	/**
	 * Updates the error message in the status line, if the status line can be
	 * found (otherwise does nothing). If message is null, the error message is
	 * reset.
	 */
	protected void setStatusBar(String message) {
		IWorkbenchPartSite site = PlatformUI.getWorkbench()
				.getActiveWorkbenchWindow().getActivePage().getActivePart()
				.getSite();
		IStatusLineManager mgr = null;
		if (site instanceof IEditorSite) {
			mgr = ((IEditorSite) site).getActionBars().getStatusLineManager();
		} else if (site instanceof IViewSite) {
			mgr = ((IViewSite) site).getActionBars().getStatusLineManager();
		}
		if (mgr != null) {
			mgr.setErrorMessage(message);
		}
	}

	/**
	 * Sets the foreground color, depending on the value of isCorrect. Default
	 * is {@link SWT#COLOR_RED} for errors and {@link SWT#COLOR_BLACK} by
	 * default.
	 */
	protected void setErrorColor(boolean isCorrect) {
		int colorCode = isCorrect ? SWT.COLOR_BLACK : SWT.COLOR_RED;
		Color color = Display.getDefault().getSystemColor(colorCode);
		getControl().setForeground(color);
	}

	@Override
	protected void doSetValue(Object value) {
		this.attributeValue = null;
		if (value instanceof AttributeValue) {
			attributeValue = (AttributeValue) value;
			value = ReqIF10Util.getTheValue(attributeValue);
		}
		super.doSetValue(value);
	}

	/**
	 * This method "translates" from the editor value (which is a String) to the
	 * Model (which is an AttributeValue). As a side effect (and not very
	 * intuitive, but the best option), the method also sets the new value via a
	 * command. Note that the command should also set the corresponding
	 * {@link SpecHierarchy} as the affected element (use
	 * {@link #getSpecHierarchy()}).
	 * <p>
	 * The actual String in the cell can be accessed via
	 * {@link TextCellEditor#text}.
	 * 
	 * @return the correct value of type {@link AttributeValue}.
	 */
	@Override
	abstract protected Object doGetValue();
	
	/**
	 * Changes the TextCellEditor behavior to capture the first character when
	 * starting to edit. I.e. if one activates the edit mode by pressing a
	 * character key, the current text is replaced by that character.
	 */
	@Override
	public void activate(EditorActivationEvent activationEvent) {
		if (activationEvent.sourceEvent instanceof KeyEvent) {
			KeyEvent keyEvent = (KeyEvent) activationEvent.sourceEvent;
			if (isValidCellEditorCharacter(keyEvent) && keyEvent.character != SWT.DEL) {
				text.setText("" + keyEvent.character);
				//this.fireApplyEditorValue();
				super.activate(activationEvent);
				text.setSelection(1, 1);
				return;
			}
			if (keyEvent.character != SWT.DEL){
				super.activate(activationEvent);
			}
		}else{
			super.activate(activationEvent);
		}
	}

	/**
	 * Helper function to determine if a keypress that already triggered editor
	 * activation is a valid character that can be displayed in the text field.
	 * 
	 * @param keyEvent
	 * @return
	 */
	protected boolean isValidCellEditorCharacter(KeyEvent keyEvent) {
		switch (keyEvent.character) {
		case ' ':
		case '\r':
		case SWT.DEL:
		case SWT.BS:
			return false;
		}

		if ((Character.isLetterOrDigit(keyEvent.character) || keyEvent.keyCode > 32
				&& keyEvent.keyCode < 254 && keyEvent.keyCode != 127)
				&& keyEvent.keyCode != SWT.CTRL
				&& keyEvent.keyCode != SWT.ALT
				&& (keyEvent.stateMask & SWT.CONTROL) == 0
				&& (keyEvent.stateMask & SWT.ALT) == 0) {
			return true;
		}

		return false;
	}
	
	@Override
	protected void onTraverse(TraverseEvent traverseEvent) {
		Cell cellBefore = agileGrid.getFocusCell();
		super.onTraverse(traverseEvent);
		Cell cellAfter = agileGrid.getFocusCell();
		
		
		if ((traverseEvent.keyCode == SWT.ARROW_UP || traverseEvent.keyCode == SWT.ARROW_DOWN) && !cellBefore.equals(cellAfter)){
			if (traverseEvent.keyCode == SWT.ARROW_DOWN && cellAfter.row ==0){
				// Do not activate another editor if ARROW_DOWN was pressed in the last row 
				return;
			}
			
			if (cellAfter != null && cellAfter.row>=0){
				// FIXME: activating the editor here selects the wrong cell.
				// Focusing the cell that has focus does not fire selectionChange but closes the editor. Thats why we call it twice here 
				agileGrid.focusCell(cellAfter);
				agileGrid.triggerEditorActivationEvent(new EditorActivationEvent(cellAfter, null, traverseEvent),null);
				agileGrid.focusCell(cellAfter);
				agileGrid.triggerEditorActivationEvent(new EditorActivationEvent(cellAfter, null, traverseEvent),null);
			}
		}

	}
	
	
}