Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.ui.part
Class PageSite

    java.lang.Object
      org.eclipse.ui.part.PageSite

All Implemented Interfaces:
  IAdaptable, IPageSite, IWorkbenchSite

public class PageSite
extends Object
implements IPageSite

This implementation of `IPageSite` provides a site for a page within a `PageBookView`. Most methods are forwarded to the view's site.

Constructor Summary
`PageSite(IViewSite parentViewSite)` Creates a new sub view site of the given parent view site.

Method Summary
`protected void` | `dispose()` Disposes of the menu extender contributions.
`IActionBars` | `getActionBars()` The PageSite implementation of this `IPageSite` method returns the `SubActionBars` for this site.
`Object` | `getAdapter(Class adapter)` Returns an object which is an instance of the given class associated with this object.
`IWorkbenchPage` | `getPage()` Returns the page containing this workbench site.
`ISelectionProvider` | `getSelectionProvider()` Returns the selection provider for this workbench site.
`Shell` | `getShell()` Returns the shell for this workbench site.
`IWorkbenchWindow` | `getWorkbenchWindow()` Returns the workbench window containing this workbench site.
`void` | `registerContextMenu(String menuID, MenuManager menuMgr, ISelectionProvider selProvider)` Registers a pop-up menu with a particular id for extension.
`void` | `setSelectionProvider(ISelectionProvider provider)` Sets the selection provider for this workbench site.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### PageSite

    public PageSite(IViewSite parentViewSite)

  Creates a new sub view site of the given parent view site.

Parameters:
  `parentViewSite` - the parent view site

Method Detail

### dispose

    protected void dispose()

  Disposes of the menu extender contributions.

### getActionBars

    public IActionBars getActionBars()

  The PageSite implementation of this `IPageSite` method returns the `SubActionBars` for this site.

  Specified by:
    `getActionBars` in interface `IPageSite`
  Returns:
    the subactionbars for this site

### getPage

    public IWorkbenchPage getPage()

  Description copied from interface: `IWorkbenchSite`
  Returns the page containing this workbench site.

  Specified by:
    `getPage` in interface `IWorkbenchSite`
  Returns:
    the page containing this workbench site

### getSelectionProvider

    public ISelectionProvider getSelectionProvider()

  Description copied from interface: `IWorkbenchSite`
  Returns the selection provider for this workbench site.

  Specified by:
    `getSelectionProvider` in interface `IWorkbenchSite`
  Returns:
    the selection provider, or `null` if none

### getShell

    public Shell getShell()

  Description copied from interface: `IWorkbenchSite`
  Returns the shell for this workbench site.

  Specified by:
    `getShell` in interface `IWorkbenchSite`
  Returns:
    the shell for this workbench site

### getWorkbenchWindow

    public IWorkbenchWindow getWorkbenchWindow()

  Description copied from interface: `IWorkbenchSite`
  Returns the workbench window containing this workbench site.

  Specified by:
    `getWorkbenchWindow` in interface `IWorkbenchSite`
  Returns:
    the workbench window containing this workbench site

### registerContextMenu

    public void registerContextMenu(String menuID,
                                    MenuManager menuMgr,
                                    ISelectionProvider selProvider)

  Description copied from interface: `IPageSite`
  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.

  Specified by:
    `registerContextMenu` in interface `IPageSite`
  Parameters:
    `menuID` - the menu id
    `menuMgr` - the menu manager
    `selProvider` - the selection provider

### setSelectionProvider

    public void setSelectionProvider(ISelectionProvider provider)

  Description copied from interface: `IWorkbenchSite`
  Sets the selection provider for this workbench site.

  Specified by:
    `setSelectionProvider` in interface `IWorkbenchSite`
  Parameters:
    `provider` - the selection provider, or `null` to clear it

### getAdapter

    public Object getAdapter(Class adapter)

  Description copied from interface: `IAdaptable`
  Returns an object which is an instance of the given class associated with this object. Returns `null` if no such object can be found.

  Specified by:
    `getAdapter` in interface `IAdaptable`
  Parameters:
    `adapter` - the adapter class to look up
  Returns:
    a object castable to the given class, or `null` if this object does not have an adapter for the given class

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
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, 2004. All rights reserved.