Interface IEditorSite
- All Superinterfaces:
IAdaptable
,IServiceLocator
,IShellProvider
,IWorkbenchPartSite
,IWorkbenchSite
- All Known Implementing Classes:
EditorSite
,MultiPageEditorSite
The workbench exposes its implemention of editor part 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 Summary
Modifier and TypeMethodDescriptionReturns the action bar contributor for this editor.Returns the action bars for this part site.void
registerContextMenu
(String menuId, MenuManager menuManager, ISelectionProvider selectionProvider, boolean includeEditorInput) Registers a pop-up menu with a particular id for extension.void
registerContextMenu
(MenuManager menuManager, ISelectionProvider selectionProvider, boolean includeEditorInput) Registers a pop-up menu with the default id for extension.Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
Methods inherited from interface org.eclipse.ui.services.IServiceLocator
getService, hasService
Methods inherited from interface org.eclipse.ui.IWorkbenchPartSite
getId, getKeyBindingService, getPart, getPluginId, getRegisteredName, registerContextMenu, registerContextMenu
Methods inherited from interface org.eclipse.ui.IWorkbenchSite
getPage, getSelectionProvider, getShell, getWorkbenchWindow, setSelectionProvider
-
Method Details
-
getActionBarContributor
IEditorActionBarContributor getActionBarContributor()Returns the action bar contributor for this editor.An action contributor is responsable for the creation of actions. By design, this contributor is used for one or more editors of the same type. Thus, the contributor returned by this method is not owned completely by the editor - it is shared.
- Returns:
- the editor action bar contributor, or
null
if none exists
-
getActionBars
IActionBars getActionBars()Returns the action bars for this part site. Editors of the same type (and in the same window) share the same action bars. Contributions to the action bars are done by theIEditorActionBarContributor
.- Returns:
- the action bars
- Since:
- 2.1
-
registerContextMenu
void registerContextMenu(MenuManager menuManager, ISelectionProvider selectionProvider, boolean includeEditorInput) Registers a pop-up menu with the default id for extension. The default id is defined as the part id.
By default, context menus include object contributions based on the editor input for the current editor. It is possible to override this behaviour by calling this method with
includeEditorInput
asfalse
. This might be desirable for editors that present a localized view of an editor input (e.g., a node in a model editor).For a detailed description of context menu registration see
IWorkbenchPartSite.registerContextMenu(MenuManager, ISelectionProvider)
- Parameters:
menuManager
- the menu manager; must not benull
.selectionProvider
- the selection provider; must not benull
.includeEditorInput
- Whether the editor input should be included when adding object contributions to this context menu.- Since:
- 3.1
- See Also:
-
registerContextMenu
void registerContextMenu(String menuId, MenuManager menuManager, ISelectionProvider selectionProvider, boolean includeEditorInput) Registers a pop-up menu with a particular id for extension. This method should only be called if the target part has more than one context menu to register.
By default, context menus include object contributions based on the editor input for the current editor. It is possible to override this behaviour by calling this method with
includeEditorInput
asfalse
. This might be desirable for editors that present a localized view of an editor input (e.g., a node in a model editor).For a detailed description of context menu registration see
IWorkbenchPartSite.registerContextMenu(MenuManager, ISelectionProvider)
- Parameters:
menuId
- the menu id; must not benull
.menuManager
- the menu manager; must not benull
.selectionProvider
- the selection provider; must not benull
.includeEditorInput
- Whether the editor input should be included when adding object contributions to this context menu.- Since:
- 3.1
- See Also:
-