mediawiki-extensions-Visual.../modules/ve/init/ve.init.Target.js
Trevor Parscal 332e31fb00 Toolbar API
Objectives:

* Make it possible to add items to toolbars without having to have all
  toolbars know about the items in advance
* Make it possible to specialize an existing tool and have it be used
  instead of the base implementation

Approach:

* Tools are named using a path-style category/id/ext system, making them
  selectable, the latter component being used to differentiate extended
  tools from their base classes, but is ignored during selection
* Toolbars have ToolGroups, which include or exclude tools by category or
  category/id, and order them by promoting and demoting selections of
  tools by category or category/id

Future:

* Add a way to place available but not yet placed tools in an "overflow"
  group
* Add a mode to ToolGroup to make the tools a multi-column drop-down style
  list with labels so tools with less obvious icons are easier to identify
  - and probably use this as the overflow group

Change-Id: I7625f861435a99ce3d7a2b1ece9731aaab1776f8
2013-08-20 16:08:26 -07:00

75 lines
1.3 KiB
JavaScript

/*!
* 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 ve.EventEmitter
*
* @constructor
* @param {jQuery} $container Conainter to render target into
*/
ve.init.Target = function VeInitTarget( $container ) {
// Mixin constructors
ve.EventEmitter.call( this );
// Properties
this.$ = $container;
};
/* Inheritance */
ve.mixinClass( ve.init.Target, ve.EventEmitter );
/* Static Properties */
ve.init.Target.static.toolbarGroups = [
{
'include': [ 'history' ],
'promote': [
'history/undo',
'history/redo'
]
},
{
'include': [ 'format' ],
'promote': [ 'format/convert' ]
},
{
'include': [ 'textStyle', 'meta', 'utility/clear' ],
'promote': [
'textStyle/bold',
'textStyle/italic',
'meta/link'
],
'demote': [ 'utility/clear' ]
},
{
'include': [ 'structure' ],
'promote': [
'structure/number',
'structure/bullet',
'structure/outdent',
'structure/indent'
]
},
{ 'include': [ 'object' ] }
];
ve.init.Target.static.surfaceCommands = [
'history/undo',
'history/redo',
'textStyle/bold',
'textStyle/italic',
'meta/link',
'utility/clear',
'structure/indent',
'structure/outdent'
];