org.eclipse.ui
Interface IWorkbenchPartReference

All Known Subinterfaces:
IViewReference

public interface IWorkbenchPartReference

Implements a reference to a IWorkbenchPart. The IWorkbenchPart will not be instanciated until the part becomes visible or the API getPart is sent with true;

This interface is not intended to be implemented by clients.


Method Summary
 void addPropertyListener(IPropertyListener listener)
           
 java.lang.String getContentDescription()
          Returns the content description for the part (or the empty string if none)
 java.lang.String getId()
           
 IWorkbenchPage getPage()
          Returns the workbench page that contains this part
 IWorkbenchPart getPart(boolean restore)
          Returns the IWorkbenchPart referenced by this object.
 java.lang.String getPartName()
          Returns the name of the part, as it should be shown in tabs.
 java.lang.String getTitle()
           
 Image getTitleImage()
           
 java.lang.String getTitleToolTip()
           
 void removePropertyListener(IPropertyListener listener)
           
 

Method Detail

getPart

IWorkbenchPart getPart(boolean restore)
Returns the IWorkbenchPart referenced by this object. Returns null if the editors was not instantiated or it failed to be restored. Tries to restore the editor if restore is true.


getTitle

java.lang.String getTitle()
See Also:
IWorkbenchPart.getTitle()

getTitleImage

Image getTitleImage()
See Also:
IWorkbenchPart.getTitleImage()

getTitleToolTip

java.lang.String getTitleToolTip()
See Also:
IWorkbenchPart.getTitleToolTip()

getId

java.lang.String getId()
See Also:
IWorkbenchPartSite.getId()

addPropertyListener

void addPropertyListener(IPropertyListener listener)
See Also:
IWorkbenchPart.addPropertyListener(org.eclipse.ui.IPropertyListener)

removePropertyListener

void removePropertyListener(IPropertyListener listener)
See Also:
IWorkbenchPart.removePropertyListener(org.eclipse.ui.IPropertyListener)

getPage

IWorkbenchPage getPage()
Returns the workbench page that contains this part


getPartName

java.lang.String getPartName()
Returns the name of the part, as it should be shown in tabs.

Returns:
the part name
Since:
3.0

getContentDescription

java.lang.String getContentDescription()
Returns the content description for the part (or the empty string if none)

Returns:
the content description for the part
Since:
3.0