* Copyright (c) 2009 IBM Corporation 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:

*     IBM Corporation - initial API and implementation

*     Zend Technologies

*******************************************************************************/

* Action group that adds the occurrences in file actions to a context menu and

* the global menu bar.

*

* <p>

* This class may be instantiated; it is not intended to be subclassed.

* </p>

*

* @since 3.1

*/

  private IWorkbenchSite fSite;

  private PHPStructuredEditor fEditor;

  private IActionBars fActionBars;

  private String fGroupId;

  // private FindOccurrencesInFileAction fOccurrencesInFileAction;

  // private FindExceptionOccurrencesAction fExceptionOccurrencesAction;

  // private FindImplementOccurrencesAction fFindImplementorOccurrencesAction;

  // private FindBreakContinueTargetOccurrencesAction

  // fBreakContinueTargetOccurrencesAction;

  private FindMethodExitOccurrencesAction fMethodExitOccurrencesAction;

  /**

   * Creates a new <code>ImplementorsSearchGroup</code>. The group requires

   * that the selection provided by the site's selection provider is of type

   * <code>org.eclipse.jface.viewers.IStructuredSelection</code>.

   *

   * @param site

   *            the view part that owns this action group

   */

  public OccurrencesSearchGroup(IWorkbenchSite site) {

    fSite = site;

    fGroupId = IContextMenuConstants.GROUP_SEARCH;

    // fOccurrencesInFileAction= new FindOccurrencesInFileAction(site);

    // fOccurrencesInFileAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_OCCURRENCES_IN_FILE);

    // Need to reset the label

    // fOccurrencesInFileAction.setText(SearchMessages.Search_FindOccurrencesInFile_shortLabel);

    //

    // fExceptionOccurrencesAction= new

    // FindExceptionOccurrencesAction(site);

    // fExceptionOccurrencesAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_EXCEPTION_OCCURRENCES_IN_FILE);

    //

    // fFindImplementorOccurrencesAction= new

    // FindImplementOccurrencesAction(site);

    // fFindImplementorOccurrencesAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_IMPLEMENT_OCCURRENCES_IN_FILE);

    //

    // fBreakContinueTargetOccurrencesAction= new

    // FindBreakContinueTargetOccurrencesAction(site);

    // fBreakContinueTargetOccurrencesAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_BREAK_CONTINUE_TARGET_OCCURRENCES);

    fMethodExitOccurrencesAction = new FindMethodExitOccurrencesAction(site);

    fMethodExitOccurrencesAction

        .setActionDefinitionId(IPHPEditorActionDefinitionIds.SEARCH_METHOD_EXIT_OCCURRENCES);

    // register the actions as selection listeners

    ISelectionProvider provider = fSite.getSelectionProvider();

    ISelection selection = provider.getSelection();

    // registerAction(fOccurrencesInFileAction, provider, selection);

    // registerAction(fExceptionOccurrencesAction, provider, selection);

    // registerAction(fFindImplementorOccurrencesAction, provider,

    // selection);

    // registerAction(fBreakContinueTargetOccurrencesAction, provider,

    // selection);

    registerAction(fMethodExitOccurrencesAction, provider, selection);

  }

  /**

   * Note: This constructor is for internal use only. Clients should not call

   * this constructor.

   *

   * @param editor

   *            the Java editor

   */

  public OccurrencesSearchGroup(PHPStructuredEditor editor) {

    fEditor = editor;

    fSite = fEditor.getSite();

    fGroupId = ITextEditorActionConstants.GROUP_FIND;

    // fOccurrencesInFileAction= new FindOccurrencesInFileAction(fEditor);

    // fOccurrencesInFileAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_OCCURRENCES_IN_FILE);

    // // Need to reset the label

    // fOccurrencesInFileAction.setText(SearchMessages.Search_FindOccurrencesInFile_shortLabel);

    //    fEditor.setAction("SearchOccurrencesInFile", fOccurrencesInFileAction); //$NON-NLS-1$

    //

    // fExceptionOccurrencesAction= new

    // FindExceptionOccurrencesAction(fEditor);

    // fExceptionOccurrencesAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_EXCEPTION_OCCURRENCES_IN_FILE);

    //    fEditor.setAction("SearchExceptionOccurrences", fExceptionOccurrencesAction); //$NON-NLS-1$

    //

    // fFindImplementorOccurrencesAction= new

    // FindImplementOccurrencesAction(fEditor);

    // fFindImplementorOccurrencesAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_IMPLEMENT_OCCURRENCES_IN_FILE);

    //    fEditor.setAction("SearchImplementOccurrences", fFindImplementorOccurrencesAction); //$NON-NLS-1$

    //

    // fBreakContinueTargetOccurrencesAction= new

    // FindBreakContinueTargetOccurrencesAction(fEditor);

    // fBreakContinueTargetOccurrencesAction.setActionDefinitionId(IJavaEditorActionDefinitionIds.SEARCH_BREAK_CONTINUE_TARGET_OCCURRENCES);

    //    fEditor.setAction("BreakContinueTargetOccurrences", fBreakContinueTargetOccurrencesAction); //$NON-NLS-1$

    fMethodExitOccurrencesAction = new FindMethodExitOccurrencesAction(

        fEditor);

    fMethodExitOccurrencesAction

        .setActionDefinitionId(IPHPEditorActionDefinitionIds.SEARCH_METHOD_EXIT_OCCURRENCES);

    fEditor

        .setAction(

            "ExitOccurrencesAction", fMethodExitOccurrencesAction); //$NON-NLS-1$

  }

  private void registerAction(SelectionDispatchAction action,

      ISelectionProvider provider, ISelection selection) {

    action.update(selection);

    provider.addSelectionChangedListener(action);

  }

  /*

   * Method declared on ActionGroup.

   */

  public void fillContextMenu(IMenuManager manager) {

    String menuText = "SearchMessages.group_occurrences"; //$NON-NLS-1$

    String shortcut = getShortcutString();

    if (shortcut != null) {

      menuText = menuText + '\t' + shortcut;

    }

    MenuManager javaSearchMM = new MenuManager(menuText,

        IContextMenuConstants.GROUP_SEARCH);

    javaSearchMM.add(new Action() {

    });

    javaSearchMM.addMenuListener(new IMenuListener() {

      public void menuAboutToShow(IMenuManager mm) {

        mm.removeAll();

        updateActionsInPhpEditor();

        // addAction(fOccurrencesInFileAction, mm);

        // addAction(fFindImplementorOccurrencesAction, mm);

        // addAction(fExceptionOccurrencesAction, mm);

        addAction(fMethodExitOccurrencesAction, mm);

        // addAction(fBreakContinueTargetOccurrencesAction, mm);

        if (mm.isEmpty()) {

          mm

              .add(new Action(

                  "SearchMessages.group_occurrences_quickMenu_noEntriesAvailable") { //$NON-NLS-1$

                public boolean isEnabled() {

                  return false;

                }

              });

        }

      }

      private void addAction(Action action, IMenuManager mm) {

        if (action.isEnabled())

          mm.add(action);

      }

    });

    manager.appendToGroup(fGroupId, javaSearchMM);

  }

  private void updateActionsInPhpEditor() {

    if (fEditor == null)

      return;

    IModelElement element = SelectionConverter.getInput(fEditor);

    if (element == null)

      return;

    ITextSelection textSelection = (ITextSelection) fEditor

        .getSelectionProvider().getSelection();

    IDocument document = DLTKUIPlugin.getDocumentProvider().getDocument(

        fEditor.getEditorInput());

    ModelTextSelection phpSelection = new ModelTextSelection(element,

        document, textSelection.getOffset(), textSelection.getLength());

    // fExceptionOccurrencesAction.update(javaSelection);

    // fOccurrencesInFileAction.update(javaSelection);

    // fFindImplementorOccurrencesAction.update(javaSelection);

    // fBreakContinueTargetOccurrencesAction.update(javaSelection);

    fMethodExitOccurrencesAction.update(phpSelection);

  }

  private String getShortcutString() {

    IBindingService bindingService = (IBindingService) PlatformUI

        .getWorkbench().getAdapter(IBindingService.class);

    if (bindingService == null)

      return null;

    return bindingService

        .getBestActiveBindingFormattedFor(IPHPEditorActionDefinitionIds.SEARCH_OCCURRENCES_IN_FILE_QUICK_MENU);

  }

  /*

   * Method declared on ActionGroup.

   */

  public void fillActionBars(IActionBars actionBars) {

    Assert.isNotNull(actionBars);

    super.fillActionBars(actionBars);

    fActionBars = actionBars;

    updateGlobalActionHandlers();

  }

  /*

   * Method declared on ActionGroup.

   */

  public void dispose() {

    ISelectionProvider provider = fSite.getSelectionProvider();

    if (provider != null) {

      // disposeAction(fFindImplementorOccurrencesAction, provider);

      // disposeAction(fExceptionOccurrencesAction, provider);

      // disposeAction(fOccurrencesInFileAction, provider);

      disposeAction(fMethodExitOccurrencesAction, provider);

      // disposeAction(fBreakContinueTargetOccurrencesAction, provider);

    }

    super.dispose();

    // fFindImplementorOccurrencesAction= null;

    // fExceptionOccurrencesAction= null;

    // fOccurrencesInFileAction= null;

    fMethodExitOccurrencesAction = null;

    // fBreakContinueTargetOccurrencesAction= null;

    updateGlobalActionHandlers();

  }

  private void updateGlobalActionHandlers() {

    if (fActionBars != null) {

      // fActionBars.setGlobalActionHandler(JdtActionConstants.FIND_OCCURRENCES_IN_FILE,

      // fOccurrencesInFileAction);

      // fActionBars.setGlobalActionHandler(JdtActionConstants.FIND_EXCEPTION_OCCURRENCES,

      // fExceptionOccurrencesAction);

      // fActionBars.setGlobalActionHandler(JdtActionConstants.FIND_IMPLEMENT_OCCURRENCES,

      // fFindImplementorOccurrencesAction);

      // fActionBars.setGlobalActionHandler(JdtActionConstants.FIND_BREAK_CONTINUE_TARGET_OCCURRENCES,

      // fBreakContinueTargetOccurrencesAction);

      fActionBars.setGlobalActionHandler(

          PHPActionConstants.FIND_METHOD_EXIT_OCCURRENCES,

          fMethodExitOccurrencesAction);

    }

  }

  private void disposeAction(ISelectionChangedListener action,

      ISelectionProvider provider) {

    if (action != null)

      provider.removeSelectionChangedListener(action);

  }

}