upstream/ipython Commit - r8711:88f5822c

Document more function....

Matthias BUSSONNIER -

r8711:88f5822c

parent child

IPython/frontend/html/notebook/static/js/textcell.js

0 +69 -28

                  var key = IPython.utils.keycodes;
                  /**
+                  * Construct a new TextCell, codemirror mode is by default 'htmlmixed', and cell type is 'text'
+                  * cell start as not redered.
+                  *
                   * @class TextCell
-                  * @constructs TextCell
+                  * @constructor TextCell
                   */
                  var TextCell = function () {
                      this.code_mirror_mode = this.code_mirror_mode || 'htmlmixed';
                  TextCell.prototype = new IPython.Cell();
-                 /** create the DOM element of the TextCell
+                 /**
+                  * Create the DOM element of the TextCell
                   * @method create_element
                   * @private
                   */
                  };
-                 /** bind the DOM evet to cell actions
+                 /**
+                  * Bind the DOM evet to cell actions
                   * Need to be called after TextCell.create_element
                   * @private
                   * @method bind_event
                      });
                  };
-                 /** This method gets called in CodeMirror's onKeyDown/onKeyPress
+                 /**
+                  * This method gets called in CodeMirror's onKeyDown/onKeyPress
                   * handlers and is used to provide custom key handling.
                   *
+                  * Subclass should override this method to have custom handeling
+                  *
                   * @method handle_codemirror_keyevent
-                  * @param {CodeMirror } editor - The codemirror instance bound to the cell
+                  * @param {CodeMirror} editor - The codemirror instance bound to the cell
                   * @param {event} event -
-                  * @return {Boolean} <tt>true</tt> if CodeMirror should ignore the event, `false` Otherwise
+                  * @return {Boolean} `true` if CodeMirror should ignore the event, `false` Otherwise
                   */
                  TextCell.prototype.handle_codemirror_keyevent = function (editor, event) {
                  };
                  /**
-                  * Select the current cell
+                  * Select the current cell and trigger 'focus'
                   * @method select
                   */
                  TextCell.prototype.select = function () {
                      output.trigger('focus');
                  };
-                 /** unselect the current cell
+                 /**
+                  * unselect the current cell and `render` it
                   * @method unselect
                   */
                  TextCell.prototype.unselect = function() {
                      IPython.Cell.prototype.unselect.apply(this);
                  };
-                 /** put the current cell in edition mode
+                 /**
+                  *
+                  * put the current cell in edition mode
                   * @method edit
                   */
                  TextCell.prototype.edit = function () {
                  };
-                 /** Subclasses must define render.
+                 /**
+                  * Empty, Subclasses must define render.
                   * @method render
                   */
                  TextCell.prototype.render = function () {};
                      }
                  };
-                 /** Create Text cell from JSON
+                 /**
+                  * Create Text cell from JSON
                   * @param {json} data - JSON serialized text-cell
+                  * @method fromJSON
                   */
                  TextCell.prototype.fromJSON = function (data) {
                      IPython.Cell.prototype.fromJSON.apply(this, arguments);
                      }
                  };
+                 /** Generate JSON from cell
+                  * @return {object} cell data serialised to json
+                  */
                  TextCell.prototype.toJSON = function () {
                      var data = IPython.Cell.prototype.toJSON.apply(this);
                      data.cell_type = this.cell_type;
                  /**
-                  * @constructs HtmlCell
+                  * @constructor HtmlCell
                   * @class HtmlCell
                   * @extends TextCell
                   */
                  HTMLCell.prototype = new TextCell();
+                 /**
+                  * @method render
+                  */
                  HTMLCell.prototype.render = function () {
                      if (this.rendered === false) {
                          var text = this.get_text();
                  };
-                 // MarkdownCell
-                 /** @class MarkdownCell
-                  * @constructs MarkdownCell
+                 /**
+                  * @class MarkdownCell
+                  * @constructor MarkdownCell
                   * @extends HtmlCell
                   */
                  var MarkdownCell = function () {
                  MarkdownCell.prototype = new TextCell();
+                 /**
+                  * @method render
+                  */
                  MarkdownCell.prototype.render = function () {
                      if (this.rendered === false) {
                          var text = this.get_text();
                  // RawCell
-                 /** @construct RawCell
+                 /**
+                  * @class RawCell
+                  * @constructor RawCell
                   * @extends TextCell
                   */
                  var RawCell = function () {
                  RawCell.prototype = new TextCell();
+                 /**
+                  * Trigger autodetection of highlight scheme for current cell
+                  * @method auto_highlight
+                  */
                  RawCell.prototype.auto_highlight = function () {
                      this._auto_highlight(IPython.config.raw_cell_highlight);
                  };
+                 /** @method render **/
                  RawCell.prototype.render = function () {
                      this.rendered = true;
                      this.edit();
                  };
+                 /** @method handle_codemirror_keyevent **/
                  RawCell.prototype.handle_codemirror_keyevent = function (editor, event) {
-                     // This method gets called in CodeMirror's onKeyDown/onKeyPress
-                     // handlers and is used to provide custom key handling. Its return
-                     // value is used to determine if CodeMirror should ignore the event:
-                     // true = ignore, false = don't ignore.
                      var that = this;
                      if (event.which === key.UPARROW && event.type === 'keydown') {
                      return false;
                  };
+                 /** @method select **/
                  RawCell.prototype.select = function () {
                      IPython.Cell.prototype.select.apply(this);
                      this.code_mirror.refresh();
                      this.code_mirror.focus();
                  };
+                 /** @method at_top **/
                  RawCell.prototype.at_top = function () {
                      var cursor = this.code_mirror.getCursor();
                      if (cursor.line === 0 && cursor.ch === 0) {
                  };
+                 /** @method at_bottom **/
                  RawCell.prototype.at_bottom = function () {
                      var cursor = this.code_mirror.getCursor();
                      if (cursor.line === (this.code_mirror.lineCount()-1) && cursor.ch === this.code_mirror.getLine(cursor.line).length) {
                  };
-                 /** @constructs HeadingCell
+                 /**
+                  * @class HeadingCell
+                  * @extends TextCell
+                  */
+                 /**
+                  * @constructor HeadingCell
                   * @extends TextCell
                   */
                  var HeadingCell = function () {
                      this.placeholder = "Type Heading Here";
                      IPython.TextCell.apply(this, arguments);
-                     this.cell_type = 'heading';
+                     /**
+                      * heading level of the cell, use getter and setter to access
+                      * @property level
+                      */
                      this.level = 1;
+                     this.cell_type = 'heading';
                  };
                  HeadingCell.prototype = new TextCell();
-                 /** from json */
+                 /** @method fromJSON */
                  HeadingCell.prototype.fromJSON = function (data) {
                      if (data.level != undefined){
                          this.level = data.level;
                  };
+                 /** @method toJSON */
                  HeadingCell.prototype.toJSON = function () {
                      var data = IPython.TextCell.prototype.toJSON.apply(this);
                      data.level = this.get_level();
                  };
+                 /**
+                  * Change heading level of cell, and re-render
+                  * @method set_level
+                  */
                  HeadingCell.prototype.set_level = function (level) {
                      this.level = level;
                      if (this.rendered) {
                  };
                  /** The depth of header cell, based on html (h1 to h6)
+                  * @method get_level
                   * @return {integer} level - for 1 to 6
                   */
                  HeadingCell.prototype.get_level = function () {

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No reviewers

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages