mediawiki-extensions-Visual.../modules/ve-mw/ui/widgets/ve.ui.MWGalleryItemWidget.js
James D. Forrester b518e55ef9 docs: Replace JSDuck with JSDoc (and pull-through VE with said change)
This is not great, but it's a start (and unblocks other pull-throughs).

New changes:
c401efc98 build: Replace jsduck with jsdoc for documentation
16ba162a0 JSDoc: @mixins -> @mixes
9e0a1f53b JSDoc: Fix complex return types
449b6cc0f Prefer arrow function callbacks
1539af2c8 Remove 'this' bindings in arrow functions
b760f3b14 Use arrow functions in OO.ui.Process steps
57c24109e Use arrow functions in jQuery callbacks
9622ccef9 Convert some remaining functions callbacks to arrow functions
f6c885021 Remove useless local variable
1cd800020 Clear branch node cache when rebuilding tree

Bug: T250843
Bug: T363329
Change-Id: I0f4878ca84b95e3f388b358b943f105637e455f9
2024-04-29 16:16:50 +01:00

140 lines
3.6 KiB
JavaScript

/*!
* VisualEditor user interface MWGalleryItemWidget class.
*
* @copyright 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.altTextSame = imageInfo.altTextSame;
this.href = imageInfo.href;
// Keep the original value which may be null
this.originalAltText = 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;
this.isError = imageInfo.isError;
this.imageClassAttr = imageInfo.imageClassAttr;
this.imgWrapperClassAttr = imageInfo.imgWrapperClassAttr;
this.mw = imageInfo.mw;
this.mediaClass = imageInfo.mediaClass;
this.mediaTag = imageInfo.mediaTag;
// Configuration initialization
config = config || {};
// Parent constructor
ve.ui.MWGalleryItemWidget.super.call( this, config );
this.$element
.addClass( 've-ui-mwGalleryDialog-image-container mw-no-invert' ) // 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 ve.ui.MWGalleryItemWidget#edit
*/
/* Methods */
/**
* Handle clicking on an item
*
* @fires edit
*/
ve.ui.MWGalleryItemWidget.prototype.onItemClick = function () {
this.emit( 'edit', this );
};
/**
* Handle key press events
*
* @param {jQuery.Event} e Key press event
* @return {boolean}
* @fires edit
*/
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;
};
/**
* Set the altTextSame property
*
* @param {boolean} same
*/
ve.ui.MWGalleryItemWidget.prototype.setAltTextSame = function ( same ) {
this.altTextSame = same;
};
/**
* 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 );
};