Eclipse Plug-in Developer Guide (Galileo) - BookmarkNavigator (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.views.bookmarkexplorer
Class BookmarkNavigator

java.lang.Object
  

org.eclipse.core.commands.common.EventManager
      

org.eclipse.ui.part.WorkbenchPart
          

org.eclipse.ui.part.ViewPart
              
org.eclipse.ui.views.bookmarkexplorer.BookmarkNavigator

All Implemented Interfaces:: IAdaptable, IExecutableExtension, IPersistable, IViewPart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPart3, IWorkbenchPartOrientation

Deprecated. This view is no longer in use as of Eclipse 3.4. The view referenced by IPageLayout.ID_BOOKMARKS is an ExtendedMarkersView.

public class BookmarkNavigator
extends ViewPart
extends ViewPart

Main class for the bookmark navigator for displaying bookmarks on resources and opening an editor on the bookmarked resource when the user commands.

Restriction:: This class is not intended to be subclassed by clients.
Restriction:: This class is not intended to be instantiated by clients.

Field Summary

Fields inherited from interface org.eclipse.ui. IWorkbenchPart

PROP_TITLE

Constructor Summary

BookmarkNavigator ()
          Deprecated. Creates the bookmarks view.

Method Summary

void createPartControl ( Composite parent)
          Deprecated. Creates the SWT controls for this workbench part.

void dispose ()
          Deprecated. The WorkbenchPart implementation of this IWorkbenchPart method disposes the title image loaded by setInitializationData.

Object getAdapter ( Class adapter)
          Deprecated. Returns an object which is an instance of the given class associated with this object.

void init ( IViewSite site, IMemento memento)
          Deprecated. Initializes this view with the given view site.

protected void initDragAndDrop ()
          Deprecated. Adds drag and drop support to the bookmark navigator.

void saveState ( IMemento memento)
          Deprecated. Saves the object state within a memento.

void setFocus ()
          Deprecated. Asks this part to take focus within the workbench.

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. IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

Constructor Detail

BookmarkNavigator

public BookmarkNavigator()

Deprecated.

Creates the bookmarks view.

Method Detail

createPartControl

public void createPartControl(
Composite parent)

Deprecated.

Description copied from interface: IWorkbenchPart

Creates the SWT controls for this workbench part.

Clients should not call this method (the workbench calls this method when it needs to, which may be never).

For implementors this is a multi-step process:

Create one or more controls within the parent.
Set the parent layout as needed.
Register any global actions with the site's IActionBars.
Register any context menus with the site.
Register a selection provider with the site, to make it available to the workbench's ISelectionService (optional).

Specified by:: createPartControl in interface IWorkbenchPart
Specified by:: createPartControl in class WorkbenchPart

Parameters:: parent - the parent control

dispose

public void dispose()

Deprecated.

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 adapter)

Deprecated.

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:: adapter - 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

init

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

Deprecated.

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

initDragAndDrop

protected void initDragAndDrop()

Deprecated.

Adds drag and drop support to the bookmark navigator.

saveState

public void saveState(
IMemento memento)

Deprecated.

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

setFocus

public void setFocus()

Deprecated.

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.