mediawiki-extensions-Multim.../resources/mmv/ui/mmv.ui.description.js
Gergő Tisza 3a18515163 Replace filename with caption/description
* when the caption is available, use it as the image title
* otherwise, fall back to description if available
* otherwise, fall back to filename
* if both caption and description are available, show caption as
  title and show description below the fold; otherwise don't show anything
  below the fold.

Change-Id: I9738ca46620d7cf3b30f6e46790a37966d4b9eaf
Mingle: https://wikimedia.mingle.thoughtworks.com/projects/multimedia/cards/589
2014-11-11 15:33:15 +00:00

68 lines
2.2 KiB
JavaScript

/*
* This file is part of the MediaWiki extension MultimediaViewer.
*
* MultimediaViewer is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* MultimediaViewer is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MultimediaViewer. If not, see <http://www.gnu.org/licenses/>.
*/
( function ( mw, $, oo ) {
/**
* Description element in the UI.
* @class mw.mmv.ui.Description
* @extends mw.mmv.ui.Element
* @constructor
* @inheritdoc
*/
function Description( $container ) {
mw.mmv.ui.Element.call( this, $container );
/** @property {mw.mmv.HtmlUtils} htmlUtils - */
this.htmlUtils = new mw.mmv.HtmlUtils();
this.$imageDescDiv = $( '<div>' )
.addClass( 'mw-mmv-image-desc-div empty' )
.appendTo( this.$container );
this.$imageDesc = $( '<p>' )
.addClass( 'mw-mmv-image-desc' )
.appendTo( this.$imageDescDiv );
}
oo.inheritClass( Description, mw.mmv.ui.Element );
/**
* Sets data on the element.
* This complements MetadataPanel.setTitle() - information shown there will not be shown here.
* @param {string|null} description The text of the description
* @param {string|null} caption The text of the caption
*/
Description.prototype.set = function ( description, caption ) {
if ( caption && description ) { // panel header shows the caption - show description here
this.$imageDesc.html( this.htmlUtils.htmlToTextWithLinks( description ) );
this.$imageDescDiv.removeClass( 'empty' );
} else { // either there is no description or the paner header already shows it - nothing to do here
this.empty();
}
};
/**
* @inheritdoc
*/
Description.prototype.empty = function () {
this.$imageDesc.empty();
this.$imageDescDiv.addClass( 'empty' );
};
mw.mmv.ui.Description = Description;
}( mediaWiki, jQuery, OO ) );