|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A contribution item represents a contribution to a shared UI resource such as a menu or tool bar. More generally, contribution items are managed by a contribution manager. For instance, in a tool bar a contribution item is a tool bar button or a separator. In a menu bar a contribution item is a menu, and in a menu a contribution item is a menu item or separator.
A contribution item can realize itself in different SWT widgets, using the different
fill
methods. The same type of contribution item can be used with a
MenuBarManager
, ToolBarManager
, CoolBarManager
,
or a StatusLineManager
.
This interface is internal to the framework; it should not be implemented outside the framework.
IContributionManager
Method Summary | |
---|---|
void |
dispose()
Disposes of this contribution item. |
void |
fill(Composite parent)
Fills the given composite control with controls representing this contribution item. |
void |
fill(CoolBar parent,
int index)
Fills the given cool bar with controls representing this contribution item. |
void |
fill(Menu parent,
int index)
Fills the given menu with controls representing this contribution item. |
void |
fill(ToolBar parent,
int index)
Fills the given tool bar with controls representing this contribution item. |
String |
getId()
Returns the identifier of this contribution item. |
boolean |
isDirty()
Returns whether this contribution item is dirty. |
boolean |
isDynamic()
Returns whether this contribution item is dynamic. |
boolean |
isEnabled()
Returns whether this contribution item is enabled. |
boolean |
isGroupMarker()
Returns whether this contribution item is a group marker. |
boolean |
isSeparator()
Returns whether this contribution item is a separator. |
boolean |
isVisible()
Returns whether this contribution item is visibile within its manager. |
void |
saveWidgetState()
Saves any state information of the control(s) owned by this contribution item. |
void |
setParent(IContributionManager parent)
Sets the parent manager of this item |
void |
setVisible(boolean visible)
Sets whether this contribution item is visibile within its manager. |
void |
update()
Updates any SWT controls cached by this contribution item with any changes which have been made to this contribution item since the last update. |
void |
update(String id)
Updates any SWT controls cached by this contribution item with changes for the the given property. |
Method Detail |
public void dispose()
public void fill(Composite parent)
StatusLineManager
.
parent
- the parent controlpublic void fill(Menu parent, int index)
MenuManager
.
parent
- the parent menuindex
- the index where the controls are inserted,
or -1
to insert at the endpublic void fill(ToolBar parent, int index)
ToolBarManager
.
parent
- the parent tool barindex
- the index where the controls are inserted,
or -1
to insert at the endpublic void fill(CoolBar parent, int index)
CoolBarManager
.
parent
- the parent cool barindex
- the index where the controls are inserted,
or -1
to insert at the endpublic String getId()
null
if nonepublic boolean isEnabled()
true
if this item is enabledpublic boolean isDirty()
true
if this item is dirtypublic boolean isDynamic()
true
if this item is dynamic, and
false
for normal itemspublic boolean isGroupMarker()
true
if this item is a group marker, and
false
for normal itemsGroupMarker
,
IContributionManager.appendToGroup(String, IContributionItem)
,
IContributionManager.prependToGroup(String, IContributionItem)
public boolean isSeparator()
true
if this item is a separator, and
false
for normal itemsSeparator
public boolean isVisible()
true
if this item is visible, and
false
otherwisepublic void saveWidgetState()
public void setParent(IContributionManager parent)
parent
- the parent contribution managerpublic void setVisible(boolean visible)
visible
- true
if this item should be visible, and
false
otherwisepublic void update()
public void update(String id)
id
- the id of the changed property
|
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.