Java Doc for IPresentablePart.java in » IDE-Eclipse » ui-workbench » org » eclipse » ui » presentations » 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.presentations

Source Cross Reference Class Diagram Java Document (Java Doc)

org.eclipse.ui.presentations .IPresentablePart

All known Subclasses:   org.eclipse.ui.internal.presentations .PresentablePart,
IPresentablePart
public interface IPresentablePart extends ISizeProvider(Code)
This is a skin's interface to the contents of a view or editor. Note that this is essentially the same as IWorkbenchPart, except it does not provide access to lifecycle events and allows repositioning of the part. Not intended to be implemented by clients.
since:
   3.0
since:
   3.4 now extends org.eclipse.ui.ISizeProvider

Field Summary
final public static int PROP_BUSY
     The property id for isBusy.
final public static int PROP_CONTENT_DESCRIPTION

final public static int PROP_DIRTY
     The property id for isDirty.
final public static int PROP_HIGHLIGHT_IF_BACK
     The property id for highlighting the part if it is not in front.
final public static int PROP_INPUT
     The property id for getEditorInput.
final public static int PROP_PANE_MENU

final public static int PROP_PART_NAME

final public static int PROP_PREFERRED_SIZE

final public static int PROP_TITLE
     The property id for getTitle, getTitleImage and getTitleToolTip.
final public static int PROP_TOOLBAR


Method Summary
public void addPartPropertyListener(IPropertyChangeListener listener)
     Add a listener for changes in the arbitrary properties set.
public void addPropertyListener(IPropertyListener listener)
     Adds a listener for changes to properties of this workbench part.
public Control getControl()
     Returns an SWT control that can be used to indicate the tab order for this part.
public IPartMenu getMenu()

public String getName()
     Returns the short name of the part.
public String getPartProperty(String key)
     Get a property from the part's arbitrary property set.
Note: this is a different set of properties than the ones covered by the PROP_* constants.

Parameters:
  key - The property key to retrieve.
public String getTitle()
     Returns the title of this workbench part.
public Image getTitleImage()
     Returns the title image of this workbench part.
public String getTitleStatus()
     Returns the status message from the part's title, or the empty string if none.
public String getTitleToolTip()
     Returns the title tool tip text of this workbench part.
public Control getToolBar()
     Returns the local toolbar for this part, or null if this part does not have a local toolbar.
public boolean isBusy()
     Return true if the the receiver is currently in a busy state.
public boolean isCloseable()

public boolean isDirty()
     Returns true iff the contents of this part have changed recently.
public void removePartPropertyListener(IPropertyChangeListener listener)
     Remove a change listener from the arbitrary properties set.
public void removePropertyListener(IPropertyListener listener)
     Remove a listener that was previously added using addPropertyListener.
public void setBounds(Rectangle bounds)
     Sets the bounds of this part.
public void setFocus()
     Forces this part to have focus.
public void setVisible(boolean isVisible)
     Notifies the part whether or not it is visible in the current perspective.

Field Detail
PROP_BUSY
final public static int PROP_BUSY(Code)
The property id for isBusy.

PROP_CONTENT_DESCRIPTION
final public static int PROP_CONTENT_DESCRIPTION(Code)
The property id for IWorkbenchPart2.getContentDescription()

PROP_DIRTY
final public static int PROP_DIRTY(Code)
The property id for isDirty.

PROP_HIGHLIGHT_IF_BACK
final public static int PROP_HIGHLIGHT_IF_BACK(Code)
The property id for highlighting the part if it is not in front.

PROP_INPUT
final public static int PROP_INPUT(Code)
The property id for getEditorInput.

PROP_PANE_MENU
final public static int PROP_PANE_MENU(Code)
The property id for pane menu changes

PROP_PART_NAME
final public static int PROP_PART_NAME(Code)
The property id for IWorkbenchPart2.getContentDescription()

PROP_PREFERRED_SIZE
final public static int PROP_PREFERRED_SIZE(Code)
The property id for preferred size changes

PROP_TITLE
final public static int PROP_TITLE(Code)
The property id for getTitle, getTitleImage and getTitleToolTip.

PROP_TOOLBAR
final public static int PROP_TOOLBAR(Code)
The property id for toolbar changes

Method Detail
addPartPropertyListener
public void addPartPropertyListener(IPropertyChangeListener listener)(Code)
Add a listener for changes in the arbitrary properties set.
Note: this is a different set of properties than the ones covered by the PROP_* constants.

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

addPropertyListener
public void addPropertyListener(IPropertyListener listener)(Code)
Adds a listener for changes to properties of this workbench part. Has no effect if an identical listener is already registered.
The properties ids are defined by the PROP_* constants, above.

Parameters:
  listener - a property listener (not null)

getControl
public Control getControl()(Code)
Returns an SWT control that can be used to indicate the tab order for this part. This can be returned as part of the result to StackPresentation.getTabList(IPresentablePart) . Any other use of this control is unsupported. This may return a placeholder control that is only meaningful in the context of getTabList. the part's control (not null)

getMenu
public IPartMenu getMenu()(Code)
Returns the menu for this part or null if none the menu for this part or null if none

getName
public String getName()(Code)
Returns the short name of the part. This is used as the text on the tab when this part is stacked on top of other parts. the short name of the part (not null)

getPartProperty
public String getPartProperty(String key)(Code)
Get a property from the part's arbitrary property set.
Note: this is a different set of properties than the ones covered by the PROP_* constants.

Parameters:
  key - The property key to retrieve. Must not be null. the property, or null if that property is not set.
since:
   3.3

getTitle
public String getTitle()(Code)
Returns the title of this workbench part. If this value changes the part must fire a property listener event with PROP_TITLE.
The title is used to populate the title bar of this part's visual container.
the workbench part title (not null)

getTitleImage
public Image getTitleImage()(Code)
Returns the title image of this workbench part. If this value changes the part must fire a property listener event with PROP_TITLE.
The title image is usually used to populate the title bar of this part's visual container. Since this image is managed by the part itself, callers must not dispose the returned image.
the title image

getTitleStatus
public String getTitleStatus()(Code)
Returns the status message from the part's title, or the empty string if none. This is a substring of the part's title. A typical title will consist of the part name, a separator, and a status message describing the current contents.
Presentations can query getName() and getTitleStatus() if they want to display the status message and name separately, or they can use getTitle() if they want to display the entire title.
the status message or the empty string if none (not null)

getTitleToolTip
public String getTitleToolTip()(Code)
Returns the title tool tip text of this workbench part. If this value changes the part must fire a property listener event with PROP_TITLE.
The tool tip text is used to populate the title bar of this part's visual container.
the workbench part title tool tip (not null)

getToolBar
public Control getToolBar()(Code)
Returns the local toolbar for this part, or null if this part does not have a local toolbar. Callers must not dispose or downcast the return value. the local toolbar for the part, or null if none

isBusy
public boolean isBusy()(Code)
Return true if the the receiver is currently in a busy state. boolean true if busy

isCloseable
public boolean isCloseable()(Code)
Returns true iff this part can be closed true iff this part can be closed
since:
   3.1

isDirty
public boolean isDirty()(Code)
Returns true iff the contents of this part have changed recently. For editors, this indicates that the part has changed since the last save. For views, this indicates that the view contains interesting changes that it wants to draw the user's attention to. true iff the part is dirty

removePartPropertyListener
public void removePartPropertyListener(IPropertyChangeListener listener)(Code)
Remove a change listener from the arbitrary properties set.
Note: this is a different set of properties than the ones covered by the PROP_* constants.

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

removePropertyListener
public void removePropertyListener(IPropertyListener listener)(Code)
Remove a listener that was previously added using addPropertyListener.
Parameters:
  listener - a property listener (not null)

setBounds
public void setBounds(Rectangle bounds)(Code)
Sets the bounds of this part.
Parameters:
  bounds - bounding rectangle (not null)

setFocus
public void setFocus()(Code)
Forces this part to have focus.

setVisible
public void setVisible(boolean isVisible)(Code)
Notifies the part whether or not it is visible in the current perspective. A part is visible iff any part of its widgetry can be seen.
Parameters:
  isVisible - true if the part has just become visible, falseif the part has just become hidden

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.