소스 검색

onCellMetadataChanged -> onActiveCellMetadataChanged to be more descriptive.

Jason Grout 6 년 전
부모
커밋
aae14ef4b6
2개의 변경된 파일22개의 추가작업 그리고 16개의 파일을 삭제
  1. 8 6
      packages/notebook/src/notebooktools.ts
  2. 14 10
      tests/test-notebook/src/notebooktools.spec.ts

+ 8 - 6
packages/notebook/src/notebooktools.ts

@@ -216,7 +216,7 @@ export class NotebookTools extends Widget implements INotebookTools {
     args: IObservableMap.IChangedArgs<JSONValue>
   ): void {
     let message = new ObservableJSON.ChangeMessage(
-      'cell-metadata-changed',
+      'activecell-metadata-changed',
       args
     );
     each(this._toolChildren(), widget => {
@@ -316,8 +316,8 @@ export namespace NotebookTools {
         case 'selection-changed':
           this.onSelectionChanged(msg);
           break;
-        case 'cell-metadata-changed':
-          this.onCellMetadataChanged(msg as ObservableJSON.ChangeMessage);
+        case 'activecell-metadata-changed':
+          this.onActiveCellMetadataChanged(msg as ObservableJSON.ChangeMessage);
           break;
         default:
           break;
@@ -360,7 +360,9 @@ export namespace NotebookTools {
      * #### Notes
      * The default implementation is a no-op.
      */
-    protected onCellMetadataChanged(msg: ObservableJSON.ChangeMessage): void {
+    protected onActiveCellMetadataChanged(
+      msg: ObservableJSON.ChangeMessage
+    ): void {
       /* no-op */
     }
   }
@@ -562,7 +564,7 @@ export namespace NotebookTools {
     /**
      * Handle a change to the active cell metadata.
      */
-    protected onCellMetadataChanged(msg: Message): void {
+    protected onActiveCellMetadataChanged(msg: Message): void {
       let cell = this.notebookTools.activeCell;
       this.editor.source = cell ? cell.model.metadata : null;
     }
@@ -664,7 +666,7 @@ export namespace NotebookTools {
     /**
      * Handle a change to the metadata of the active cell.
      */
-    protected onCellMetadataChanged(msg: ObservableJSON.ChangeMessage) {
+    protected onActiveCellMetadataChanged(msg: ObservableJSON.ChangeMessage) {
       if (this._changeGuard) {
         return;
       }

+ 14 - 10
tests/test-notebook/src/notebooktools.spec.ts

@@ -41,9 +41,11 @@ class LogTool extends NotebookTools.Tool {
     this.methods.push('onSelectionChanged');
   }
 
-  protected onCellMetadataChanged(msg: ObservableJSON.ChangeMessage): void {
-    super.onCellMetadataChanged(msg);
-    this.methods.push('onCellMetadataChanged');
+  protected onActiveCellMetadataChanged(
+    msg: ObservableJSON.ChangeMessage
+  ): void {
+    super.onActiveCellMetadataChanged(msg);
+    this.methods.push('onActiveCellMetadataChanged');
   }
 }
 
@@ -71,9 +73,11 @@ class LogKeySelector extends NotebookTools.KeySelector {
     this.methods.push('onActiveCellChanged');
   }
 
-  protected onCellMetadataChanged(message: ObservableJSON.ChangeMessage): void {
-    super.onCellMetadataChanged(message);
-    this.methods.push('onCellMetadataChanged');
+  protected onActiveCellMetadataChanged(
+    message: ObservableJSON.ChangeMessage
+  ): void {
+    super.onActiveCellMetadataChanged(message);
+    this.methods.push('onActiveCellMetadataChanged');
   }
 
   protected onValueChanged(): void {
@@ -203,7 +207,7 @@ describe('@jupyterlab/notebook', () => {
         });
       });
 
-      describe('#onCellMetadataChanged()', () => {
+      describe('#onActiveCellMetadataChanged()', () => {
         it('should be called when the metadata changes', () => {
           const tool = new LogTool({});
           notebookTools.addItem({ tool });
@@ -211,7 +215,7 @@ describe('@jupyterlab/notebook', () => {
           const metadata = notebookTools.activeCell.model.metadata;
           metadata.set('foo', 1);
           metadata.set('foo', 2);
-          expect(tool.methods).to.contain('onCellMetadataChanged');
+          expect(tool.methods).to.contain('onActiveCellMetadataChanged');
         });
       });
     });
@@ -381,11 +385,11 @@ describe('@jupyterlab/notebook', () => {
         });
       });
 
-      describe('#onCellMetadataChanged()', () => {
+      describe('#onActiveCellMetadataChanged()', () => {
         it('should update the select value', () => {
           const metadata = notebookTools.activeCell.model.metadata;
           metadata.set('foo', 1);
-          expect(tool.methods).to.contain('onCellMetadataChanged');
+          expect(tool.methods).to.contain('onActiveCellMetadataChanged');
           expect(tool.selectNode.value).to.equal('1');
         });
       });