Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.ui
Interface IWorkbenchPartReference

All Known Subinterfaces:
IEditorReference, IViewReference

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.

Restriction:
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

getPart

IWorkbenchPart getPart(boolean restore)
Returns the IWorkbenchPart referenced by this object.

Parameters:
restore - tries to restore the part if true.
Returns:
the part, or null if the part was not instantiated or it failed to be restored.

getTitle

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

getTitleImage

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

getTitleToolTip

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

getId

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

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

Returns:
the part name
Since:
3.0

getContentDescription

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

isDirty

boolean isDirty()
Returns whether the part is dirty (i.e. has unsaved changes).

Returns:
true if the part is dirty, false otherwise
Since:
3.2 (previously existed on IEditorReference)

getPartProperty

String getPartProperty(
String key)
Return an arbitrary property from the reference. If the part has been instantiated, it just delegates to the part. If not, then it looks in its own cache of properties. If the property is not available or the part has never been instantiated, it can return null.

Parameters:
key - The property to return. Must not be null.
Returns:
The String property, or null.
Since:
3.3

addPartPropertyListener

void addPartPropertyListener(
IPropertyChangeListener listener)
Add a listener for changes in the arbitrary properties set.

Parameters:
listener - Must not be null.
Since:
3.3

removePartPropertyListener

void removePartPropertyListener(
IPropertyChangeListener listener)
Remove a listener for changes in the arbitrary properties set.

Parameters:
listener - Must not be null.
Since:
3.3

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire