### Eclipse Workspace Patch 1.0 #P org.eclipse.ui.navigator Index: src/org/eclipse/ui/navigator/CommonNavigator.java =================================================================== RCS file: /cvsroot/eclipse/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/CommonNavigator.java,v retrieving revision 1.47 diff -u -r1.47 CommonNavigator.java --- src/org/eclipse/ui/navigator/CommonNavigator.java 8 Mar 2009 20:45:04 -0000 1.47 +++ src/org/eclipse/ui/navigator/CommonNavigator.java 9 Mar 2010 16:28:44 -0000 @@ -63,9 +63,9 @@ * *
- * {@link org.eclipse.ui.navigator.NavigatorActionService}: Manages instances - * of {@link org.eclipse.ui.navigator.CommonActionProvider}s provided by - * individual extensions and content extensions. + * {@link org.eclipse.ui.navigator.NavigatorActionService}: Manages instances of + * {@link org.eclipse.ui.navigator.CommonActionProvider}s provided by individual + * extensions and content extensions. *
*- * Clients are not expected to subclass CommonNavigator. Clients that wish to - * define their own custom extensible navigator view need to specify an instance - * of the org.eclipse.ui.views extension point: + * Clients that wish to define their own custom extensible navigator view using + * CommonNavigator need to specify an instance of the + * org.eclipse.ui.views extension point: * *
- * + * * <extension * point="org.eclipse.ui.views"> * <view @@ -92,19 +93,37 @@ * class="org.eclipse.ui.navigator.CommonNavigator" * id="org.acme.MyCustomNavigatorID"> * </view> - * </extension> - * + * </extension> + * ** - * + * + * + *
+ * CommonNavigator gets its initial input (during initialization) from the + * Workbench by calling getSite().getPage().getInput(). This is done in + * {@link #getInitialInput()}. Clients may create a subclass of CommonNavigator + * to provide their own means of getting the initial input. Or they may access + * the {@link CommonViewer} and set its input directly after startup. + *
+ * + *+ * In the IDE scenario, the default page input is IWorkspaceRoot, in the RCP + * scenario it is null and can be configured in the WorkbenchAdvisor. + *
+ * + ** Clients that wish to extend the view menu provided via the - * org.eclipse.ui.popupMenus extension may specify the the popupMenuId - * specified by org.eclipse.ui.navigator.viewer (or a nested popupMenu element) of their target viewer - * as their target menu id. + * org.eclipse.ui.popupMenus extension may specify the the + * popupMenuId specified by org.eclipse.ui.navigator.viewer (or a + * nested popupMenu element) of their target viewer as their target menu + * id. + *
* ** This class may be instantiated or subclassed *
+ * * @since 3.2 */ public class CommonNavigator extends ViewPart implements ISetSelectionTarget, ISaveablePart, ISaveablesSource, IShowInTarget {