mediawiki-extensions-Visual.../modules/ve/ce/nodes/ve.ce.ImageNode.js
Trevor Parscal 7233ea8f1b EventEmitter API cleanup
The EventEmitter API we inherited from Node.js and then bastardized was
getting awkward and cumbersome. The number of uses of ve.bind was getting
out of control, and removing events meant caching the bound method in a
property. Many of the "features" of EventEmitter wasn't even being used,
some causing overhead, others just causing bloat. This change cleans up
how EventEmitter is used throughout the codebase.

The new event emitter API includes:
* emit - identical to the previous API, no longer throws an error if you
  emit error without a handler
* once - identical to the previous API, still introduces a wrapper* on -
  compatible with the previous API but has some new features
* off - identical to removeListener in the previous API
* connect - very similar to addListenerMethods but doesn't wrap callbacks
  in closures anymore
* disconnect - new, basically the opposite of addListenerMethods

Another change that is made in this commit is mixing in rather than
inheriting from EventEmitter.

Finally, there are changes throughout the codebase anywhere
connect/disconnect could be used.

Change-Id: Ic3085d39172a8a719ce7f036690f673e59848d3a
2013-05-02 15:05:59 -07:00

113 lines
2.5 KiB
JavaScript

/*!
* VisualEditor ContentEditable ImageNode class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* ContentEditable image node.
*
* @class
* @extends ve.ce.LeafNode
* @mixins ve.ce.FocusableNode
* @mixins ve.ce.RelocatableNode
* @mixins ve.ce.ResizableNode
*
* @constructor
* @param {ve.dm.ImageNode} model Model to observe
*/
ve.ce.ImageNode = function VeCeImageNode( model ) {
// Parent constructor
ve.ce.LeafNode.call( this, model, $( '<img>' ) );
// Mixin constructors
ve.ce.FocusableNode.call( this );
ve.ce.RelocatableNode.call( this );
ve.ce.ResizableNode.call( this );
// Properties
this.$image = this.$;
// Events
this.model.connect( this, { 'update': 'onUpdate' } );
this.$.on( 'click', ve.bind( this.onClick, this ) );
// Initialization
this.$image
.addClass( 've-ce-imageNode' )
.attr( 'src', this.model.getAttribute( 'src' ) )
.css( {
'width': this.model.getAttribute( 'width' ),
'height': this.model.getAttribute( 'height' )
} );
};
/* Inheritance */
ve.inheritClass( ve.ce.ImageNode, ve.ce.LeafNode );
ve.mixinClass( ve.ce.ImageNode, ve.ce.FocusableNode );
ve.mixinClass( ve.ce.ImageNode, ve.ce.RelocatableNode );
ve.mixinClass( ve.ce.ImageNode, ve.ce.ResizableNode );
/* Static Properties */
ve.ce.ImageNode.static.name = 'image';
/* Methods */
/**
* Handle attribute change events.
*
* Whitelisted attributes will be added or removed in sync with the DOM. They are initially set in
* the constructor.
*
* @method
* @param {string} key Attribute key
* @param {string} from Old value
* @param {string} to New value
*/
ve.ce.ImageNode.prototype.onAttributeChange = function ( key, from, to ) {
if ( from !== to ) {
if ( key === 'src' ) {
this.$image.attr( 'src', to );
}
if ( key === 'width' || key === 'height' ) {
this.$image.css( key, to );
}
}
};
/**
* Update method
*
* @method
*/
ve.ce.ImageNode.prototype.onUpdate = function () {
};
/**
* Handle the mouse click.
*
* @method
* @param {jQuery.Event} e Click event
*/
ve.ce.ImageNode.prototype.onClick = function ( e ) {
var surfaceModel = this.getRoot().getSurface().getModel(),
selectionRange = surfaceModel.getSelection(),
nodeRange = this.model.getOuterRange();
surfaceModel.getFragment(
e.shiftKey ?
ve.Range.newCoveringRange(
[ selectionRange, nodeRange ], selectionRange.from > nodeRange.from
) :
nodeRange
).select();
};
/* Registration */
ve.ce.nodeFactory.register( ve.ce.ImageNode );