/*
    * Created on Jul 24, 2005.
    * Copyright 1999-2006 Faculty of Mathematics, Physics and Informatics, Comenius University, Bratislava.
    * This file is protected by the Mozilla Public License
    * version 1.1 (the "License"); you may not use this file except in compliance with the License. 
    * You may obtain a copy of the License at 
    * 
    *      http://euromath2.sourceforge.net/license.html
    * 
   * Unless required by applicable law or agreed to in writing, software 
   * distributed under the License is distributed on an "AS IS" BASIS, 
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
   * See the License for the specific language governing permissions and 
   * limitations under the License. 
   */
  package sk.uniba.euromath.editor.actions;
  
  import java.util.Iterator;
  
  import org.eclipse.gef.ui.actions.ActionRegistry;
  import org.eclipse.jface.action.IMenuManager;
  import org.eclipse.jface.action.IStatusLineManager;
  import org.eclipse.jface.action.IToolBarManager;
  import org.eclipse.jface.action.Separator;
  import org.eclipse.ui.IEditorPart;
  import org.eclipse.ui.IWorkbenchActionConstants;
  import org.eclipse.ui.actions.ActionFactory;
  import org.eclipse.ui.part.MultiPageEditorActionBarContributor;
  
  import sk.uniba.euromath.editor.EditorSite;
  import sk.uniba.euromath.editor.IEditor;
  import sk.uniba.euromath.editor.IFocusListener;
  import sk.uniba.euromath.editor.xmlEditor.actions.ShowDocumentPropertiesAction;
  
  /***
   * MultiViewActionContributor is contributor for special IEditorPart -
   * MutliViewXMLEditor. It is common contributor for all opened views.
   * Contributes to global bars by it's contributions and by contribution of
   * active IEditor. When focus is changed in EditorSite (active IEditor has
   * changed) or in workbench page (another EditorSite has ben activated, ...)
   * contribution are updated and actions are updated so. Action contributions
   * must implement IMultiViewAction interface, must be held in global registry
   * and must have unique id.
   * 
   * @author Tomáš Studva 19.9.2005
   */
  public class MultiViewActionContributor extends
          MultiPageEditorActionBarContributor implements IFocusListener {
  
      /***
       * Holds EditorSite with focus.
       */
      private EditorSite activeEditorSite;
  
      /***
       * Global action registry for registering IEditor's contibutions by their
       * contributors.
       */
      private final ActionRegistry actionRegistry;
  
      /***
       * Local action registry for contribution of this MultiViewActionContributor
       * contributor. !! Don't use to registering actions in this class.
       */
      // private final ActionRegistry localActionRegistry;
      /***
       * Constructor.
       */
      public MultiViewActionContributor() {
          super();
          this.actionRegistry = new ActionRegistry();
          // this.localActionRegistry = new ActionRegistry();
      }
  
      /*
       * (non-Javadoc)
       * 
       * @see org.eclipse.ui.part.MultiPageEditorActionBarContributor#setActivePage(org.eclipse.ui.IEditorPart)
       */
      @Override
      public void setActivePage(IEditorPart activeEditor) {
          if (!(activeEditor instanceof EditorSite))
              throw new IllegalStateException();
          if (getActiveEditorSite() != null)
              getActiveEditorSite().removeFocusListener(this);
          removeContributionByEditors();
          setActiveEditorSite(((EditorSite) activeEditor));
          // redirection of actions
          IMultiViewAction action;
          for (Iterator i = getActionRegistry().getActions(); i.hasNext();) {
              action = (IMultiViewAction) i.next();
              action.setWorkbenchPart(getActiveEditorSite());
              action.update();
          }
  
          getActiveEditorSite().setActionContributor(this);
          getActiveEditorSite().addFocusListener(this);
          contributeByActiveEditor();
      }
 
     /***
      * Adds contributions of active editor to bars.
      */
     private void contributeByActiveEditor() {
         IMenuManager menuManager = getActionBars().getMenuManager();
         IToolBarManager toolBarManager = getActionBars().getToolBarManager();
         IStatusLineManager statusLineManager = getActionBars()
                 .getStatusLineManager();
 
         // call active IEditor contributor
         if (getActiveEditorSite() != null) {
             IActionContributor contributor = getActiveEditorSite()
                     .getActiveEditor().getActionContributor();
             contributor.contributeToMenu(menuManager);
             contributor.contributeToStatusLine(statusLineManager);
             contributor.contributeToToolBar(toolBarManager);
             menuManager.updateAll(true);
             toolBarManager.update(true);
             statusLineManager.update(true);
         }
     }
 
     /***
      * Removes contributions of active editor from bars.
      */
     private void removeContributionByEditors() {
         IMenuManager menuManager = getActionBars().getMenuManager();
         IToolBarManager toolBarManager = getActionBars().getToolBarManager();
         IStatusLineManager statusLineManager = getActionBars()
                 .getStatusLineManager();
         IMultiViewAction action;
         for (Iterator i = getActionRegistry().getActions(); i.hasNext();) {
             action = (IMultiViewAction) i.next();
             menuManager.remove(action.getId());
             toolBarManager.remove(action.getId());
             statusLineManager.remove(action.getId());
         }
         menuManager.updateAll(true);
         toolBarManager.update(true);
         statusLineManager.update(true);
     }
 
     /***
      * This contributor's action registry.
      * 
      * @return action registry used to registry actions used to contribute by
      *         this contributor
      */
     public ActionRegistry getActionRegistry() {
         return this.actionRegistry;
     }
 
     /*
      * (non-Javadoc)
      * 
      * @see org.eclipse.ui.part.EditorActionBarContributor#contributeToMenu(org.eclipse.jface.action.IMenuManager)
      */
     @Override
     public void contributeToMenu(IMenuManager menuManager) {
         super.contributeToMenu(menuManager);
         // get the File menu
         final IMenuManager file = (IMenuManager) menuManager
                 .find(IWorkbenchActionConstants.M_FILE);
         file.insertAfter(ActionFactory.EXPORT.getId(),
                 new ShowDocumentPropertiesAction(this));
         file.insertAfter(ActionFactory.EXPORT.getId(), new Separator());
     }
 
     @Override
     public void contributeToStatusLine(IStatusLineManager statusLineManager) {
         super.contributeToStatusLine(statusLineManager);
     }
 
     @Override
     public void contributeToToolBar(IToolBarManager toolBarManager) {
         super.contributeToToolBar(toolBarManager);
     }
     
     /*
      * (non-Javadoc)
      * @see sk.uniba.euromath.editor.IFocusListener#focusGained(sk.uniba.euromath.editor.IEditor)
      */
     public void focusGained(IEditor editor) {
         contributeByActiveEditor();
     }
 
     /*
      * (non-Javadoc)
      * @see sk.uniba.euromath.editor.IFocusListener#focusLost(sk.uniba.euromath.editor.IEditor)
      */
     public void focusLost(IEditor editor) {
         removeContributionByEditors();
     }
 
     /***
      * @return Returns the activeEditorSite.
      */
     public EditorSite getActiveEditorSite() {
         return this.activeEditorSite;
     }
 
     /***
      * @param activeEditorSite
      *            The activeEditorSite to set.
      */
     public void setActiveEditorSite(EditorSite activeEditorSite) {
         this.activeEditorSite = activeEditorSite;
     }
 }