org.eclipse.jdt.internal.ui.typehierarchy

Class TypeHierarchyViewPart [ source ]

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.ViewPart

org.eclipse.jdt.internal.ui.typehierarchy.TypeHierarchyViewPart

All Implemented Interfaces:

IAdaptable, IExecutableExtension, IViewPartInputProvider, ITypeHierarchyViewPart, IPersistable, IViewPart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPart3, IWorkbenchPartOrientation

public class TypeHierarchyViewPart
extends ViewPart
implements ITypeHierarchyViewPart, IViewPartInputProvider

View showing the super types/sub types of its input.

Field Summary

Fields inherited from interface org.eclipse.jdt.ui.ITypeHierarchyViewPart

HIERARCHY_MODE_CLASSIC, HIERARCHY_MODE_SUBTYPES, HIERARCHY_MODE_SUPERTYPES, VIEW_LAYOUT_AUTOMATIC, VIEW_LAYOUT_HORIZONTAL, VIEW_LAYOUT_SINGLE, VIEW_LAYOUT_VERTICAL

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

Constructors

Constructor and Description
TypeHierarchyViewPart()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearNeededRefresh()
void	createPartControl(Composite container) Returns the inner component in a workbench part.
void	dispose() The WorkbenchPart implementation of this IWorkbenchPart method disposes the title image loaded by setInitializationData.
protected void	doPropertyChange(PropertyChangeEvent event)
(package private) void	doRestoreState(IMemento memento, IJavaElement input)
protected void	doSelectionChanged(SelectionChangedEvent e)
protected void	doTypeHierarchyChanged(TypeHierarchyLifeCycle typeHierarchy, IType[] changedTypes) Called from ITypeHierarchyLifeCycleListener.
protected void	doTypeHierarchyChangedOnViewers(IType[] changedTypes)
protected void	editorActivated(IEditorPart editor) Link selection to active editor.
Object	getAdapter(Class key) Returns an object which is an instance of the given class associated with this object.
int	getHierarchyMode() Returns the currently configured hierarchy mode.
IJavaElement[]	getHistoryEntries() Gets all history entries.
IType	getInput() Deprecated. use getInputElement instead
IJavaElement	getInputElement() Returns the input element of the type hierarchy.
protected IShowInSource	getShowInSource()
int	getViewLayout() Returns the currently configured view layout.
Object	getViewPartInput() Returns the input.
void	gotoHistoryEntry(IJavaElement entry) Goes to the selected entry, without updating the order of history entries.
void	init(IViewSite site, IMemento memento) Initializes this view with the given view site.
boolean	isLinkingEnabled() Returns whether this type hierarchy view's selection automatically tracks the active editor.
boolean	isQualifiedTypeNamesEnabled() If set, type names are shown with the parent container's name.
boolean	isShowMembersInHierarchy() If set, the lock mode is enabled.
void	saveState(IMemento memento) Saves the object state within a memento.
void	selectMember(IMember member) Selects an member in the methods list or in the current hierarchy.
void	setFocus() Asks this part to take focus within the workbench.
void	setHierarchyMode(int viewerIndex) Sets the hierarchy mode.
void	setHistoryEntries(IJavaElement[] elems) Sets the history entries
void	setInput(IType type) Deprecated. use setInputElement instead
void	setInputElement(IJavaElement element) Sets the input to a new element.
void	setLinkingEnabled(boolean enabled) Sets whether this type hierarchy view's selection automatically tracks the active editor.
void	setViewLayout(int layout) Sets the view layout.
void	showMembersInHierarchy(boolean on) Locks the the members view and shows the selected members in the hierarchy.
void	showQualifiedTypeNames(boolean on) Specifies if type names are shown with the parent container's name.
protected void	visibilityChanged(boolean isVisible) View part becomes visible.

Methods inherited from class org.eclipse.ui.part.ViewPart

checkSite, getViewSite, init, setContentDescription, setInitializationData, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.ui.IViewPart

getViewSite, init

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

Constructor Detail

TypeHierarchyViewPart

public TypeHierarchyViewPart()

Method Detail

doPropertyChange

protected void doPropertyChange(PropertyChangeEvent event)

gotoHistoryEntry

public void gotoHistoryEntry(IJavaElement entry)

Goes to the selected entry, without updating the order of history entries.

Parameters:

entry - The entry to open

getHistoryEntries

public IJavaElement[] getHistoryEntries()

Gets all history entries.

Returns:

All history entries

setHistoryEntries

public void setHistoryEntries(IJavaElement[] elems)

Sets the history entries

Parameters:

elems - The history elements to set

selectMember

public void selectMember(IMember member)

Selects an member in the methods list or in the current hierarchy.

Parameters:

member - The member to select

getInput

public IType getInput()

Deprecated. use getInputElement instead

Returns the input element of this type hierarchy view.

Specified by:

getInput in interface ITypeHierarchyViewPart

Returns:

the input element, or null if no input element is set

See Also:

ITypeHierarchyViewPart.setInput(IType)

setInput

public void setInput(IType type)

Deprecated. use setInputElement instead

Sets the input element of this type hierarchy view to a type.

Specified by:

setInput in interface ITypeHierarchyViewPart

Parameters:

type - the input element of this type hierarchy view, or null to clear any input element

getInputElement

public IJavaElement getInputElement()

Returns the input element of the type hierarchy. Can be of type IType or IPackageFragment

Specified by:

getInputElement in interface ITypeHierarchyViewPart

Returns:

the input element

See Also:

ITypeHierarchyViewPart.setInputElement(IJavaElement)

setInputElement

public void setInputElement(IJavaElement element)

Sets the input to a new element.

Specified by:

setInputElement in interface ITypeHierarchyViewPart

Parameters:

element - the input element

setFocus

public void setFocus()

Description copied from interface: IWorkbenchPart

Asks this part to take focus within the workbench. Parts must assign focus to one of the controls contained in the part's parent composite.

Clients should not call this method (the workbench calls this method at appropriate times). To have the workbench activate a part, use IWorkbenchPage.activate(IWorkbenchPart) instead.

Specified by:

setFocus in interface IWorkbenchPart

Specified by:

setFocus in class WorkbenchPart

dispose

public void dispose()

Description copied from class: WorkbenchPart

The WorkbenchPart implementation of this IWorkbenchPart method disposes the title image loaded by setInitializationData. Subclasses may extend.

Specified by:

dispose in interface IWorkbenchPart

Overrides:

dispose in class WorkbenchPart

getAdapter

public Object getAdapter(Class key)

Description copied from class: WorkbenchPart

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found. Subclasses may override this method (however, if they do so, they should invoke the method on their superclass to ensure that the Platform's adapter manager is consulted).

Specified by:

getAdapter in interface IAdaptable

Overrides:

getAdapter in class WorkbenchPart

Parameters:

key - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class

createPartControl

public void createPartControl(Composite container)

Returns the inner component in a workbench part.

Specified by:

createPartControl in interface IWorkbenchPart

Specified by:

createPartControl in class WorkbenchPart

Parameters:

container - the parent control

See Also:

IWorkbenchPart.createPartControl(Composite)

setViewLayout

public void setViewLayout(int layout)

Description copied from interface: ITypeHierarchyViewPart

Sets the view layout. Valid inputs are ITypeHierarchyViewPart.VIEW_LAYOUT_VERTICAL, ITypeHierarchyViewPart.VIEW_LAYOUT_HORIZONTAL ITypeHierarchyViewPart.VIEW_LAYOUT_SINGLE and ITypeHierarchyViewPart.VIEW_LAYOUT_AUTOMATIC.

Specified by:

setViewLayout in interface ITypeHierarchyViewPart

Parameters:

layout - The layout to set

getViewLayout

public int getViewLayout()

Description copied from interface: ITypeHierarchyViewPart

Returns the currently configured view layout. Possible layouts are ITypeHierarchyViewPart.VIEW_LAYOUT_VERTICAL, ITypeHierarchyViewPart.VIEW_LAYOUT_HORIZONTAL ITypeHierarchyViewPart.VIEW_LAYOUT_SINGLE and ITypeHierarchyViewPart.VIEW_LAYOUT_AUTOMATIC but clients should also be able to handle yet unknown layout.

Specified by:

getViewLayout in interface ITypeHierarchyViewPart

Returns:

The layout currently set

doSelectionChanged

protected void doSelectionChanged(SelectionChangedEvent e)

setHierarchyMode

public void setHierarchyMode(int viewerIndex)

Description copied from interface: ITypeHierarchyViewPart

Sets the hierarchy mode. Valid modes are ITypeHierarchyViewPart.HIERARCHY_MODE_SUBTYPES, ITypeHierarchyViewPart.HIERARCHY_MODE_SUPERTYPES and ITypeHierarchyViewPart.HIERARCHY_MODE_CLASSIC.

Specified by:

setHierarchyMode in interface ITypeHierarchyViewPart

Parameters:

viewerIndex - The hierarchy mode to set

getHierarchyMode

public int getHierarchyMode()

Description copied from interface: ITypeHierarchyViewPart

Returns the currently configured hierarchy mode. Possible modes are ITypeHierarchyViewPart.HIERARCHY_MODE_SUBTYPES, ITypeHierarchyViewPart.HIERARCHY_MODE_SUPERTYPES and ITypeHierarchyViewPart.HIERARCHY_MODE_CLASSIC but clients should also be able to handle yet unknown modes.

Specified by:

getHierarchyMode in interface ITypeHierarchyViewPart

Returns:

The hierarchy mode currently set

showMembersInHierarchy

public void showMembersInHierarchy(boolean on)

Description copied from interface: ITypeHierarchyViewPart

Locks the the members view and shows the selected members in the hierarchy.

Specified by:

showMembersInHierarchy in interface ITypeHierarchyViewPart

Parameters:

on - If set, the members view will be locked and the selected members are shown in the hierarchy.

isShowMembersInHierarchy

public boolean isShowMembersInHierarchy()

Description copied from interface: ITypeHierarchyViewPart

If set, the lock mode is enabled.

Specified by:

isShowMembersInHierarchy in interface ITypeHierarchyViewPart

Returns:

returns if the lock mode is enabled.

showQualifiedTypeNames

public void showQualifiedTypeNames(boolean on)

Description copied from interface: ITypeHierarchyViewPart

Specifies if type names are shown with the parent container's name.

Specified by:

showQualifiedTypeNames in interface ITypeHierarchyViewPart

Parameters:

on - if enabled, the hierarchy will also show the type container names

isQualifiedTypeNamesEnabled

public boolean isQualifiedTypeNamesEnabled()

Description copied from interface: ITypeHierarchyViewPart

If set, type names are shown with the parent container's name.

Specified by:

isQualifiedTypeNamesEnabled in interface ITypeHierarchyViewPart

Returns:

returns if type names are shown with the parent container's name.

doTypeHierarchyChanged

protected void doTypeHierarchyChanged(TypeHierarchyLifeCycle typeHierarchy,
                          IType[] changedTypes)

Called from ITypeHierarchyLifeCycleListener. Can be called from any thread

Parameters:

typeHierarchy - Hierarchy that has changed

changedTypes - Types in the hierarchy that have change or null if the full hierarchy has changed

doTypeHierarchyChangedOnViewers

protected void doTypeHierarchyChangedOnViewers(IType[] changedTypes)

init

public void init(IViewSite site,
        IMemento memento)
          throws PartInitException

Description copied from interface: IViewPart

Initializes this view with the given view site. A memento is passed to the view which contains a snapshot of the views state from a previous session. Where possible, the view should try to recreate that state within the part controls.

This method is automatically called by the workbench shortly after the part is instantiated. It marks the start of the views's lifecycle. Clients must not call this method.

Specified by:

init in interface IViewPart

Overrides:

init in class ViewPart

Parameters:

site - the view site

memento - the IViewPart state or null if there is no previous saved state

Throws:

PartInitException - if this view was not initialized successfully

saveState

public void saveState(IMemento memento)

Description copied from interface: IViewPart

Saves the object state within a memento.

Specified by:

saveState in interface IPersistable

Specified by:

saveState in interface IViewPart

Overrides:

saveState in class ViewPart

Parameters:

memento - a memento to receive the object state

doRestoreState

final void doRestoreState(IMemento memento,
                  IJavaElement input)

visibilityChanged

protected void visibilityChanged(boolean isVisible)

View part becomes visible.

Parameters:

isVisible - true if visible

editorActivated

protected void editorActivated(IEditorPart editor)

Link selection to active editor.

Parameters:

editor - The activated editor

getViewPartInput

public Object getViewPartInput()

Description copied from interface: IViewPartInputProvider

Returns the input.

Specified by:

getViewPartInput in interface IViewPartInputProvider

Returns:

the input object

getShowInSource

protected IShowInSource getShowInSource()

Returns:

Returns the IShowInSource for this view.

isLinkingEnabled

public boolean isLinkingEnabled()

Description copied from interface: ITypeHierarchyViewPart

Returns whether this type hierarchy view's selection automatically tracks the active editor.

Specified by:

isLinkingEnabled in interface ITypeHierarchyViewPart

Returns:

true if linking is enabled, false if not

setLinkingEnabled

public void setLinkingEnabled(boolean enabled)

Description copied from interface: ITypeHierarchyViewPart

Sets whether this type hierarchy view's selection automatically tracks the active editor.

Specified by:

setLinkingEnabled in interface ITypeHierarchyViewPart

Parameters:

enabled - true to enable, false to disable

clearNeededRefresh

public void clearNeededRefresh()