|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IWorkbenchPartReference
Implements a reference to a IWorkbenchPart. The IWorkbenchPart will not be instantiated 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 |
addPartPropertyListener(IPropertyChangeListener listener)
Add a listener for changes in the arbitrary properties set. |
void |
addPropertyListener(IPropertyListener listener)
|
String |
getContentDescription()
Returns the content description for the part (or the empty string if none) |
String |
getId()
|
IWorkbenchPage |
getPage()
Returns the workbench page that contains this part |
IWorkbenchPart |
getPart(boolean restore)
Returns the IWorkbenchPart referenced by this object. |
String |
getPartName()
Returns the name of the part, as it should be shown in tabs. |
String |
getPartProperty(String key)
Return an arbitrary property from the reference. |
String |
getTitle()
|
Image |
getTitleImage()
|
String |
getTitleToolTip()
|
boolean |
isDirty()
Returns whether the part is dirty (i.e. has unsaved changes). |
void |
removePartPropertyListener(IPropertyChangeListener listener)
Remove a listener for changes in the arbitrary properties set. |
void |
removePropertyListener(IPropertyListener listener)
|
Method Detail |
---|
IWorkbenchPart getPart(boolean restore)
restore
- tries to restore the part if true
.
null
if the part was not instantiated
or it failed to be restored.String getTitle()
IWorkbenchPart.getTitle()
Image getTitleImage()
IWorkbenchPart.getTitleImage()
String getTitleToolTip()
IWorkbenchPart.getTitleToolTip()
String getId()
IWorkbenchPartSite.getId()
void addPropertyListener(IPropertyListener listener)
IWorkbenchPart.addPropertyListener(org.eclipse.ui.IPropertyListener)
void removePropertyListener(IPropertyListener listener)
IWorkbenchPart.removePropertyListener(org.eclipse.ui.IPropertyListener)
IWorkbenchPage getPage()
String getPartName()
String getContentDescription()
boolean isDirty()
true
if the part is dirty, false
otherwiseString getPartProperty(String key)
null
.
key
- The property to return. Must not be null
.
null
.void addPartPropertyListener(IPropertyChangeListener listener)
listener
- Must not be null
.void removePartPropertyListener(IPropertyChangeListener listener)
listener
- Must not be null
.
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.