Interface IViewPart
- All Superinterfaces:
IAdaptable
,IPersistable
,IWorkbenchPart
- All Known Subinterfaces:
IConsoleView
,IDebugView
,ISearchResultViewPart
,ISynchronizeView
- All Known Implementing Classes:
AbstractDebugView
,CommonNavigator
,ContentOutline
,E4PartWrapper
,ErrorViewPart
,org.eclipse.ui.internal.views.markers.ExtendedMarkersView
,MarkerSupportView
,PageBookView
,ProjectExplorer
,PropertySheet
,TemplatesView
,ViewIntroAdapterPart
,ViewPart
Only one instance of a particular view type may exist within a workbench page. This policy is designed to simplify part management for a user.
This interface may be implemented directly. For convenience, a base
implementation is defined in ViewPart
.
A view is added to the workbench in two steps:
- A view extension is contributed to the workbench registry. This extension defines the extension id and extension class.
- The view is included in the default layout for a perspective. Alternatively, the user may open the view from the Perspective menu.
Views implement the IAdaptable
interface; extensions are managed
by the platform's adapter manager.
As of 3.4, views may optionally adapt to ISizeProvider
if they have a
preferred size. The default presentation will make a best effort to allocate
the preferred size to a view if it is the only part in a stack. If there is
more than one part in the stack, the constraints will be disabled for that
stack. The size constraints are adjusted for the size of the tab and border
trim. Note that this is considered to be a hint to the presentation, and not
all presentations may honor size constraints.
-
Field Summary
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
-
Method Summary
Modifier and TypeMethodDescriptionReturns the site for this view.void
Initializes this view with the given view site.void
Initializes this view with the given view site.void
Saves the object state within a memento.Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, createPartControl, dispose, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setFocus
-
Method Details
-
getViewSite
IViewSite getViewSite()Returns the site for this view. This method is equivalent to(IViewSite) getSite()
.The site can be
null
while the view is being initialized. After the initialization is complete, this value must be non-null
for the remainder of the view's life cycle.- Returns:
- the view site; this value may be
null
if the view has not yet been initialized
-
init
Initializes this view with the given view site.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.
- Parameters:
site
- the view site- Throws:
PartInitException
- if this view was not initialized successfully
-
init
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.
- Parameters:
site
- the view sitememento
- the IViewPart state or null if there is no previous saved state- Throws:
PartInitException
- if this view was not initialized successfully
-
saveState
Saves the object state within a memento.- Specified by:
saveState
in interfaceIPersistable
- Parameters:
memento
- a memento to receive the object state
-