mediawiki-extensions-VisualEditor/modules/ve/init/ve.init.Target.js

/*!
 * VisualEditor Initialization Target class.
 *
 * @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */

/**
 * Generic Initialization target.
 *
 * @class
 * @abstract
 * @mixins OO.EventEmitter
 *
 * @constructor
 * @param {jQuery} $container Conainter to render target into
 */
ve.init.Target = function VeInitTarget( $container ) {
	// Mixin constructors
	OO.EventEmitter.call( this );

	// Properties
	this.$element = $container;

	/**
	 * @property {ve.ui.Surface}
	 */
	this.surface = null;

	/**
	 * @property {jQuery} The ve-ce-documentNode of #surface
	 */
	this.$document = null;

	/**
	 * @property {ve.ui.TargetToolbar}
	 */
	this.toolbar = null;
};

/* Events */

/**
 * Fired when the #surface is ready.
 *
 * By default the surface document is not focussed. If the target wants
 * the browsers' focus to be in the surface (ready for typing and cursoring)
 * call `this.$document[0].focus();` in a handler for this event.
 *
 * @event surfaceReady
 */

/* Inheritance */

OO.mixinClass( ve.init.Target, OO.EventEmitter );

/* Static Properties */

ve.init.Target.static.toolbarGroups = [
	// History
	{ 'include': [ 'undo', 'redo' ] },
	// Format
	{
		'type': 'menu',
		'include': [ { 'group': 'format' } ],
		'promote': [ 'paragraph' ],
		'demote': [ 'preformatted' ]
	},
	// Style
	{
		'type': 'list',
		'icon': 'text-style',
		'include': [ { 'group': 'textStyle' }, 'clear' ],
		'promote': [ 'bold', 'italic' ],
		'demote': [ 'strikethrough', 'code',  'underline', 'clear' ]
	},
	// Link
	{ 'include': [ 'link' ] },
	// Structure
	{
		'type': 'bar',
		'include': [ 'number', 'bullet', 'outdent', 'indent' ]
	},
	// Insert
	{
		'include': '*',
		'label': 'visualeditor-toolbar-insert',
		'demote': [ 'specialcharacter' ]
	}

];

ve.init.Target.static.surfaceCommands = [
	'undo',
	'redo',
	'bold',
	'italic',
	'link',
	'clear',
	'underline',
	'subscript',
	'superscript',
	'indent',
	'outdent',
	'paragraph',
	'heading1',
	'heading2',
	'heading3',
	'heading4',
	'heading5',
	'heading6',
	'preformatted',
	'pasteSpecial'
];

ve.init.Target.static.pasteRules = {
	'blacklist': [
		// Annotations
		// TODO: allow spans
		'textStyle/span',
		// Nodes
		'alienInline', 'alienBlock'
	]
};