net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/ui/ITypeHierarchyViewPart.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
  14 import org.eclipse.ui.IViewPart;
  15
  16 import net.sourceforge.phpdt.core.IJavaElement;
  17 import net.sourceforge.phpdt.core.IType;
  18
  19 /**
  20  * The standard type hierarchy view presents a type hierarchy for a given input class
  21  * or interface. Visually, this view consists of a pair of viewers, one showing the type
  22  * hierarchy, the other showing the members of the type selected in the first.
  23  * <p>
  24  * This interface is not intended to be implemented by clients.
  25  * </p>
  26  *
  27  * @see JavaUI#ID_TYPE_HIERARCHY
  28  */
  29 public interface ITypeHierarchyViewPart extends IViewPart {
  30
  31         /**
  32          * Sets the input element of this type hierarchy view to a type.
  33          *
  34          * @param type the input element of this type hierarchy view, or <code>null</code>
  35          *  to clear any input element
  36          * @deprecated use setInputElement instead
  37          */
  38         public void setInput(IType type);
  39
  40         /**
  41          * Sets the input element of this type hierarchy view. The following input types are possible
  42          * <code>IMember</code> (types, methods, fields..), <code>IPackageFragment</code>, <code>IPackageFragmentRoot</code>
  43          * and <code>IJavaProject</code>.
  44          *
  45          * @param element the input element of this type hierarchy view, or <code>null</code>
  46          *  to clear any input
  47          *
  48          * @since 2.0
  49          */
  50         public void setInputElement(IJavaElement element);
  51
  52         /**
  53          * Returns the input element of this type hierarchy view.
  54          *
  55          * @return the input element, or <code>null</code> if no input element is set
  56          * @see #setInput(IType)
  57          * @deprecated use getInputElement instead
  58          */
  59         public IType getInput();
  60
  61
  62         /**
  63          * Returns the input element of this type hierarchy view.
  64          *
  65          * @return the input element, or <code>null</code> if no input element is set
  66          * @see #setInputElement(IJavaElement)
  67          *
  68          * @since 2.0
  69          */
  70         public IJavaElement getInputElement();
  71 }