|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.eclipse.ui.part.WorkbenchPart
org.eclipse.ui.part.ViewPart
org.eclipse.ui.part.PageBookView
org.eclipse.ui.views.contentoutline.ContentOutline
public class ContentOutline
Main class for the Content Outline View.
This standard view has id "org.eclipse.ui.views.ContentOutline".
getAdapter:
IEditorPart editor = ...;
IContentOutlinePage outlinePage = (IContentOutlinePage) editor.getAdapter(IContentOutlinePage.class);
if (outlinePage != null) {
// editor wishes to contribute outlinePage to content outline view
}
If the editor supports a content outline page, the editor instantiates
and configures the page, and returns it. This page is then added to the
content outline view (a pagebook which presents one page at a time) and
immediately made the current page (the content outline view need not be
visible). If the editor does not support a content outline page, the content
outline view shows a special default page which makes it clear to the user
that the content outline view is disengaged. A content outline page is free
to report selection events; the content outline view forwards these events
along to interested parties. When the content outline view notices a
different editor being activated, it flips to the editor's corresponding
content outline page. When the content outline view notices an editor being
closed, it destroys the editor's corresponding content outline page.
The workbench will automatically instantiate this class when a Content Outline view is needed for a workbench window. This class was not intended to be instantiated or subclassed by clients.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.eclipse.ui.part.PageBookView |
|---|
PageBookView.PageRec, PageBookView.SelectionProvider |
| Field Summary | |
|---|---|
static String |
CONTENT_OUTLINE_VIEW_HELP_CONTEXT_ID
Help context id used for the content outline view (value "org.eclipse.ui.content_outline_context"). |
static String |
PREFIX
The plugin prefix. |
| Fields inherited from interface org.eclipse.ui.IWorkbenchPart |
|---|
PROP_TITLE |
| Constructor Summary | |
|---|---|
ContentOutline()
Creates a content outline view with no content outline pages. |
|
| Method Summary | |
|---|---|
void |
addSelectionChangedListener(ISelectionChangedListener listener)
Adds a listener for selection changes in this selection provider. |
protected IPage |
createDefaultPage(PageBook book)
Creates and returns the default page for this view. |
void |
createPartControl(Composite parent)
The PageBookView implementation of this IWorkbenchPart
method creates a PageBook control with its default page showing. |
protected PageBookView.PageRec |
doCreatePage(IWorkbenchPart part)
Creates a new page in the pagebook for a particular part. |
protected void |
doDestroyPage(IWorkbenchPart part,
PageBookView.PageRec rec)
Destroys a page in the pagebook for a particular part. |
Object |
getAdapter(Class key)
The PageBookView implementation of this
IAdaptable method delegates to the current page, if it
implements IAdaptable. |
protected IWorkbenchPart |
getBootstrapPart()
Returns the active, important workbench part for this view. |
ISelection |
getSelection()
Returns the current selection for this provider. |
protected boolean |
isImportant(IWorkbenchPart part)
Returns whether the given part should be added to this view. |
void |
partBroughtToTop(IWorkbenchPart part)
The PageBookView implementation of this
IPartListener method does nothing. |
void |
removeSelectionChangedListener(ISelectionChangedListener listener)
Removes the given selection change listener from this selection provider. |
void |
selectionChanged(SelectionChangedEvent event)
Notifies that the selection has changed. |
void |
setSelection(ISelection selection)
Sets the current selection for this selection provider. |
protected void |
showPageRec(PageBookView.PageRec pageRec)
The ContentOutline implementation of this PageBookView method
extends the behavior of its parent to use the current page as a selection provider. |
| Methods inherited from class org.eclipse.ui.part.PageBookView |
|---|
dispose, doesPageExist, getCurrentContributingPart, getCurrentPage, getDefaultPage, getPageBook, getPageRec, getPageRec, getPageSite, getSelectionProvider, getViewAdapter, init, initPage, partActivated, partClosed, partDeactivated, partOpened, setFocus |
| Methods inherited from class org.eclipse.ui.part.ViewPart |
|---|
checkSite, getViewSite, init, saveState, setContentDescription, setInitializationData, setPartName |
| Methods inherited from class org.eclipse.ui.part.WorkbenchPart |
|---|
addPropertyListener, firePropertyChange, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, 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 |
| Field Detail |
|---|
public static final String PREFIX
public static final String CONTENT_OUTLINE_VIEW_HELP_CONTEXT_ID
"org.eclipse.ui.content_outline_context").
| Constructor Detail |
|---|
public ContentOutline()
| Method Detail |
|---|
public void addSelectionChangedListener(ISelectionChangedListener listener)
ISelectionProvider
addSelectionChangedListener in interface ISelectionProviderlistener - a selection changed listenerprotected IPage createDefaultPage(PageBook book)
PageBookViewSubclasses must implement this method.
Subclasses must call initPage with the new page (if it is an
IPageBookViewPage) before calling createControl on the
page.
createDefaultPage in class PageBookViewbook - the pagebook control
public void createPartControl(Composite parent)
PageBookView implementation of this IWorkbenchPart
method creates a PageBook control with its default page showing.
createPartControl in interface IWorkbenchPartcreatePartControl in class PageBookViewparent - the parent controlprotected PageBookView.PageRec doCreatePage(IWorkbenchPart part)
PageBookViewdoDestroyPage.
Subclasses must implement this method.
Subclasses must call initPage with the new page (if it is an
IPageBookViewPage) before calling createControl on the
page.
doCreatePage in class PageBookViewpart - the input part
PageBookView.doDestroyPage(org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.part.PageBookView.PageRec)
protected void doDestroyPage(IWorkbenchPart part,
PageBookView.PageRec rec)
PageBookViewdoCreatePage.
Subclasses must implement this method.
doDestroyPage in class PageBookViewpart - the input partrec - a page record for the partPageBookView.doCreatePage(org.eclipse.ui.IWorkbenchPart)public Object getAdapter(Class key)
PageBookViewPageBookView implementation of this
IAdaptable method delegates to the current page, if it
implements IAdaptable.
getAdapter in interface IAdaptablegetAdapter in class PageBookViewkey - the adapter class to look up
null if this object does not
have an adapter for the given classprotected IWorkbenchPart getBootstrapPart()
PageBookView
When the page book view is created it has no idea which part within the
workbook should be used to generate the first page. Therefore, it
delegates the choice to subclasses of PageBookView.
Implementors of this method should return an active, important part in
the workbench or null if none found.
Subclasses must implement this method.
getBootstrapPart in class PageBookViewnull if nonepublic ISelection getSelection()
ISelectionProvider
getSelection in interface ISelectionProviderprotected boolean isImportant(IWorkbenchPart part)
PageBookViewSubclasses must implement this method.
isImportant in class PageBookViewpart - the input part
true if the part is relevant, and
false otherwisepublic void partBroughtToTop(IWorkbenchPart part)
PageBookViewPageBookView implementation of this
IPartListener method does nothing. Subclasses may extend.
partBroughtToTop in interface IPartListenerpartBroughtToTop in class PageBookViewpart - the part that was surfacedIWorkbenchPage.bringToTop(org.eclipse.ui.IWorkbenchPart)public void removeSelectionChangedListener(ISelectionChangedListener listener)
ISelectionProvider
removeSelectionChangedListener in interface ISelectionProviderlistener - a selection changed listenerpublic void selectionChanged(SelectionChangedEvent event)
ISelectionChangedListener
selectionChanged in interface ISelectionChangedListenerevent - event object describing the changepublic void setSelection(ISelection selection)
ISelectionProvider
setSelection in interface ISelectionProviderselection - the new selectionprotected void showPageRec(PageBookView.PageRec pageRec)
ContentOutline implementation of this PageBookView method
extends the behavior of its parent to use the current page as a selection provider.
showPageRec in class PageBookViewpageRec - the page record containing the page to show
|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.