|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The primary interface between a workbench part and the outside world.
This interface is not intended to be implemented or extended by clients.
Method Summary | |
String |
getId()
Returns the part registry extension id for this workbench site's part. |
String |
getPluginId()
Returns the unique identifier of the plug-in that defines this workbench site's part. |
String |
getRegisteredName()
Returns the registered name for this workbench site's part. |
void |
registerContextMenu(MenuManager menuManager,
ISelectionProvider selectionProvider)
Registers a pop-up menu with the default id for extension. |
void |
registerContextMenu(String menuId,
MenuManager menuManager,
ISelectionProvider selectionProvider)
Registers a pop-up menu with a particular id for extension. |
Methods inherited from interface org.eclipse.ui.IWorkbenchSite |
getPage, getSelectionProvider, getShell, getWorkbenchWindow, setSelectionProvider |
Method Detail |
public String getId()
The name comes from the id
attribute in the configuration
element.
#getConfigurationElement
public String getPluginId()
IPluginDescriptor.getUniqueIdentifier()
public String getRegisteredName()
The name comes from the name
attribute in the configuration
element.
public void registerContextMenu(String menuId, MenuManager menuManager, ISelectionProvider selectionProvider)
For a detailed description of context menu registration see
registerContextMenu(MenuManager, ISelectionProvider);
menuId
- the menu idmenuManager
- the menu managerselectionProvider
- the selection providerpublic void registerContextMenu(MenuManager menuManager, ISelectionProvider selectionProvider)
Within the workbench one plug-in may extend the pop-up menus for a view
or editor within another plug-in. In order to be eligible for extension,
the target part must publish each menu by calling registerContextMenu
.
Once this has been done the workbench will automatically insert any action
extensions which exist.
A menu id must be provided for each registered menu. For consistency across parts the following strategy should be adopted by all part implementors.
id == part id
. This can be done easily by calling
registerContextMenu(MenuManager, ISelectionProvider).
- If the target part has more than one context menu a unique id should be
defined for each. Prefix each menu id with the part id and publish these
ids within the javadoc for the target part. Register each menu at
runtime by calling
registerContextMenu(String, MenuManager,
ISelectionProvider)
.
Any pop-up menu which is registered with the workbench should also define a
GroupMarker
in the registered menu with id
IWorkbenchActionConstants.MB_ADDITIONS
. Other plug-ins will use this
group as a reference point for insertion. The marker should be defined at an
appropriate location within the menu for insertion.
menuManager
- the menu managerselectionProvider
- the selection provider
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |