Package org.eclipse.ui
Interface IWorkbenchPart2
- All Superinterfaces:
IAdaptable
,IWorkbenchPart
- All Known Subinterfaces:
IWorkbenchPart3
- All Known Implementing Classes:
AbstractDebugView
,AbstractDecoratedTextEditor
,AbstractMultiEditor
,AbstractTextEditor
,CommonNavigator
,CommonSourceNotFoundEditor
,CompareEditor
,ContentOutline
,E4PartWrapper
,EditorPart
,ErrorEditorPart
,ErrorViewPart
,org.eclipse.ui.internal.views.markers.ExtendedMarkersView
,FormEditor
,FormPage
,MarkerSupportView
,MultiEditor
,MultiPageEditorPart
,PageBookView
,ProjectExplorer
,PropertySheet
,SharedHeaderFormEditor
,StatusTextEditor
,TemplatesView
,TextEditor
,ViewIntroAdapterPart
,ViewPart
,WorkbenchPart
Extends
IWorkbenchPart
, adding the name and status text properties.
Prior to 3.0, a view's title was often modified to show both the part name
and extra status text. With this interface, the distinction is made more
explicit.- Since:
- 3.0
-
Field Summary
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
-
Method Summary
Modifier and TypeMethodDescriptionReturns the content description of this part.Returns the name of this part.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
-
getPartName
String getPartName()Returns the name of this part. If this value changes the part must fire a property listener event withIWorkbenchPartConstants.PROP_PART_NAME
.- Returns:
- the name of this view, or the empty string if the name is being
managed by the workbench (not
null
)
-
getContentDescription
String getContentDescription()Returns the content description of this part. The content description is an optional user-readable string that describes what is currently being displayed in the part. By default, the workbench will display the content description in a line near the top of the view or editor. An empty string indicates no content description text. If this value changes the part must fire a property listener event withIWorkbenchPartConstants.PROP_CONTENT_DESCRIPTION
.- Returns:
- the content description of this part (not
null
)
-