import org.eclipse.ui.navigator.ICommonNavigator;

	 * @return The ICommonNavigator for this action group

	 */

	protected ICommonNavigator getCommonNavigator() {

		return commonNavigator;

	}

	/**

	 * @return The viewer for this action group

	 */

	protected CommonViewer getCommonViewer() {

		return commonViewer;

	}

	/**

CommonNavigatorOutline_DefaultTitle=Common Navigator Outline

import org.eclipse.ui.IActionBars;

import org.eclipse.ui.IWorkbenchSite;

import org.eclipse.ui.internal.navigator.CommonNavigatorViewActionGroup;

	 * @see org.eclipse.ui.navigator.ICommonNavigator#getCommonViewer()

	/**

	 * @see org.eclipse.ui.navigator.ICommonNavigator#getActionBars()

	 */

	public IActionBars getActionBars() {

		return getViewSite().getActionBars();

	}

	/**

	 * @see org.eclipse.ui.navigator.ICommonNavigator#getWorkbenchSite()

	 */

	public IWorkbenchSite getWorkbenchSite() {

		return getViewSite();

	}

	/**

	 * @see org.eclipse.ui.navigator.ICommonNavigator#getCommonViewerSite()

	 */

	public ICommonViewerSite getCommonViewerSite() {

		return CommonViewerSiteFactory.createCommonViewerSite(getViewSite());

	}

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

 * Copyright (c) 2008 Anyware Technologies

 * 

 * 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:

 *    Anyware Technologies - initial API and implementation

 *

 * $Id$

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

package org.eclipse.ui.navigator;

import org.eclipse.ui.IActionBars;

import org.eclipse.ui.IWorkbenchSite;

import org.eclipse.ui.part.ISetSelectionTarget;

/**

 * <p>

 * This interface defines the API for common navigators. Common navigators can

 * be used in views or outlines. The following types are used by this class to

 * render a Common Navigator:

 * <ul>

 * <li>

 * <p>

 * {@link org.eclipse.ui.navigator.CommonViewer}: The viewer that renders the

 * extensible tree. Creates and manages the lifecylce of the Navigator Content

 * Service (described below).

 * </p>

 * </li>

 * <li>

 * <p>

 * {@link org.eclipse.ui.navigator.NavigatorActionService}: Manages instances of

 * {@link org.eclipse.ui.navigator.CommonActionProvider}s provided by individual

 * extensions and content extensions.

 * </p>

 * </li>

 * <li>

 * <p>

 * {@link org.eclipse.ui.navigator.INavigatorContentService}: Manages instances

 * of Navigator Content Extensions. Instances are created as needed, and

 * disposed of upon the disposal of the Navigator Content Service.

 * </p>

 * </li>

 * </ul>

 * <p>

 * Clients are not expected to subclass CommonNavigator. Clients that wish to

 * define their own custom extensible navigator view need to specify an instance

 * of the <b>org.eclipse.ui.views</b> extension point:

 * 

 * <pre>

 * 

 *          <extension

 *          		point="org.eclipse.ui.views">

 *          	<view

 *          		name="My Custom View"

 *          		icon="relative/path/to/icon.gif"

 *          		category="org.acme.mycategory"

 *          		class="org.eclipse.ui.navigator.CommonNavigator"

 *          		id="org.acme.MyCustomNavigatorID">

 *          	</view>

 *          </extension>

 * 

 * </pre>

 * 

 * @since 3.5

 */

public interface ICommonNavigator extends ISetSelectionTarget {

	/**

	 * <p>

	 * Provides access to the commonViewer used by the current CommonNavigator.

	 * </p>

	 * 

	 * @return The (already created) instance of Common Viewer.

	 */

	public CommonViewer getCommonViewer();

	/**

	 * @return The Navigator Content Service which populates this instance of

	 *         Common Navigator

	 */

	public INavigatorContentService getNavigatorContentService();

	/**

	 * <p>

	 * Provides access to the Workbench Site of the current Common Navigator.

	 * The workbench site is used to access to the Workbench Page or services.

	 * </p>

	 * 

	 * @return the Workbench site of the Common Navigator

	 */

	public IWorkbenchSite getWorkbenchSite();

	/**

	 * <p>

	 * Return or creates a valid context for this Common Navigator

	 * </p>

	 * 

	 * @return the context of this Common Navigator

	 */

	public ICommonViewerSite getCommonViewerSite();

	/**

	 * @return the title of this Common Navigator

	 */

	public String getTitle();

	/**

	 * <p>

	 * Provides access to the ActionBars of this Common Navigator. This method

	 * is an abstraction to access to ActionBars from IViewPart,

	 * IContentOutlinePage...

	 * </p>

	 * 

	 * @return the ActionBar of this Common Navigator

	 */

	public IActionBars getActionBars();

}

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

 * Copyright (c) 2003, 2008 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

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

package org.eclipse.ui.internal.navigator;

import org.eclipse.jface.action.IMenuManager;

import org.eclipse.jface.commands.ActionHandler;

import org.eclipse.jface.resource.ImageDescriptor;

import org.eclipse.ui.IActionBars;

import org.eclipse.ui.IWorkbenchActionConstants;

import org.eclipse.ui.handlers.IHandlerService;

import org.eclipse.ui.internal.navigator.actions.LinkEditorAction;

import org.eclipse.ui.internal.navigator.extensions.LinkHelperService;

import org.eclipse.ui.navigator.CommonNavigator;

import org.eclipse.ui.navigator.CommonViewer;

import org.eclipse.ui.navigator.INavigatorViewerDescriptor;

/**

 * 

 * 

 * @since 3.5

 */

public class CommonNavigatorViewActionGroup extends CommonNavigatorActionGroup {

	private LinkEditorAction toggleLinkingAction;

	private final LinkHelperService linkHelperService;

	/**

	 * Create a action group for Collapse All, Link with editor, and Select

	 * Filters.

	 * 

	 * @param aNavigator

	 *            The IViewPart for this action group

	 * @param aViewer

	 *            The Viewer for this action group

	 * @param linkHelperService

	 *            the link service helper

	 */

	public CommonNavigatorViewActionGroup(CommonNavigator aNavigator,

			CommonViewer aViewer, LinkHelperService linkHelperService) {

		super(aNavigator, aViewer);

		this.linkHelperService = linkHelperService;

		makeViewActions();

	}

	/**

	 * 

	 */

	private void makeViewActions() {

		IHandlerService service = (IHandlerService) getCommonNavigator()

				.getWorkbenchSite().getService(IHandlerService.class);

		INavigatorViewerDescriptor viewerDescriptor = getCommonViewer()

				.getNavigatorContentService().getViewerDescriptor();

		boolean hideLinkWithEditorAction = viewerDescriptor

				.getBooleanConfigProperty(INavigatorViewerDescriptor.PROP_HIDE_LINK_WITH_EDITOR_ACTION);

		if (!hideLinkWithEditorAction) {

			toggleLinkingAction = new LinkEditorAction(

					(CommonNavigator) getCommonNavigator(), getCommonViewer(),

					linkHelperService);

			ImageDescriptor syncIcon = getImageDescriptor("elcl16/synced.gif"); //$NON-NLS-1$

			toggleLinkingAction.setImageDescriptor(syncIcon);

			toggleLinkingAction.setHoverImageDescriptor(syncIcon);

			service.activateHandler(

					toggleLinkingAction.getActionDefinitionId(),

					new ActionHandler(toggleLinkingAction));

		}

	}

	/*

	 * (non-Javadoc)

	 * 

	 * @see

	 * org.eclipse.ui.actions.ActionGroup#fillActionBars(org.eclipse.ui.IActionBars

	 * )

	 */

	public void fillActionBars(IActionBars theActionBars) {

		super.fillActionBars(theActionBars);

		IMenuManager menu = theActionBars.getMenuManager();

		if (toggleLinkingAction != null) {

			menu

					.insertAfter(IWorkbenchActionConstants.MB_ADDITIONS

							+ "-end", toggleLinkingAction); //$NON-NLS-1$

			theActionBars.getToolBarManager().add(toggleLinkingAction);

		}

		theActionBars.updateActionBars();

	}

	/*

	 * (non-Javadoc)

	 * 

	 * @see org.eclipse.ui.actions.ActionGroup#dispose()

	 */

	public void dispose() {

		super.dispose();

		if (toggleLinkingAction != null) {

			toggleLinkingAction.dispose();

		}

	}

}

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

 * Copyright (c) 2008 Anyware Technologies

 * 

 * 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:

 *    Anyware Technologies - initial API and implementation

 *

 * $Id$

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

package org.eclipse.ui.navigator;

import org.eclipse.jface.viewers.DoubleClickEvent;

import org.eclipse.jface.viewers.IDoubleClickListener;

import org.eclipse.jface.viewers.ISelection;

import org.eclipse.jface.viewers.ISelectionChangedListener;

import org.eclipse.jface.viewers.IStructuredSelection;

import org.eclipse.jface.viewers.TreeViewer;

import org.eclipse.jface.viewers.ViewerFilter;

import org.eclipse.swt.SWT;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Control;

import org.eclipse.ui.IActionBars;

import org.eclipse.ui.IMemento;

import org.eclipse.ui.IWorkbenchSite;

import org.eclipse.ui.actions.ActionGroup;

import org.eclipse.ui.internal.navigator.CommonNavigatorActionGroup;

import org.eclipse.ui.internal.navigator.CommonNavigatorManager;

import org.eclipse.ui.internal.navigator.CommonNavigatorMessages;

import org.eclipse.ui.part.Page;

import org.eclipse.ui.views.contentoutline.IContentOutlinePage;

/**

 * <p>

 * This class provides an implementation of Common Navigator hosted in an

 * IContentOutlinePage.

 * 

 * </p>

 * Clients that wish to extend the view menu provided via the

 * <b>org.eclipse.ui.popupMenu</b>s extension may specify the the

 * <i>popupMenuId</i> specified by <b>org.eclipse.ui.navigator.viewer</b> (or a

 * nested <b>popupMenu</b> element) of their target viewer as their target menu

 * id.

 * 

 * @since 3.5

 */

public abstract class CommonNavigatorOutline extends Page implements

		IContentOutlinePage, ICommonNavigator {

	private static final Class INAVIGATOR_CONTENT_SERVICE = INavigatorContentService.class;

	private static final Class COMMON_VIEWER_CLASS = CommonViewer.class;

	private CommonViewer commonViewer;

	private CommonNavigatorManager commonManager;

	private ActionGroup commonActionGroup;

	private IMemento memento;

	/**

	 * 

	 */

	public CommonNavigatorOutline() {

		super();

	}

	/**

	 * <p>

	 * Returns The id used to initialize the Common Viewer from extensions. It

	 * is recommended to use the same id as the editor providing this Outline.

	 * </p>

	 * 

	 * @return The Id of the Common Viewer

	 */

	protected abstract String getCommonViewerId();

	/**

	 * <p>

	 * Constructs and returns an instance of {@link CommonViewer}. The ID from

	 * <code>getCommonViewer()</code> will be used to create the viewer. The ID

	 * is important as some extensions indicate they should only be used with a

	 * particular viewer ID.

	 * <p>

	 * 

	 * @param aParent

	 *            A composite parent to contain the Common Viewer

	 * @return An initialized instance of CommonViewer

	 */

	protected CommonViewer createCommonViewer(Composite aParent) {

		CommonViewer aViewer = new CommonViewer(getCommonViewerId(), aParent,

				SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL);

		initListeners(aViewer);

		aViewer.getNavigatorContentService().restoreState(memento);

		return aViewer;

	}

	/**

	 * <p>

	 * Adds the listeners to the Common Viewer.

	 * </p>

	 * 

	 * @param viewer

	 *            The viewer

	 * @since 2.0

	 */

	protected void initListeners(TreeViewer viewer) {

		viewer.addDoubleClickListener(new IDoubleClickListener() {

			public void doubleClick(DoubleClickEvent event) {

				try {

					handleDoubleClick(event);

				} catch (RuntimeException re) {

					re.printStackTrace();

				}

			}

		});

	}

	/**

	 * <p>

	 * This method can be overridden to customize the behavior of the double

	 * click.

	 * </p>

	 * 

	 * @param anEvent

	 *            Supplied by the DoubleClick listener.

	 */

	protected void handleDoubleClick(DoubleClickEvent anEvent) {

		IStructuredSelection selection = (IStructuredSelection) anEvent

				.getSelection();

		Object element = selection.getFirstElement();

		TreeViewer viewer = getCommonViewer();

		if (viewer.isExpandable(element)) {

			viewer.setExpandedState(element, !viewer.getExpandedState(element));

		}

	}

	/**

	 * <p>

	 * The Common Navigator Manager handles the setup of the Common Navigator

	 * Menu, manages updates to the ActionBars from {@link CommonActionProvider}

	 *   extensions as the user's selection changes, and also updates the

	 * status bar based on the current selection.

	 * 

	 * @return The Common Navigator Manager class which handles menu population

	 *         and ActionBars

	 */

	protected CommonNavigatorManager createCommonManager() {

		return new CommonNavigatorManager(this, memento);

	}

	/**

	 * <p>

	 * The ActionGroup is used to populate the ActionBars of Common Navigator ,

	 * and the returned implementation will have an opportunity to fill the

	 * ActionBars of the outline as soon as it is created. (

	 * {@link ActionGroup#fillActionBars(org.eclipse.ui.IActionBars)}.

	 * </p>

	 * <p>

	 * The default implementation returns an action group which will add the

	 * following actions:

	 * <ul>

	 * <li>

	 * <li>

	 * <p>

	 * Collapse all. Collapses all expanded nodes.

	 * </p>

	 * <li>

	 * <p>

	 * Select Filters. Provides access to the "Select Filters" dialog that

	 * allows users to enable/disable filters and also the Content Extension

	 * activations.

	 * </p>

	 * </ul>

	 * 

	 * @return The Action Group to be associated with the Common Navigator View

	 *         Part.

	 */

	protected ActionGroup createCommonActionGroup() {

		return new CommonNavigatorActionGroup(this, commonViewer);

	}

	/**

	 * @see org.eclipse.ui.part.Page#createControl(org.eclipse.swt.widgets.Composite)

	 */

	public void createControl(Composite parent) {

		commonViewer = createCommonViewer(parent);

		try {

			commonViewer.getControl().setRedraw(false);

			INavigatorFilterService filterService = commonViewer

					.getNavigatorContentService().getFilterService();

			ViewerFilter[] visibleFilters = filterService

					.getVisibleFilters(true);

			for (int i = 0; i < visibleFilters.length; i++) {

				commonViewer.addFilter(visibleFilters[i]);

			}

			commonViewer.setSorter(new CommonViewerSorter());

			/*

			 * make sure input is set after sorters and filters to avoid

			 * unnecessary refreshes

			 */

			commonViewer.setInput(getInitialInput());

			getSite().setSelectionProvider(commonViewer);

		} finally {

			commonViewer.getControl().setRedraw(true);

		}

		/*

		 * Create the CommonNavigatorManager last because information about the

		 * state of the CommonNavigator is required for the initialization of

		 * the CommonNavigatorManager

		 */

		commonManager = createCommonManager();

		if (memento != null) {

			commonViewer.getNavigatorContentService().restoreState(memento);

		}

		commonActionGroup = createCommonActionGroup();

		commonActionGroup.fillActionBars(getActionBars());

	}

	/**

	 * <p>

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

	 * method.

	 * </p>

	 * <p>

	 * This method will be invoked when the DisposeListener is notified of the

	 * disposal of the Eclipse view part.

	 * </p>

	 * 

	 * @see org.eclipse.ui.part.WorkbenchPart#dispose()

	 */

	public void dispose() {

		if (commonManager != null) {

			commonManager.dispose();

		}

		if (commonActionGroup != null) {

			commonActionGroup.dispose();

		}

		super.dispose();

	}

	/**

	 * @see org.eclipse.ui.part.Page#getControl()

	 */

	public Control getControl() {

		return commonViewer.getControl();

	}

	/**

	 * Returns an object which is an instance of the given class associated with

	 * this object. Returns <code>null</code> if no such object can be found.

	 * 

	 * @param adapter

	 *            the adapter class to look up

	 * @return a object castable to the given class, or <code>null</code> if

	 *         this object does not have an adapter for the given class

	 */

	public Object getAdapter(Class adapter) {

		if (adapter == COMMON_VIEWER_CLASS) {

			return getCommonViewer();

		} else if (adapter == INAVIGATOR_CONTENT_SERVICE) {

			return getCommonViewer().getNavigatorContentService();

		}

		return null;

	}

	/**

	 * @see org.eclipse.ui.part.Page#setFocus()

	 */

	public void setFocus() {

		if (commonViewer != null) {

			commonViewer.getTree().setFocus();

		}

	}

	/**

	 * <p>

	 * Subclasses should override this method to define the initial input of the

	 * Common Navigator Outline.

	 * </p>

	 * 

	 * @return The initial input for the viewer. Defaults to

	 *         getSite().getPage().getInput()

	 */

	protected Object getInitialInput() {

		return getSite().getPage().getInput();

	}

	/**

	 * @see org.eclipse.jface.viewers.ISelectionProvider#addSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener)

	 */

	public void addSelectionChangedListener(ISelectionChangedListener listener) {

		getCommonViewer().addSelectionChangedListener(listener);

	}

	/**

	 * @see org.eclipse.jface.viewers.ISelectionProvider#getSelection()

	 */

	public ISelection getSelection() {

		return getCommonViewer().getSelection();

	}

	/**

	 * @see org.eclipse.jface.viewers.ISelectionProvider#removeSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener)

	 */

	public void removeSelectionChangedListener(

			ISelectionChangedListener listener) {

		getCommonViewer().removeSelectionChangedListener(listener);

	}

	/**

	 * @see org.eclipse.jface.viewers.ISelectionProvider#setSelection(org.eclipse.jface.viewers.ISelection)

	 */

	public void setSelection(ISelection selection) {

		getCommonViewer().setSelection(selection);

	}

	/**

	 * @see org.eclipse.ui.navigator.ICommonNavigator#getActionBars()

	 */

	public IActionBars getActionBars() {

		return getSite().getActionBars();

	}

	/**

	 * @see org.eclipse.ui.navigator.ICommonNavigator#getCommonViewer()

	 */

	public CommonViewer getCommonViewer() {

		return commonViewer;

	}

	/**

	 * @see org.eclipse.ui.navigator.ICommonNavigator#getCommonViewerSite()

	 */

	public ICommonViewerSite getCommonViewerSite() {

		return CommonViewerSiteFactory.createCommonViewerSite(

				getCommonViewerId(), getSite());

	}

	/**

	 * @return The Navigator Content Service which populates this instance of

	 *         Common Navigator

	 */

	public INavigatorContentService getNavigatorContentService() {

		return getCommonViewer().getNavigatorContentService();

	}

	/**

	 * @see org.eclipse.ui.navigator.ICommonNavigator#getTitle()

	 */

	public String getTitle() {

		return CommonNavigatorMessages.CommonNavigatorOutline_DefaultTitle;

	}

	/**

	 * @see org.eclipse.ui.navigator.ICommonNavigator#getWorkbenchSite()

	 */

	public IWorkbenchSite getWorkbenchSite() {

		return getSite();

	}

	/**

	 * <p>

	 * Set the selection to the Common Navigator tree, and expand nodes if

	 * necessary. Use caution when invoking this method as it can cause

	 * Navigator Content Extensions to load, thus causing plugin activation.

	 * </p>

	 * 

	 * @see org.eclipse.ui.part.ISetSelectionTarget#selectReveal(org.eclipse.jface.viewers.ISelection)

	 */

	public void selectReveal(ISelection selection) {

		if (commonViewer != null) {

			if (selection instanceof IStructuredSelection) {

				Object[] newSelection = ((IStructuredSelection) selection)

						.toArray();

				Object[] expandedElements = commonViewer.getExpandedElements();

				Object[] newExpandedElements = new Object[newSelection.length

						+ expandedElements.length];

				System.arraycopy(expandedElements, 0, newExpandedElements, 0,

						expandedElements.length);

				System.arraycopy(newSelection, 0, newExpandedElements,

						expandedElements.length, newSelection.length);

				commonViewer.setExpandedElements(newExpandedElements);

			}

			commonViewer.setSelection(selection, true);

		}

	}

}