Eclipse Platform
2.0

org.eclipse.ui
Interface IWorkbenchPartReference

All Known Subinterfaces:
IEditorReference, 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)
           
 String getId()
           
 IWorkbenchPart getPart(boolean restore)
          Returns the IEditorPart referenced by this object.
 String getTitle()
           
 Image getTitleImage()
           
 String getTitleToolTip()
           
 void removePropertyListener(IPropertyListener listener)
           
 

Method Detail

getPart

public IWorkbenchPart getPart(boolean restore)
Returns the IEditorPart 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

public String getTitle()
See Also:
IWorkbenchPart.getTitle()

getTitleImage

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

getTitleToolTip

public String getTitleToolTip()
See Also:
IWorkbenchPart.getTitleToolTip()

getId

public String getId()
See Also:
IWorkbenchPartSite.getId()

addPropertyListener

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

removePropertyListener

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

Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.