mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-12-21 18:43:25 +00:00
aa556e3ef8
I tried to review all of them. Some of the changes I did: * Make sure the `config` parameter is not marked as optional when it is not. * Make sure default values are mentioned. * List individual `@cfg` options when it makes sense. Note I don't list all options a class could accept (e.g. via all its parent classes and mixins). That's too much. Instead I checked how a class is actually used and list only these options. Even then I don't list everything, e.g. unspecific options like "classes" that can be used pretty much everywhere. Change-Id: Idf4fbe1dc3608ace277df9e385f2f140df3a2f50
118 lines
3 KiB
JavaScript
118 lines
3 KiB
JavaScript
/*!
|
|
* VisualEditor user interface MWGalleryItemWidget class.
|
|
*
|
|
* @copyright 2011-2020 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Draggable item widget for the MWGalleryGroupWidget
|
|
*
|
|
* @class
|
|
* @extends OO.ui.Widget
|
|
* @mixins OO.ui.mixin.DraggableElement
|
|
*
|
|
* @constructor
|
|
* @param {Object} imageInfo Image information object
|
|
* @param {Object} [config] Configuration options
|
|
* @cfg {boolean} [isMobile=false]
|
|
* @cfg {boolean} [draggable=true]
|
|
*/
|
|
ve.ui.MWGalleryItemWidget = function VeUiMWGalleryItemWidget( imageInfo, config ) {
|
|
this.resource = imageInfo.resource;
|
|
this.altText = imageInfo.altText || '';
|
|
this.src = imageInfo.src;
|
|
this.height = imageInfo.height;
|
|
this.width = imageInfo.width;
|
|
this.thumbUrl = imageInfo.thumbUrl;
|
|
this.captionDocument = imageInfo.captionDocument;
|
|
this.highlighted = false;
|
|
this.tagName = imageInfo.tagName;
|
|
|
|
// Configuration initialization
|
|
config = config || {};
|
|
|
|
// Parent constructor
|
|
ve.ui.MWGalleryItemWidget.super.call( this, config );
|
|
|
|
this.$element
|
|
.addClass( 've-ui-mwGalleryDialog-image-container' ) // TODO: put in new CSS file?
|
|
.addClass( config.isMobile ?
|
|
've-ui-mwGalleryDialog-image-container-mobile' :
|
|
've-ui-mwGalleryDialog-image-container-desktop'
|
|
)
|
|
.css( 'background-image', 'url(' + this.thumbUrl + ')' );
|
|
|
|
// Mixin constructors
|
|
OO.ui.mixin.DraggableElement.call( this, ve.extendObject( { $handle: this.$element }, config ) );
|
|
OO.ui.mixin.TabIndexedElement.call( this, config );
|
|
|
|
this.$element.on( {
|
|
click: this.onItemClick.bind( this ),
|
|
keypress: this.onItemKeyPress.bind( this )
|
|
} );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
OO.inheritClass( ve.ui.MWGalleryItemWidget, OO.ui.Widget );
|
|
|
|
OO.mixinClass( ve.ui.MWGalleryItemWidget, OO.ui.mixin.DraggableElement );
|
|
OO.mixinClass( ve.ui.MWGalleryItemWidget, OO.ui.mixin.TabIndexedElement );
|
|
|
|
/* Events */
|
|
|
|
/**
|
|
* @event edit
|
|
*/
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Handle clicking on an item
|
|
*/
|
|
ve.ui.MWGalleryItemWidget.prototype.onItemClick = function () {
|
|
this.emit( 'edit', this );
|
|
};
|
|
|
|
/**
|
|
* Handle key press events
|
|
*
|
|
* @param {jQuery.Event} e Key press event
|
|
* @return {boolean}
|
|
*/
|
|
ve.ui.MWGalleryItemWidget.prototype.onItemKeyPress = function ( e ) {
|
|
if ( e.which === OO.ui.Keys.ENTER ) {
|
|
this.emit( 'edit', this );
|
|
return false;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Set the captionDocument property
|
|
*
|
|
* @param {ve.dm.Document} captionDocument The caption document
|
|
*/
|
|
ve.ui.MWGalleryItemWidget.prototype.setCaptionDocument = function ( captionDocument ) {
|
|
this.captionDocument = captionDocument;
|
|
};
|
|
|
|
/**
|
|
* Set the altText property
|
|
*
|
|
* @param {string} altText The altText
|
|
*/
|
|
ve.ui.MWGalleryItemWidget.prototype.setAltText = function ( altText ) {
|
|
this.altText = altText;
|
|
};
|
|
|
|
/**
|
|
* Toggle highlighted class
|
|
*
|
|
* @param {boolean} highlighted The item is highlighted
|
|
*/
|
|
ve.ui.MWGalleryItemWidget.prototype.toggleHighlighted = function ( highlighted ) {
|
|
highlighted = highlighted !== undefined ? highlighted : !this.highlighted;
|
|
this.$element.toggleClass( 've-ui-mwGalleryDialog-image-container-highlighted', !!highlighted );
|
|
};
|