|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Field Summary | |
---|---|
static int |
PROP_BUSY
The property id for isBusy . |
static int |
PROP_CONTENT_DESCRIPTION
The property id for IWorkbenchPart2.getContentDescription() |
static int |
PROP_DIRTY
The property id for isDirty . |
static int |
PROP_HIGHLIGHT_IF_BACK
The property id for highlighting the part if it is not in front. |
static int |
PROP_INPUT
The property id for getEditorInput . |
static int |
PROP_PANE_MENU
The property id for pane menu changes |
static int |
PROP_PART_NAME
The property id for IWorkbenchPart2.getContentDescription() |
static int |
PROP_TITLE
The property id for getTitle , getTitleImage
and getTitleToolTip . |
static int |
PROP_TOOLBAR
The property id for toolbar changes |
Method Summary | |
---|---|
void |
addPropertyListener(IPropertyListener listener)
Adds a listener for changes to properties of this workbench part. |
Control |
getControl()
Returns an SWT control that can be used to indicate the tab order for this part. |
IPartMenu |
getMenu()
Returns the menu for this part or null if none |
String |
getName()
Returns the short name of the part. |
String |
getTitle()
Returns the title of this workbench part. |
Image |
getTitleImage()
Returns the title image of this workbench part. |
String |
getTitleStatus()
Returns the status message from the part's title, or the empty string if none. |
String |
getTitleToolTip()
Returns the title tool tip text of this workbench part. |
Control |
getToolBar()
Returns the local toolbar for this part, or null if this part does not have a local toolbar. |
boolean |
isBusy()
Return true if the the receiver is currently in a busy state. |
boolean |
isCloseable()
Returns true iff this part can be closed |
boolean |
isDirty()
Returns true iff the contents of this part have changed recently. |
void |
removePropertyListener(IPropertyListener listener)
Remove a listener that was previously added using addPropertyListener. |
void |
setBounds(Rectangle bounds)
Sets the bounds of this part. |
void |
setFocus()
Forces this part to have focus. |
void |
setVisible(boolean isVisible)
Notifies the part whether or not it is visible in the current perspective. |
Field Detail |
public static final int PROP_DIRTY
isDirty
.
public static final int PROP_INPUT
getEditorInput
.
public static final int PROP_TITLE
getTitle
, getTitleImage
and getTitleToolTip
.
public static final int PROP_CONTENT_DESCRIPTION
IWorkbenchPart2.getContentDescription()
public static final int PROP_PART_NAME
IWorkbenchPart2.getContentDescription()
public static final int PROP_BUSY
isBusy
.
public static final int PROP_TOOLBAR
public static final int PROP_HIGHLIGHT_IF_BACK
public static final int PROP_PANE_MENU
Method Detail |
public void setBounds(Rectangle bounds)
bounds
- bounding rectangle (not null)public void setVisible(boolean isVisible)
isVisible
- true if the part has just become visible, false
if the part has just become hiddenpublic void setFocus()
public void addPropertyListener(IPropertyListener listener)
The properties ids are defined by the PROP_* constants, above.
listener
- a property listener (not null)public void removePropertyListener(IPropertyListener listener)
listener
- a property listener (not null)public String getName()
public String getTitle()
PROP_TITLE
.
The title is used to populate the title bar of this part's visual container.
public String getTitleStatus()
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.
public Image getTitleImage()
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.
public String getTitleToolTip()
PROP_TITLE
.
The tool tip text is used to populate the title bar of this part's visual container.
public boolean isDirty()
public boolean isBusy()
public boolean isCloseable()
public Control getToolBar()
public IPartMenu getMenu()
public Control getControl()
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
.
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.