PATCH-1559330: PHPDoc comments are garbled in function hover. Applied patch and refac...
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / ui / IPackagesViewPart.java
1 /*******************************************************************************
2  * Copyright (c) 2000, 2004 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials 
4  * are made available under the terms of the Common Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v10.html
7  * 
8  * Contributors:
9  *     IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package net.sourceforge.phpdt.ui;
12
13 import org.eclipse.jface.viewers.TreeViewer;
14 import org.eclipse.ui.IViewPart;
15
16 /**
17  * The standard Packages view presents a Java-centric view of the workspace.
18  * Within Java projects, the resource hierarchy is organized into Java packages
19  * as described by the project's classpath. Note that this view shows both Java
20  * elements and ordinary resources.
21  * <p>
22  * This interface is not intended to be implemented by clients.
23  * </p>
24  * 
25  * @see JavaUI#ID_PACKAGES
26  */
27 public interface IPackagesViewPart extends IViewPart {
28         /**
29          * Selects and reveals the given element in this packages view. The tree
30          * will be expanded as needed to show the element.
31          * 
32          * @param element
33          *            the element to be revealed
34          */
35         void selectAndReveal(Object element);
36
37         /**
38          * Returns the TreeViewer shown in the Packages view.
39          * 
40          * @return the tree viewer used in the Packages view
41          * 
42          * @since 2.0
43          */
44         TreeViewer getTreeViewer();
45 }