org.eclipse.hyades.ui.internal.navigator
Class TreeNavigator

java.lang.Object
  org.eclipse.core.commands.common.EventManager
      org.eclipse.ui.part.WorkbenchPart
          org.eclipse.ui.part.ViewPart
              org.eclipse.hyades.ui.internal.navigator.Navigator
                  org.eclipse.hyades.ui.internal.navigator.TreeNavigator

All Implemented Interfaces:

java.util.EventListener, org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, INavigator, ITreeNavigator, org.eclipse.hyades.ui.util.IDisposable, org.eclipse.jface.action.IMenuListener, org.eclipse.jface.util.IPropertyChangeListener, org.eclipse.jface.viewers.IDoubleClickListener, org.eclipse.jface.viewers.IOpenListener, org.eclipse.jface.viewers.ISelectionChangedListener, org.eclipse.swt.events.KeyListener, org.eclipse.swt.internal.SWTEventListener, org.eclipse.ui.IPartListener, org.eclipse.ui.IPersistable, org.eclipse.ui.ISelectionListener, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.ISetSelectionTarget, org.eclipse.ui.part.IWorkbenchPartOrientation

public abstract class TreeNavigator
extends Navigator
implements ITreeNavigator, org.eclipse.jface.viewers.IDoubleClickListener, org.eclipse.jface.util.IPropertyChangeListener

Implementation of the ITreeNavigator interface.

Field Summary

protected org.eclipse.ui.views.framelist.FrameList	frameList
protected static java.lang.String	SET_WORKING_SET
protected static java.lang.String	TAG_EXPAND_STATE
protected static java.lang.String	TAG_FRAME
protected org.eclipse.ui.ResourceWorkingSetFilter	workingSetFilter

Fields inherited from class org.eclipse.hyades.ui.internal.navigator.Navigator

actionGroup, activeNavigator, ID_POPUP_MENU, initialViewerInput, layout, linkingEnabled, memento, navigatorID, SET_LINK_TO_EDITOR, settings, structuredViewer, TAG_ELEMENT, TAG_FACTORY_ID, TAG_SELECTION, TAG_STORE_VALUE

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

TreeNavigator(java.lang.String navigatorID)
Constructor for TreeNavigator

Method Summary

protected void	adjustTreeViewer(org.eclipse.jface.viewers.TreeViewer treeViewer) Subclasses may extend this method to customize the tree viewer.
protected org.eclipse.ui.views.framelist.FrameList	createFrameList() Creates the frame source and frame list, and connects them.
protected TreeNavigatorFrameSource	createFrameSource() Creates the frame source to be associated with this navigator.
protected org.eclipse.jface.viewers.StructuredViewer	createViewer(org.eclipse.swt.widgets.Composite parent) Creates the viewer that is displayed by this navigator.
protected org.eclipse.ui.ResourceWorkingSetFilter	createWorkingSetFilter() Creates the WorkingSetFilter.
void	dispose()
void	doubleClick(org.eclipse.jface.viewers.DoubleClickEvent event)
org.eclipse.ui.views.framelist.FrameList	getFrameList() Returns the frame list for this navigator.
java.lang.String	getFrameName(java.lang.Object element) Returns the name for the given element to be used as the name for the current frame.
java.lang.String	getFrameToolTipText(java.lang.Object element) Returns the tool tip text for the given element to be used as the tool tip text for the current frame, and for the view title tooltip.
org.eclipse.jface.viewers.TreeViewer	getTreeViewer() Returns this navigator's tree viewer.
org.eclipse.ui.IWorkingSet	getWorkingSet() Returns the working set for this view or null if none is defined.
protected org.eclipse.ui.ResourceWorkingSetFilter	getWorkingSetFilter() Returns the WorkingSetFilter.
protected void	initContextMenu() Initializes and registers the context menu.
protected void	initWorkingSet() Initializes the working set.
protected void	loadExpandState(org.eclipse.ui.IMemento memento) Loads the previous expand state from the memento.
protected boolean	loadFrame(org.eclipse.ui.IMemento memento) Loades the previous frame state from the memento returning whether the frame state was restored.
protected void	loadMemento(org.eclipse.ui.IMemento memento) Loads the information persisted in the memento.
protected void	loadSettings() Loads the settings from the dialog settings buffer.
void	propertyChange(org.eclipse.jface.util.PropertyChangeEvent event)
protected void	saveExpandState(org.eclipse.ui.IMemento memento) Saves the current expand state in the memento.
protected boolean	saveFrame(org.eclipse.ui.IMemento memento) Saves the previous frame state in the memento returning whether the frame information was saved.
void	saveState(org.eclipse.ui.IMemento memento) This class' memento keys corresponds to the "TAG_" string constants.
void	setWorkingSet(org.eclipse.ui.IWorkingSet workingSet) Sets the working set for this view, or null to clear it.
void	updateTitle() Updates the title text and title tool tip.

Methods inherited from class org.eclipse.hyades.ui.internal.navigator.Navigator

convertFromViewer, convertToViewer, createActions, createPartControl, createViewerInput, editorActivated, getActionGroup, getHelpContextId, getID, getInitialViewerInput, getLayout, getSettings, getStatusLineMessage, getStoreSection, getStructuredSelection, getViewContentProvider, getViewer, getViewLabelProvider, handleChange, init, initSettings, isActiveNavigator, isInitialized, isLinkingEnabled, keyPressed, keyReleased, linkToEditor, loadElements, loadSelection, menuAboutToShow, open, partActivated, partBroughtToTop, partClosed, partDeactivated, partOpened, saveElement, saveSelection, selectionChanged, selectionChanged, selectReveal, setActionGroup, setFocus, setLayout, setLinkingEnabled, updateActionBars, updateStatusLine

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, getAdapter, 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.hyades.ui.internal.navigator.INavigator

getID, getLayout, getPlugin, getSite, getStructuredSelection, getViewer, getViewSite, handleChange, isInitialized, isLinkingEnabled, isShowingFolders, setLayout, setLinkingEnabled

Methods inherited from interface org.eclipse.ui.part.ISetSelectionTarget

selectReveal

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Field Detail

SET_WORKING_SET

protected static final java.lang.String SET_WORKING_SET

See Also:

Constant Field Values

TAG_FRAME

protected static final java.lang.String TAG_FRAME

See Also:

Constant Field Values

TAG_EXPAND_STATE

protected static final java.lang.String TAG_EXPAND_STATE

See Also:

Constant Field Values

frameList

protected org.eclipse.ui.views.framelist.FrameList frameList

workingSetFilter

protected org.eclipse.ui.ResourceWorkingSetFilter workingSetFilter

Constructor Detail

TreeNavigator

public TreeNavigator(java.lang.String navigatorID)

Constructor for TreeNavigator

Method Detail

dispose

public void dispose()

Specified by:

dispose in interface org.eclipse.hyades.ui.util.IDisposable

Specified by:

dispose in interface org.eclipse.ui.IWorkbenchPart

Overrides:

dispose in class Navigator

See Also:

IWorkbenchPart.dispose()

createWorkingSetFilter

protected org.eclipse.ui.ResourceWorkingSetFilter createWorkingSetFilter()

Creates the WorkingSetFilter.

Returns:

ResourceWorkingSetFilter

getWorkingSetFilter

protected org.eclipse.ui.ResourceWorkingSetFilter getWorkingSetFilter()

Returns the WorkingSetFilter.

Returns:

ResourceWorkingSetFilter

getTreeViewer

public org.eclipse.jface.viewers.TreeViewer getTreeViewer()

Description copied from interface: ITreeNavigator

Returns this navigator's tree viewer.

Specified by:

getTreeViewer in interface ITreeNavigator

Returns:

StructuredViewer

See Also:

ITreeNavigator.getTreeViewer()

loadSettings

protected void loadSettings()

Description copied from class: Navigator

Loads the settings from the dialog settings buffer. This class' setting keys corresponds to the "SET_" string constants.

Overrides:

loadSettings in class Navigator

See Also:

Navigator.loadSettings()

initWorkingSet

protected void initWorkingSet()

Initializes the working set.

createViewer

protected org.eclipse.jface.viewers.StructuredViewer createViewer(org.eclipse.swt.widgets.Composite parent)

Description copied from class: Navigator

Creates the viewer that is displayed by this navigator. Subclasses are responsible for setting the content and label provider and also to ensure that this method returns a valid value.

Specified by:

createViewer in class Navigator

Returns:

StructuredViewer

See Also:

Navigator.createViewer(org.eclipse.swt.widgets.Composite)

adjustTreeViewer

protected void adjustTreeViewer(org.eclipse.jface.viewers.TreeViewer treeViewer)

Subclasses may extend this method to customize the tree viewer. The method getTreeViewer() returns null in the scope of this method.

Parameters:

treeViewer -

doubleClick

public void doubleClick(org.eclipse.jface.viewers.DoubleClickEvent event)

Specified by:

doubleClick in interface org.eclipse.jface.viewers.IDoubleClickListener

See Also:

IDoubleClickListener.doubleClick(org.eclipse.jface.viewers.DoubleClickEvent)

loadMemento

protected void loadMemento(org.eclipse.ui.IMemento memento)

Description copied from class: Navigator

Loads the information persisted in the memento. This method is invoked after the creation of the UI controls.

Overrides:

loadMemento in class Navigator

See Also:

Navigator.loadMemento(org.eclipse.ui.IMemento)

saveState

public void saveState(org.eclipse.ui.IMemento memento)

Description copied from class: Navigator

This class' memento keys corresponds to the "TAG_" string constants.

Specified by:

saveState in interface org.eclipse.ui.IPersistable

Specified by:

saveState in interface org.eclipse.ui.IViewPart

Overrides:

saveState in class Navigator

See Also:

IViewPart.saveState(org.eclipse.ui.IMemento)

loadFrame

protected boolean loadFrame(org.eclipse.ui.IMemento memento)

Loades the previous frame state from the memento returning whether the frame state was restored.

Parameters:

memento -

Returns:

boolean

loadExpandState

protected void loadExpandState(org.eclipse.ui.IMemento memento)

Loads the previous expand state from the memento.

Parameters:

memento -

saveFrame

protected boolean saveFrame(org.eclipse.ui.IMemento memento)

Saves the previous frame state in the memento returning whether the frame information was saved.

Parameters:

memento -

Returns:

boolean

saveExpandState

protected void saveExpandState(org.eclipse.ui.IMemento memento)

Saves the current expand state in the memento.

Parameters:

memento -

setWorkingSet

public void setWorkingSet(org.eclipse.ui.IWorkingSet workingSet)

Sets the working set for this view, or null to clear it.

Specified by:

setWorkingSet in interface ITreeNavigator

Parameters:

workingSet - the working set, or null to clear it

getWorkingSet

public org.eclipse.ui.IWorkingSet getWorkingSet()

Returns the working set for this view or null if none is defined.

Specified by:

getWorkingSet in interface ITreeNavigator

Returns:

IWorkingSet

propertyChange

public void propertyChange(org.eclipse.jface.util.PropertyChangeEvent event)

Specified by:

propertyChange in interface org.eclipse.jface.util.IPropertyChangeListener

See Also:

IPropertyChangeListener.propertyChange(org.eclipse.jface.util.PropertyChangeEvent)

getFrameList

public org.eclipse.ui.views.framelist.FrameList getFrameList()

Description copied from interface: ITreeNavigator

Returns the frame list for this navigator.

Specified by:

getFrameList in interface ITreeNavigator

Returns:

FrameList

See Also:

ITreeNavigator.getFrameList()

getFrameName

public java.lang.String getFrameName(java.lang.Object element)

Description copied from interface: ITreeNavigator

Returns the name for the given element to be used as the name for the current frame.

Specified by:

getFrameName in interface ITreeNavigator

Returns:

String

See Also:

ITreeNavigator.getFrameName(java.lang.Object)

getFrameToolTipText

public java.lang.String getFrameToolTipText(java.lang.Object element)

Description copied from interface: ITreeNavigator

Returns the tool tip text for the given element to be used as the tool tip text for the current frame, and for the view title tooltip.

Specified by:

getFrameToolTipText in interface ITreeNavigator

Returns:

String

See Also:

ITreeNavigator.getFrameToolTipText(java.lang.Object)

createFrameList

protected org.eclipse.ui.views.framelist.FrameList createFrameList()

Creates the frame source and frame list, and connects them.

Returns:

FrameList

createFrameSource

protected TreeNavigatorFrameSource createFrameSource()

Creates the frame source to be associated with this navigator.

Returns:

TreeNavigatorFrameSource

initContextMenu

protected void initContextMenu()

Description copied from class: Navigator

Initializes and registers the context menu.

Overrides:

initContextMenu in class Navigator

See Also:

Navigator.initContextMenu()

updateTitle

public void updateTitle()

Description copied from interface: INavigator

Updates the title text and title tool tip. Should be called whenever the input of the viewer changes.

Specified by:

updateTitle in interface INavigator

Overrides:

updateTitle in class Navigator

See Also:

INavigator.updateTitle()