Interface IPageSite

All Superinterfaces:
IAdaptable, IServiceLocator, IShellProvider, IWorkbenchSite
All Known Implementing Classes:
PageSite

public interface IPageSite extends IWorkbenchSite
The primary interface between a page and the outside world.

The workbench exposes its implemention of page sites via this interface, which is not intended to be implemented or extended by clients.

Restriction:
This interface is not intended to be implemented by clients.
  • Method Details

    • registerContextMenu

      void registerContextMenu(String menuId, MenuManager menuManager, ISelectionProvider selectionProvider)
      Registers a pop-up menu with a particular id for extension.

      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 menu must be registered by calling registerContextMenu. Once this has been done the workbench will automatically insert any action extensions which exist.

      A unique menu id must be provided for each registered menu. This id should be published in the Javadoc for the page.

      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.

      Parameters:
      menuId - the menu id
      menuManager - the menu manager
      selectionProvider - the selection provider
    • getActionBars

      IActionBars getActionBars()
      Returns the action bars for this page site. Pages have exclusive use of their site's action bars.
      Returns:
      the action bars