Java Doc for WorkbenchPart.java in » IDE-Eclipse » ui-workbench » org » eclipse » ui » part » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » IDE Eclipse » ui workbench » org.eclipse.ui.part

Source Cross Reference Class Diagram Java Document (Java Doc)

org.eclipse.ui.part .WorkbenchPart

All known Subclasses:   org.eclipse.ui.part .ViewPart,  org.eclipse.ui.part .EditorPart,
WorkbenchPart
abstract public class WorkbenchPart extends EventManager implements IWorkbenchPart3,IExecutableExtension,IWorkbenchPartOrientation(Code)
Abstract base implementation of all workbench parts.
This class is not intended to be subclassed by clients outside this package; clients should instead subclass ViewPart or EditorPart.

See Also:   org.eclipse.ui.part.ViewPart
See Also:   org.eclipse.ui.part.EditorPart

Constructor Summary
protected WorkbenchPart()
     Creates a new workbench part.

Method Summary
public void addPartPropertyListener(IPropertyChangeListener listener)

public void addPropertyListener(IPropertyListener l)

protected void checkSite(IWorkbenchPartSite site)
     Checks that the given site is valid for this type of part.
abstract public void createPartControl(Composite parent)

public void dispose()
     The WorkbenchPart implementation of this IWorkbenchPart method disposes the title image loaded by setInitializationData.
protected void firePartPropertyChanged(String key, String oldValue, String newValue)

protected void firePropertyChange(int propertyId)
     Fires a property changed event.
public Object getAdapter(Class adapter)
     Subclasses may override this method (however, if they do so, they should invoke the method on their superclass to ensure that the Platform's adapter manager is consulted).
protected IConfigurationElement getConfigurationElement()
     Returns the configuration element for this part.
public String getContentDescription()

It is considered bad practise to overload or extend this method. Parts should call setContentDescription to change their content description.
protected Image getDefaultImage()
     Returns the default title image.
public int getOrientation()

public String getPartName()

It is considered bad practise to overload or extend this method. Parts should call setPartName to change their part name.
public Map getPartProperties()

public String getPartProperty(String key)

public IWorkbenchPartSite getSite()

public String getTitle()

It is considered bad practise to overload or extend this method.
public Image getTitleImage()

public String getTitleToolTip()

void internalSetContentDescription(String description)

void internalSetPartName(String partName)

public void removePartPropertyListener(IPropertyChangeListener listener)

public void removePropertyListener(IPropertyListener l)

protected void setContentDescription(String description)
     Sets the content description for this part.
void setDefaultTitle()

abstract public void setFocus()

public void setInitializationData(IConfigurationElement cfig, String propertyName, Object data)
     The WorkbenchPart implementation of this IExecutableExtension records the configuration element in and internal state variable (accessible via getConfigElement). It also loads the title image, if one is specified in the configuration element. Subclasses may extend. Should not be called by clients.
protected void setPartName(String partName)
     Sets the name of this part.
public void setPartProperty(String key, String value)

protected void setSite(IWorkbenchPartSite site)
     Sets the part site.
protected void setTitle(String title)
     Sets or clears the title of this part.
protected void setTitleImage(Image titleImage)
     Sets or clears the title image of this part.
protected void setTitleToolTip(String toolTip)
     Sets or clears the title tool tip text of this part.
public void showBusy(boolean busy)
     Show that this part is busy due to a Job running that it is listening to.

Constructor Detail
WorkbenchPart
protected WorkbenchPart()(Code)
Creates a new workbench part.

Method Detail
addPartPropertyListener
public void addPartPropertyListener(IPropertyChangeListener listener)(Code)

addPropertyListener
public void addPropertyListener(IPropertyListener l)(Code)

checkSite
protected void checkSite(IWorkbenchPartSite site)(Code)
Checks that the given site is valid for this type of part. The default implementation does nothing.
Parameters:
  site - the site to check
since:
   3.1

createPartControl
abstract public void createPartControl(Composite parent)(Code)

dispose
public void dispose()(Code)
The WorkbenchPart implementation of this IWorkbenchPart method disposes the title image loaded by setInitializationData. Subclasses may extend.

firePartPropertyChanged
protected void firePartPropertyChanged(String key, String oldValue, String newValue)(Code)

since:
   3.3

firePropertyChange
protected void firePropertyChange(int propertyId)(Code)
Fires a property changed event.
Parameters:
  propertyId - the id of the property that changed

getAdapter
public Object getAdapter(Class adapter)(Code)
Subclasses may override this method (however, if they do so, they should invoke the method on their superclass to ensure that the Platform's adapter manager is consulted).

getConfigurationElement
protected IConfigurationElement getConfigurationElement()(Code)
Returns the configuration element for this part. The configuration element comes from the plug-in registry entry for the extension defining this part. the configuration element for this part

getContentDescription
public String getContentDescription()(Code)

It is considered bad practise to overload or extend this method. Parts should call setContentDescription to change their content description.

getDefaultImage
protected Image getDefaultImage()(Code)
Returns the default title image. the default image

getOrientation
public int getOrientation()(Code)

getPartName
public String getPartName()(Code)

It is considered bad practise to overload or extend this method. Parts should call setPartName to change their part name.

getPartProperties
public Map getPartProperties()(Code)

getPartProperty
public String getPartProperty(String key)(Code)

getSite
public IWorkbenchPartSite getSite()(Code)

getTitle
public String getTitle()(Code)

It is considered bad practise to overload or extend this method. Parts should set their title by calling setPartName and/or setContentDescription.

getTitleImage
public Image getTitleImage()(Code)

getTitleToolTip
public String getTitleToolTip()(Code)

internalSetContentDescription
void internalSetContentDescription(String description)(Code)

internalSetPartName
void internalSetPartName(String partName)(Code)

removePartPropertyListener
public void removePartPropertyListener(IPropertyChangeListener listener)(Code)

removePropertyListener
public void removePropertyListener(IPropertyListener l)(Code)

setContentDescription
protected void setContentDescription(String description)(Code)
Sets the content description for this part. The content description is typically a short string describing the current contents of the part. Setting this to the empty string will cause a default content description to be used. Clients should call this method instead of overriding getContentDescription(). For views, the content description is shown (by default) in a line near the top of the view. For editors, the content description is shown beside the part name when showing a list of editors. If the editor is open on a file, this typically contains the path to the input file, without the filename or trailing slash.
This may overwrite a value that was previously set in setTitle

Parameters:
  description - the content description
since:
   3.0

setDefaultTitle
void setDefaultTitle()(Code)

setFocus
abstract public void setFocus()(Code)

setInitializationData
public void setInitializationData(IConfigurationElement cfig, String propertyName, Object data)(Code)
The WorkbenchPart implementation of this IExecutableExtension records the configuration element in and internal state variable (accessible via getConfigElement). It also loads the title image, if one is specified in the configuration element. Subclasses may extend. Should not be called by clients. It is called by the core plugin when creating this executable extension.

setPartName
protected void setPartName(String partName)(Code)
Sets the name of this part. The name will be shown in the tab area for the part. Clients should call this method instead of overriding getPartName. Setting this to the empty string will cause a default part name to be used.
setPartName and setContentDescription are intended to replace setTitle. This may change a value that was previously set using setTitle.

Parameters:
  partName - the part name, as it should be displayed in tabs.
since:
   3.0

setPartProperty
public void setPartProperty(String key, String value)(Code)

setSite
protected void setSite(IWorkbenchPartSite site)(Code)
Sets the part site.
Subclasses must invoke this method from IEditorPart.init and IViewPart.init.
Parameters:
  site - the workbench part site

setTitle
protected void setTitle(String title)(Code)
Sets or clears the title of this part. Clients should call this method instead of overriding getTitle.
This may change a title that was previously set using setPartName or setContentDescription.

Parameters:
  title - the title, or null to clear

setTitleImage
protected void setTitleImage(Image titleImage)(Code)
Sets or clears the title image of this part.
Parameters:
  titleImage - the title image, or null to clear

setTitleToolTip
protected void setTitleToolTip(String toolTip)(Code)
Sets or clears the title tool tip text of this part. Clients should call this method instead of overriding getTitleToolTip
Parameters:
  toolTip - the new tool tip text, or null to clear

showBusy
public void showBusy(boolean busy)(Code)
Show that this part is busy due to a Job running that it is listening to.
Parameters:
  busy - boolean to indicate that the busy state has startedor ended.
See Also:   org.eclipse.ui.progress.IWorkbenchSiteProgressService.showBusyForFamily(Object)
since:
   3.0

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.