mediawiki-extensions-Visual.../modules/ve/dm/nodes/ve.dm.HeadingNode.js
Timo Tijhof ab7d6bf082 Documentation & clean up
* Commands for Sublime:

  Find*: "(\* @[a-z]+) ([^{].*) \{(.*)\}"
  Replace: "$1 {$3} $2"

  Save all && Close all

  Find: " function("
  Replace: " function ("

  Save all && Close all

  Find: "Intialization"
  Replace: "Initialization"

  Save all && Close all

* Consistent use of types (documented in CODING.rm):
  - Merged {Integer} into {Number}.
  - Merged {DOM Node} into {DOMElement}.

* Remove work-around /*jshint newcap: false */ from ve.js
  Calling Object() as a function to to use the internal
  toObject no longer throws a newcap warning in JSHint.
  It only does that normal functions now .

  (e.g. var a = Cap(); or var a = new uncap();)

* Add missing annotations (@static, @method, ..).

* Remove unused variables

* Remove null-assignments to variables that should just be
  undefined. There's a few variables explicitly set to null
  whereas they are set a few lines under and not used otherwise
  (e.g. 'tx' in ve.ce.Surface.prototype.onPaste)

Change-Id: I0721a08f8ecd93c25595aedaa1aadb0e08b83799
2012-09-17 16:02:52 +02:00

78 lines
2 KiB
JavaScript

/**
* VisualEditor data model HeadingNode class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* DataModel node for a heading.
*
* @class
* @constructor
* @extends {ve.dm.BranchNode}
* @param {ve.dm.LeafNode[]} [children] Child nodes to attach
* @param {Object} [attributes] Reference to map of attribute key/value pairs
* @param {Object} [internal] Reference to internal data object
*/
ve.dm.HeadingNode = function VeDmHeadingNode( children, attributes, internal ) {
// Parent constructor
ve.dm.BranchNode.call( this, 'heading', children, attributes, internal );
};
/* Inheritance */
ve.inheritClass( ve.dm.HeadingNode, ve.dm.BranchNode );
/* Static Members */
/**
* Node rules.
*
* @see ve.dm.NodeFactory
* @static
* @member
*/
ve.dm.HeadingNode.rules = {
'isWrapped': true,
'isContent': false,
'canContainContent': true,
'childNodeTypes': null,
'parentNodeTypes': null
};
/**
* Node converters.
*
* @see {ve.dm.Converter}
* @static
* @member
*/
ve.dm.HeadingNode.converters = {
'domElementTypes': ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'],
'toDomElement': function ( type, element ) {
return element.attributes && ( {
1: document.createElement( 'h1' ),
2: document.createElement( 'h2' ),
3: document.createElement( 'h3' ),
4: document.createElement( 'h4' ),
5: document.createElement( 'h5' ),
6: document.createElement( 'h6' )
} )[element.attributes.level];
},
'toDataElement': function ( tag ) {
return ( {
'h1': { 'type': 'heading', 'attributes': { 'level': 1 } },
'h2': { 'type': 'heading', 'attributes': { 'level': 2 } },
'h3': { 'type': 'heading', 'attributes': { 'level': 3 } },
'h4': { 'type': 'heading', 'attributes': { 'level': 4 } },
'h5': { 'type': 'heading', 'attributes': { 'level': 5 } },
'h6': { 'type': 'heading', 'attributes': { 'level': 6 } }
} )[tag];
}
};
/* Registration */
ve.dm.nodeFactory.register( 'heading', ve.dm.HeadingNode );