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