mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-12-01 17:36:35 +00:00
23c5b0d02c
* Restricting "camelcase":
No changes, we were passing all of these already
* Explicitly unrestricting "forin" and "plusplus"
These are off by default in node-jshint, but some distro of jshint
and editors that use their own wrapper around jshint instead of
node-jshint (Eclipse?) may have different defaults. Therefor
setting them to false explicitly. This also serves as a reminder
for the future so we'll always know we don't pass that, in case
we would want to change that.
* Fix order ("quotemark" before "regexp")
* Restricting "unused"
We're not passing all of this, which is why I've set it to false
for now. But I did put it in .jshintrc as placeholder.
I've fixed most of them, there's some left where there is no clean
solution.
* While at it fix a few issues:
- Unused variables ($target, $window)
- Bad practices (using jQuery context for find instead of creation)
- Redundant /*global */ comments
- Parameters that are not used and don't have documentation either
- Lines longer than 100 chars @ 4 spaces/tab
* Note:
- ve.ce.Surface.prototype.onChange takes two arguments but never
uses the former. And even the second one can be null/undefined.
Aside from that, the .change() function emits
another event for the transaction already. Looks like this
should be refactored a bit, two more separated events probably
or one that is actually used better.
- Also cleaned up a lot of comments, some of which were missing,
others were incorrect
- Reworked the contentChange event so we are no longer using the
word new as an object key; expanded a complex object into multiple
arguments being passed through the event to make it easier to work
with and document
Change-Id: I8490815a508c6c379d5f9a743bb4aefd14576aa6
138 lines
3.2 KiB
JavaScript
138 lines
3.2 KiB
JavaScript
/**
|
|
* VisualEditor user interface Menu class.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Creates an ve.ui.Menu object.
|
|
*
|
|
* @class
|
|
* @constructor
|
|
* @param {Object[]} items List of items to append initially
|
|
* @param {Function} callback Function to call if an item doesn't have its own callback
|
|
* @param {jQuery} [$overlay=$( 'body' )] DOM selection to add nodes to
|
|
*/
|
|
ve.ui.Menu = function ( items, callback, $overlay ) {
|
|
var i, menu;
|
|
|
|
// Properties
|
|
this.$ = $( '<div class="es-menuView"></div>' ).appendTo( $overlay || $( 'body' ) );
|
|
this.items = [];
|
|
this.autoNamedBreaks = 0;
|
|
this.callback = callback;
|
|
|
|
// Items
|
|
if ( ve.isArray( items ) ) {
|
|
for ( i = 0; i < items.length; i++ ) {
|
|
this.addItem( items[i] );
|
|
}
|
|
}
|
|
|
|
// Events
|
|
menu = this;
|
|
menu.$.on( {
|
|
'mousedown': function ( e ) {
|
|
if ( e.which === 1 ) {
|
|
e.preventDefault();
|
|
return false;
|
|
}
|
|
},
|
|
'mouseup': function ( e ) {
|
|
if ( e.which === 1 ) {
|
|
var name, i,
|
|
$item = $( e.target ).closest( '.es-menuView-item' );
|
|
if ( $item.length ) {
|
|
name = $item.attr( 'rel' );
|
|
for ( i = 0; i < menu.items.length; i++ ) {
|
|
if ( menu.items[i].name === name ) {
|
|
menu.onSelect( menu.items[i], e );
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} );
|
|
};
|
|
|
|
/* Methods */
|
|
|
|
ve.ui.Menu.prototype.addItem = function ( item, before ) {
|
|
if ( item === '-' ) {
|
|
item = {
|
|
'name': 'break-' + this.autoNamedBreaks++
|
|
};
|
|
}
|
|
// Items that don't have custom DOM elements will be auto-created
|
|
if ( !item.$ ) {
|
|
if ( !item.name ) {
|
|
throw new Error( 'Invalid menu item error. Items must have a name property.' );
|
|
}
|
|
if ( item.label ) {
|
|
item.$ = $( '<div class="es-menuView-item"></div>' )
|
|
.attr( 'rel', item.name )
|
|
// TODO: this should take a labelmsg instead and call ve.msg()
|
|
.append( $( '<span>' ).text( item.label ) );
|
|
} else {
|
|
// No label, must be a break
|
|
item.$ = $( '<div class="es-menuView-break"></div>' )
|
|
.attr( 'rel', item.name );
|
|
}
|
|
// TODO: Keyboard shortcut (and icons for them), support for keyboard accelerators, etc.
|
|
}
|
|
if ( before ) {
|
|
for ( var i = 0; i < this.items.length; i++ ) {
|
|
if ( this.items[i].name === before ) {
|
|
this.items.splice( i, 0, item );
|
|
this.items[i].$.before( item.$ );
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
this.items.push( item );
|
|
this.$.append( item.$ );
|
|
};
|
|
|
|
ve.ui.Menu.prototype.removeItem = function ( name ) {
|
|
for ( var i = 0; i < this.items.length; i++ ) {
|
|
if ( this.items[i].name === name ) {
|
|
this.items.splice( i, 1 );
|
|
i--;
|
|
}
|
|
}
|
|
};
|
|
|
|
ve.ui.Menu.prototype.getItems = function () {
|
|
return this.items;
|
|
};
|
|
|
|
ve.ui.Menu.prototype.setPosition = function ( position ) {
|
|
return this.$.css( {
|
|
'top': position.top,
|
|
'left': position.left
|
|
} );
|
|
};
|
|
|
|
ve.ui.Menu.prototype.open = function () {
|
|
this.$.show();
|
|
};
|
|
|
|
ve.ui.Menu.prototype.close = function () {
|
|
this.$.hide();
|
|
};
|
|
|
|
ve.ui.Menu.prototype.isOpen = function () {
|
|
return this.$.is( ':visible' );
|
|
};
|
|
|
|
ve.ui.Menu.prototype.onSelect = function ( item ) {
|
|
if ( typeof item.callback === 'function' ) {
|
|
item.callback( item );
|
|
} else if ( typeof this.callback === 'function' ) {
|
|
this.callback( item );
|
|
}
|
|
this.close();
|
|
};
|