Class ContentOutlinePage
- java.lang.Object
-
- org.eclipse.ui.part.Page
-
- org.eclipse.ui.views.contentoutline.ContentOutlinePage
-
- All Implemented Interfaces:
ISelectionChangedListener,ISelectionProvider,IPage,IPageBookViewPage,IContentOutlinePage
public abstract class ContentOutlinePage extends Page implements IContentOutlinePage, ISelectionChangedListener
An abstract base class for content outline pages.Clients who are defining an editor may elect to provide a corresponding content outline page. This content outline page will be presented to the user via the standard Content Outline View (the user decides whether their workbench window contains this view) whenever that editor is active. This class should be subclassed.
Internally, each content outline page consists of a standard tree viewer; selections made in the tree viewer are reported as selection change events by the page (which is a selection provider). The tree viewer is not created until
createPageis called; consequently, subclasses must extendcreateControlto configure the tree viewer with a proper content provider, label provider, and input element.Subclasses may provide a hint for constructing the tree viewer using
getTreeStyle().Note that those wanting to use a control other than internally created
TreeViewerwill need to implementIContentOutlinePagedirectly rather than subclassing this class.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedContentOutlinePage()Create a new content outline page.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddSelectionChangedListener(ISelectionChangedListener listener)Adds a listener for selection changes in this selection provider.voidcreateControl(Composite parent)TheContentOutlinePageimplementation of thisIContentOutlinePagemethod creates a tree viewer.protected voidfireSelectionChanged(ISelection selection)Fires a selection changed event.ControlgetControl()ThePageimplementation of thisIPagemethod returnsnull.ISelectiongetSelection()Returns the current selection for this provider.protected intgetTreeStyle()A hint for the styles to use while constructing the TreeViewer.protected TreeViewergetTreeViewer()Returns this page's tree viewer.voidinit(IPageSite pageSite)ThePageimplementation of thisIPageBookViewPagemethod stores a reference to the supplied site (the site which contains this page).voidremoveSelectionChangedListener(ISelectionChangedListener listener)Removes the given selection change listener from this selection provider.voidselectionChanged(SelectionChangedEvent event)Notifies that the selection has changed.voidsetFocus()Sets focus to a part in the page.voidsetSelection(ISelection selection)Sets the current selection for this selection provider.-
Methods inherited from class org.eclipse.ui.part.Page
dispose, getSite, makeContributions, setActionBars
-
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.part.IPage
dispose, setActionBars
-
-
-
-
Method Detail
-
addSelectionChangedListener
public void addSelectionChangedListener(ISelectionChangedListener listener)
Description copied from interface:ISelectionProviderAdds a listener for selection changes in this selection provider. Has no effect if an identical listener is already registered.- Specified by:
addSelectionChangedListenerin interfaceISelectionProvider- Parameters:
listener- a selection changed listener
-
createControl
public void createControl(Composite parent)
TheContentOutlinePageimplementation of thisIContentOutlinePagemethod creates a tree viewer. Subclasses must extend this method configure the tree viewer with a proper content provider, label provider, and input element.- Specified by:
createControlin interfaceIPage- Specified by:
createControlin classPage- Parameters:
parent-
-
getTreeStyle
protected int getTreeStyle()
A hint for the styles to use while constructing the TreeViewer.Subclasses may override.
- Returns:
- the tree styles to use. By default, SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL
- Since:
- 3.6
-
fireSelectionChanged
protected void fireSelectionChanged(ISelection selection)
Fires a selection changed event.- Parameters:
selection- the new selection
-
getControl
public Control getControl()
Description copied from class:PageThePageimplementation of thisIPagemethod returnsnull. Subclasses must reimplement.- Specified by:
getControlin interfaceIPage- Specified by:
getControlin classPage- Returns:
- the SWT control for this page, or
nullif this page does not have a control
-
getSelection
public ISelection getSelection()
Description copied from interface:ISelectionProviderReturns the current selection for this provider.- Specified by:
getSelectionin interfaceISelectionProvider- Returns:
- the current selection
-
getTreeViewer
protected TreeViewer getTreeViewer()
Returns this page's tree viewer.- Returns:
- this page's tree viewer, or
nullifcreateControlhas not been called yet
-
init
public void init(IPageSite pageSite)
Description copied from class:PageThePageimplementation of thisIPageBookViewPagemethod stores a reference to the supplied site (the site which contains this page).Subclasses may extend.
- Specified by:
initin interfaceIPageBookViewPage- Overrides:
initin classPage- Parameters:
pageSite- the page site
-
removeSelectionChangedListener
public void removeSelectionChangedListener(ISelectionChangedListener listener)
Description copied from interface:ISelectionProviderRemoves the given selection change listener from this selection provider. Has no effect if an identical listener is not registered.- Specified by:
removeSelectionChangedListenerin interfaceISelectionProvider- Parameters:
listener- a selection changed listener
-
selectionChanged
public void selectionChanged(SelectionChangedEvent event)
Description copied from interface:ISelectionChangedListenerNotifies that the selection has changed.- Specified by:
selectionChangedin interfaceISelectionChangedListener- Parameters:
event- event object describing the change
-
setFocus
public void setFocus()
Sets focus to a part in the page.
-
setSelection
public void setSelection(ISelection selection)
Description copied from interface:ISelectionProviderSets the current selection for this selection provider.- Specified by:
setSelectionin interfaceISelectionProvider- Parameters:
selection- the new selection
-
-