浏览代码

Rename fileopener -> documentmanager

Steven Silvester 9 年之前
父节点
当前提交
14ca619501
共有 7 个文件被更改,包括 46 次插入47 次删除
  1. 6 6
      src/documentmanager/index.ts
  2. 12 12
      src/documentmanager/plugin.ts
  3. 4 4
      src/filehandler/plugin.ts
  4. 4 4
      src/imagehandler/plugin.ts
  5. 1 1
      src/index.ts
  6. 17 18
      src/notebook/plugin.ts
  7. 2 2
      src/tsconfig.json

+ 6 - 6
src/fileopener/index.ts → src/documentmanager/index.ts

@@ -57,31 +57,31 @@ interface IFileHandler {
 
 
 /**
- * An interface for a file opener.
+ * An interface for a document manager.
  */
 export
-interface IFileOpener {
+interface IDocumentManager {
   /**
    * Open the file and add the widget to the application shell.
    */
   open(model: IContentsModel): Widget;
 
   /**
-   * Register a file opener.
+   * Register a file handler.
    *
    * @param handler - The file handler to register.
    */
   register(handler: IFileHandler): void;
 
   /**
-   * Register a default file opener.
+   * Register a default file handler.
    */
   registerDefault(handler: IFileHandler): void;
 }
 
 
 /**
- * The dependency token for the `IFileOpener` interface.
+ * The dependency token for the `IDocumentManager` interface.
  */
 export
-const IFileOpener = new Token<IFileOpener>('jupyter-js-plugins.IFileOpener');
+const IDocumentManager = new Token<IDocumentManager>('jupyter-js-plugins.IDocumentManager');

+ 12 - 12
src/fileopener/plugin.ts → src/documentmanager/plugin.ts

@@ -42,7 +42,7 @@ import {
 } from '../index';
 
 import {
-  IFileOpener, IFileHandler
+  IDocumentManager, IFileHandler
 } from './index';
 
 
@@ -59,8 +59,8 @@ const FOCUS_CLASS = 'jp-mod-focus';
 export
 function resolve(container: Container): Promise<void> {
   return container.resolve({
-    requires: [IAppShell, IFileOpener, IFileBrowserWidget, ICommandPalette, ICommandRegistry, IShortcutManager],
-    create: (appShell: IAppShell, opener: IFileOpener, browser: IFileBrowserWidget, palette: ICommandPalette, registry: ICommandRegistry, shortcuts: IShortcutManager): void => {
+    requires: [IAppShell, IDocumentManager, IFileBrowserWidget, ICommandPalette, ICommandRegistry, IShortcutManager],
+    create: (appShell: IAppShell, manager: IDocumentManager, browser: IFileBrowserWidget, palette: ICommandPalette, registry: ICommandRegistry, shortcuts: IShortcutManager): void => {
 
       // Create a command to add a new empty text file.
       // This requires an id and an instance of a command object.
@@ -71,7 +71,7 @@ function resolve(container: Container): Promise<void> {
         caption: 'Create a new text file',
         handler: () => {
           browser.newUntitled('file', '.txt').then(
-            contents => opener.open(contents)
+            contents => manager.open(contents)
           );
         }
       });
@@ -106,7 +106,7 @@ function resolve(container: Container): Promise<void> {
         caption: 'Create a new Jupyter Notebook',
         handler: () => {
           browser.newUntitled('notebook').then(
-            contents => opener.open(contents)
+            contents => manager.open(contents)
           );
         }
       });
@@ -132,7 +132,7 @@ function resolve(container: Container): Promise<void> {
       ]);
 
       browser.widgetFactory = model => {
-        return opener.open(model);
+        return manager.open(model);
       }
     }
   });
@@ -141,22 +141,22 @@ function resolve(container: Container): Promise<void> {
 
 export
 function register(container: Container): void {
-  container.register(IFileOpener, {
+  container.register(IDocumentManager, {
     requires: [IAppShell, IFileBrowserWidget],
-    create: (appShell, browserProvider): IFileOpener => {
-      return new FileOpener(appShell, browserProvider);
+    create: (appShell, browserProvider): IDocumentManager => {
+      return new DocumentManager(appShell, browserProvider);
     }
   });
 }
 
 
 /**
- * An implementation on an IFileOpener.
+ * An implementation on an IDocumentManager.
  */
-class FileOpener implements IFileOpener {
+class DocumentManager implements IDocumentManager {
 
   /**
-   * Construct a new file opener.
+   * Construct a new document manager.
    */
   constructor(appShell: IAppShell, browser: IFileBrowserWidget) {
     this._appShell = appShell;

+ 4 - 4
src/filehandler/plugin.ts

@@ -15,7 +15,7 @@ import {
 } from 'phosphor-widget';
 
 import {
-  IServicesProvider, IFileOpener, IFileHandler
+  IServicesProvider, IDocumentManager, IFileHandler
 } from '../index';
 
 
@@ -30,10 +30,10 @@ import {
 export
 function resolve(container: Container): Promise<IFileHandler> {
   return container.resolve({
-    requires: [IServicesProvider, IFileOpener],
-    create: (services: IServicesProvider, opener: IFileOpener) => {
+    requires: [IServicesProvider, IDocumentManager],
+    create: (services: IServicesProvider, manager: IDocumentManager) => {
       let handler = new FileHandler(services.contentsManager);
-      opener.registerDefault(handler);
+      manager.registerDefault(handler);
       return handler;
     }
   });

+ 4 - 4
src/imagehandler/plugin.ts

@@ -19,7 +19,7 @@ import {
 } from 'phosphor-widget';
 
 import {
-  IServicesProvider, IFileOpener, IFileHandler
+  IServicesProvider, IDocumentManager, IFileHandler
 } from '../index';
 
 
@@ -34,10 +34,10 @@ import {
 export
 function resolve(container: Container): Promise<IFileHandler> {
   return container.resolve({
-    requires: [IServicesProvider, IFileOpener],
-    create: (services: IServicesProvider, opener: IFileOpener) => {
+    requires: [IServicesProvider, IDocumentManager],
+    create: (services: IServicesProvider, manager: IDocumentManager) => {
       let handler = new ImageHandler(services.contentsManager);
-      opener.register(handler);
+      manager.register(handler);
       return handler;
     }
   });

+ 1 - 1
src/index.ts

@@ -3,6 +3,6 @@
 'use strict';
 
 export * from './filebrowser/index';
-export * from './fileopener/index';
+export * from './documentmanager/index';
 export * from './services/index';
 export * from './terminal/index';

+ 17 - 18
src/notebook/plugin.ts

@@ -3,12 +3,16 @@
 'use strict';
 
 import {
-  NotebookWidget, NotebookModel, NBData, populateNotebookModel, buildOutputModel, Output
-} from 'jupyter-js-notebook';
+  CodeCellModel, ICellModel, isCodeCell, BaseCellModel
+} from 'jupyter-js-cells';
 
 import {
-  Container
-} from 'phosphor-di';
+  AbstractFileHandler
+} from 'jupyter-js-filebrowser';
+
+import {
+  NotebookWidget, NotebookModel, NBData, populateNotebookModel, buildOutputModel, Output
+} from 'jupyter-js-notebook';
 
 import {
   IContentsModel, IContentsManager,
@@ -17,25 +21,20 @@ import {
 } from 'jupyter-js-services';
 
 import {
-  Panel
-} from 'phosphor-panel';
-
-import {
-  IServicesProvider, IFileOpener, IFileHandler
-} from '../index';
+  Container
+} from 'phosphor-di';
 
 import {
-  AbstractFileHandler
-} from 'jupyter-js-filebrowser';
+  Panel
+} from 'phosphor-panel';
 
 import {
   Widget
 } from 'phosphor-widget';
 
-
 import {
-  CodeCellModel, ICellModel, isCodeCell, BaseCellModel
-} from 'jupyter-js-cells';
+  IServicesProvider, IDocumentManager, IFileHandler
+} from '../index';
 
 import {
   WidgetManager
@@ -53,10 +52,10 @@ import {
 export
 function resolve(container: Container): Promise<IFileHandler> {
   return container.resolve({
-    requires: [IServicesProvider, IFileOpener],
-    create: (services: IServicesProvider, opener: IFileOpener) => {
+    requires: [IServicesProvider, IDocumentManager],
+    create: (services: IServicesProvider, manager: IDocumentManager) => {
       let handler = new NotebookFileHandler(services.contentsManager, services.notebookSessionManager);
-      opener.register(handler);
+      manager.register(handler);
       return handler;
     }
   });

+ 2 - 2
src/tsconfig.json

@@ -18,8 +18,8 @@
     "filebrowser/index.ts",
     "filebrowser/plugin.ts",
     "filehandler/plugin.ts",
-    "fileopener/index.ts",
-    "fileopener/plugin.ts",
+    "documentmanager/index.ts",
+    "documentmanager/plugin.ts",
     "imagehandler/plugin.ts",
     "notebook/plugin.ts",
     "notebook/widgetmanager.ts",