org.eclipse.hyades.ui.internal.navigator
Interface INavigator

All Superinterfaces:

org.eclipse.hyades.ui.util.IDisposable, org.eclipse.ui.part.ISetSelectionTarget

All Known Subinterfaces:

ITreeNavigator

All Known Implementing Classes:

Navigator, PDProjectExplorer, TreeNavigator

public interface INavigator
extends org.eclipse.hyades.ui.util.IDisposable, org.eclipse.ui.part.ISetSelectionTarget

Hyades navigator interface.

Clients are not supposed to manipulate the navigator preferences and UI before its initialization. See isInitialized()

This interface is not intended to be implemented by clients. Subclass Navigator instead.

This implementation is based on the org.eclipse.ui.views.navigator.IResourceNavigator class.

Method Summary

java.lang.String	getID() Returns this navigator's ID.
INavigatorLayout	getLayout() Returns the navigator's current layout, or null if this navigator does not use layouts.
org.eclipse.ui.plugin.AbstractUIPlugin	getPlugin() Returns the navigator's plugin.
org.eclipse.ui.IWorkbenchPartSite	getSite() Returns the site for this navigator.
org.eclipse.jface.viewers.IStructuredSelection	getStructuredSelection() Returns the current selection.
org.eclipse.jface.viewers.StructuredViewer	getViewer() Returns this navigator's viewer.
org.eclipse.ui.IViewSite	getViewSite() Returns the site for this navigator.
void	handleChange(int type) Generic mechanism to notify the navigator that a change has happened.
boolean	isInitialized() Returns whether this navigator is initialized.
boolean	isLinkingEnabled() Returns whether the navigator selection automatically tracks the active editor.
boolean	isShowingFolders() Returns whether the navigator is showing projects and folders.
void	setLayout(INavigatorLayout layout) Assigns the given layout to this navigator.
void	setLinkingEnabled(boolean enabled) Sets whether this navigator's selection automatically tracks the active editor.
void	updateTitle() Updates the title text and title tool tip.

Methods inherited from interface org.eclipse.hyades.ui.util.IDisposable

dispose

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

selectReveal

Method Detail

getID

java.lang.String getID()

Returns this navigator's ID. This is used by navigator extensions to specify which navigator to contribute to.

Returns:

the navigator's ID.

isInitialized

boolean isInitialized()

Returns whether this navigator is initialized.

Returns:

boolean

getLayout

INavigatorLayout getLayout()

Returns the navigator's current layout, or null if this navigator does not use layouts. Only one layout may be assigned to a navigator at a time.

Returns:

the navigator's current layout.

getSite

org.eclipse.ui.IWorkbenchPartSite getSite()

Returns the site for this navigator.

Returns:

the part site

getPlugin

org.eclipse.ui.plugin.AbstractUIPlugin getPlugin()

Returns the navigator's plugin. This method should not return null.

Returns:

AbstractUIPlugin

getStructuredSelection

org.eclipse.jface.viewers.IStructuredSelection getStructuredSelection()

Returns the current selection.

Returns:

a not null IStructuredSelection.

getViewer

org.eclipse.jface.viewers.StructuredViewer getViewer()

Returns this navigator's viewer.

Returns:

StructuredViewer

isLinkingEnabled

boolean isLinkingEnabled()

Returns whether the navigator selection automatically tracks the active editor.

Returns:

true if linking is enabled, false if not

setLinkingEnabled

void setLinkingEnabled(boolean enabled)

Sets whether this navigator's selection automatically tracks the active editor.

Parameters:

enabled - true to enable, false to disable

handleChange

void handleChange(int type)

Generic mechanism to notify the navigator that a change has happened. There is no enforcement regarding the possible values for the type of the change.

getViewSite

org.eclipse.ui.IViewSite getViewSite()

Returns the site for this navigator.

Returns:

the view site

updateTitle

void updateTitle()

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

isShowingFolders

boolean isShowingFolders()

Returns whether the navigator is showing projects and folders.

Returns:

true if is showing project and folders, false if not.

setLayout

void setLayout(INavigatorLayout layout)

Assigns the given layout to this navigator. The navigator should react immediately and re-layout its content.

Parameters:

layout - the layout to assign the navigator.