ProjectEditor.java

/**
 * 
 */
package org.bundlemaker.core.ui.projecteditor;

import org.bundlemaker.core.BundleMakerCore;
import org.bundlemaker.core.project.BundleMakerProjectDescriptionChangedEvent;
import org.bundlemaker.core.project.BundleMakerProjectState;
import org.bundlemaker.core.project.BundleMakerProjectStateChangedEvent;
import org.bundlemaker.core.project.IBundleMakerProjectChangedListener;
import org.bundlemaker.core.project.IProjectDescriptionAwareBundleMakerProject;
import org.bundlemaker.core.resource.IModuleAwareBundleMakerProject;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorSite;
import org.eclipse.ui.IFileEditorInput;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.forms.editor.FormEditor;

/**
 * <p>
 * Provides a graphical editor for BundleMaker's project artifacts
 * </p>
 * 
 * @author Nils Hartmann (nils@nilshartmann.net)
 * 
 */
public class ProjectEditor extends FormEditor {

  private final BundleMakerProjectDirtyListener _bundleMakerProjectDirtyListener = new BundleMakerProjectDirtyListener();

  private IModuleAwareBundleMakerProject        _bundleMakerProject;

  private boolean                               _projectDirty                    = false;

  public ProjectEditor() {
    super();
  }

  @Override
  protected void addPages() {
    try {
      addPage(new ProjectEditorPage(this));
    } catch (Exception ex) {
      Activator.logError("Could not add page to editor", ex);
    }

  }

  @Override
  public void doSave(IProgressMonitor monitor) {
    // commit all editor pages
    commitPages(true);

    // save the project
    try {
      _bundleMakerProject.getModifiableProjectDescription().save();

    } catch (Exception ex) {
      Activator.logError("Error while saving project: " + ex, ex);
    }

  }

  @Override
  public void doSaveAs() {
    // "Save As" is not allowed.
  }

  @Override
  public boolean isSaveAsAllowed() {
    return false;
  }

  /*
   * (non-Javadoc)
   * 
   * @see org.eclipse.ui.forms.editor.FormEditor#isDirty()
   */
  @Override
  public boolean isDirty() {
    return _projectDirty;
  }

  protected void setProjectDirty(boolean dirty) {
    boolean oldValue = _projectDirty;
    _projectDirty = dirty;

    if (_projectDirty != oldValue) {
      editorDirtyStateChanged();
    }
  }

  /**
   * Opens the {@link IProjectDescriptionAwareBundleMakerProject}
   */
  @Override
  public void init(IEditorSite site, IEditorInput input) throws PartInitException {
    super.init(site, input);

    IFileEditorInput adapter = (IFileEditorInput) input.getAdapter(IFileEditorInput.class);

    if (adapter == null) {
      Activator.logErrorMessage("Unsupported EditorInput '%s' cannot be adapted to '%s'", input,
          IFileEditorInput.class.getName());
      return;
    }

    // Open the BundleMaker project
    IProject project = adapter.getFile().getProject();

    setPartName(project.getName());
    try {
      // TODO use ProgressMonitor
      IModuleAwareBundleMakerProject bundleMakerProject = BundleMakerCore
          .getBundleMakerProject(project).adaptAs(IModuleAwareBundleMakerProject.class);

      _bundleMakerProject = bundleMakerProject;

      // add listener
      _bundleMakerProject.addBundleMakerProjectChangedListener(this._bundleMakerProjectDirtyListener);

    } catch (Exception ex) {
      throw new PartInitException("Could not open BundleMaker project", ex);
    }

  }

  /**
   * Returns the {@link IProjectDescriptionAwareBundleMakerProject} that this editor is working on.
   * <p>
   * </p>
   * 
   * @return The IBundleMakerProject instance. Never null.
   */
  public IModuleAwareBundleMakerProject getBundleMakerProject() {
    Assert.isNotNull(_bundleMakerProject);
    return this._bundleMakerProject;
  }

  /*
   * (non-Javadoc)
   * 
   * @see org.eclipse.ui.forms.editor.FormEditor#dispose()
   */
  @Override
  public void dispose() {
    // remove dirty listener
    if (_bundleMakerProject != null) {
      _bundleMakerProject.removeBundleMakerProjectChangedListener(_bundleMakerProjectDirtyListener);

      boolean d = isDirty();
      if (d) {
        // window is closed, changes already made to the model must be discarded by re-loading the bundlemaker.json from
        // storage
        try {
          _bundleMakerProject.reloadProjectDescription();
        } catch (CoreException e) {
          Activator.logError("Error while re-reading project description from disc: " + e, e);
        }
      }
    }

    // dispose
    super.dispose();
  }

  /**
   * A Listener that tracks configuration state of the project that is edited in this editor.
   * 
   * @author Nils Hartmann (nils@nilshartmann.net)
   */
  class BundleMakerProjectDirtyListener extends IBundleMakerProjectChangedListener.Adapter {

    /**
     * {@inheritDoc}
     */
    @Override
    public void projectDescriptionChanged(BundleMakerProjectDescriptionChangedEvent event) {
      if (event.getType() == BundleMakerProjectDescriptionChangedEvent.Type.PROJECT_DESCRIPTION_MODIFIED) {
        setProjectDirty(true);
      }

      if (event.getType() == BundleMakerProjectDescriptionChangedEvent.Type.PROJECT_DESCRIPTION_SAVED) {
        setProjectDirty(false);
      }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void projectStateChanged(BundleMakerProjectStateChangedEvent event) {
      if (_bundleMakerProject.getState() == BundleMakerProjectState.DISPOSED) {

        // Project has been disposed => close editor
        getSite().getShell().getDisplay().asyncExec(new Runnable() {

          @Override
          public void run() {
            getSite().getWorkbenchWindow().getActivePage().closeEditor(ProjectEditor.this, false);
          }
        });
      }
    }
  }

}