KommaFormEditor.java

package net.enilink.komma.edit.ui.editor;

import net.enilink.komma.edit.domain.AdapterFactoryEditingDomain;
import net.enilink.komma.edit.domain.IEditingDomain;
import net.enilink.komma.edit.domain.IEditingDomainProvider;

import org.eclipse.core.resources.IMarker;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.action.IMenuListener;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IEditorSite;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.forms.editor.FormEditor;

/**
 * This is a base class for a form-based model editor.
 */
public abstract class KommaFormEditor extends FormEditor implements
		IEditingDomainProvider, IMenuListener, ISupportedEditor {
	private KommaEditorSupport<? extends KommaFormEditor> editorSupport;

	/**
	 * This creates a model editor.
	 */
	public KommaFormEditor() {
		editorSupport = createEditorSupport();
	}

	protected abstract KommaEditorSupport<? extends KommaFormEditor> createEditorSupport();

	@Override
	public void dispose() {
		super.dispose();
		if (editorSupport != null) {
			// trick to dispose editor support after action bars are disposed
			final KommaEditorSupport<?> support = editorSupport;
			getSite().getShell().getDisplay().asyncExec(new Runnable() {
				@Override
				public void run() {
					support.dispose();
				}
			});
			editorSupport = null;
		}
	}

	/**
	 * This is for implementing {@link IEditorPart} and simply saves the model
	 * file.
	 */
	@Override
	public void doSave(IProgressMonitor progressMonitor) {
		editorSupport.doSave(progressMonitor);
	}

	/**
	 * This also changes the editor's input.
	 */
	@Override
	public void doSaveAs() {
		editorSupport.doSaveAs();
	}

	/**
	 * This is here for the listener to be able to call it.
	 */
	@Override
	public void firePropertyChange(int action) {
		super.firePropertyChange(action);
	}

	/**
	 * This is how the framework determines which interfaces we implement.
	 */
	@SuppressWarnings("rawtypes")
	@Override
	public Object getAdapter(Class key) {
		Object adapter = editorSupport.getAdapter(key);
		if (adapter != null) {
			return adapter;
		}
		return super.getAdapter(key);
	}

	public Composite getContainer() {
		return super.getContainer();
	}

	/**
	 * This returns the editing domain as required by the
	 * {@link IEditingDomainProvider} interface. This is important for
	 * implementing the static methods of {@link AdapterFactoryEditingDomain}
	 * and for supporting {@link org.eclipse.emf.edit.ui.action.CommandAction}.
	 */
	public IEditingDomain getEditingDomain() {
		if (editorSupport == null) {
			return null;
		}
		return editorSupport.getEditingDomain();
	}

	public IEditorPart getEditor(int pageIndex) {
		return super.getEditor(pageIndex);
	}

	protected KommaEditorSupport<? extends KommaFormEditor> getEditorSupport() {
		return editorSupport;
	}

	public int getPageCount() {
		return super.getPageCount();
	}

	public void gotoMarker(IMarker marker) {
		editorSupport.gotoMarker(marker);
	}

	/**
	 * This is called during startup.
	 */
	@Override
	public void init(IEditorSite site, IEditorInput editorInput)
			throws PartInitException {
		setSite(site);
		setInputWithNotify(editorInput);
		setPartName(editorInput.getName());
		editorSupport.init();
	}

	/**
	 * This is for implementing {@link IEditorPart} and simply tests the command
	 * stack.
	 */
	@Override
	public boolean isDirty() {
		return editorSupport != null && editorSupport.isDirty();
	}

	/**
	 * This always returns true because it is not currently supported.
	 */
	@Override
	public boolean isSaveAsAllowed() {
		return editorSupport != null && editorSupport.isSaveAsAllowed();
	}

	/**
	 * This implements {@link org.eclipse.jface.action.IMenuListener} to help
	 * fill the context menus with contributions from the Edit menu.
	 */
	public void menuAboutToShow(IMenuManager menuManager) {
		editorSupport.menuAboutToShow(menuManager);
	}

	@Override
	protected void pageChange(int newPageIndex) {
		super.pageChange(newPageIndex);
		editorSupport.handlePageChange(getSelectedPage());
	}

	public void setActivePage(int pageIndex) {
		super.setActivePage(pageIndex);
	}

	public void setInputWithNotify(IEditorInput input) {
		super.setInputWithNotify(input);
	}

	public void setPageText(int pageIndex, String text) {
		super.setPageText(pageIndex, text);
	}

	public void setPartName(String partName) {
		super.setPartName(partName);
	}
}