mediawiki-extensions-Multim.../resources/mmv/ui/mmv.ui.description.js
Gergő Tisza d85e7bf32e Utilities to transform HTML to plain or filtered text
This takes care of several minor annoyances:
* centralizes all the text processing functions which have been
  floating all around the code, and adds proper tests
* filters out invisible elements (sometimes used for metadata)
* avoids merging separate words on HTML->text transformation
* adds caching since doing all this transformations could be
  processing-intensive for big chunks of HTML. (This might or
  might not be a good idea. I haven't done performance tests, so
  this might be premature optimization, and increases memory use.
  OTOH these functions are often called in situations where an
  immediate UI response is expected (such as selecting a size
  from the list) so even small delays would be perceivable.

Bug: 63126
Change-Id: I1ef1e3a33efdfea17612df00da6b629bf39e07aa
Mingle: https://wikimedia.mingle.thoughtworks.com/projects/multimedia/cards/388
Mingle: https://wikimedia.mingle.thoughtworks.com/projects/multimedia/cards/369
2014-03-27 19:11:09 +00:00

79 lines
2.3 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-mlb-image-desc-div empty' )
.appendTo( this.$container );
this.$imageCaption = $( '<p>' )
.addClass( 'mw-mlb-caption empty' )
.appendTo( this.$imageDescDiv );
this.$imageDesc = $( '<p>' )
.addClass( 'mw-mlb-image-desc' )
.appendTo( this.$imageDescDiv );
}
oo.inheritClass( Description, mw.mmv.ui.Element );
/**
* Sets data on the element.
* @param {string} text The text of the description
* @param {string} [caption] The text of the caption
*/
Description.prototype.set = function ( text, caption ) {
this.$imageDescDiv.toggleClass( 'empty', !text && !caption );
this.$imageCaption.toggleClass( 'empty', !caption );
this.$imageDesc.toggleClass( 'empty', !text );
if ( caption ) {
this.$imageCaption.html( this.htmlUtils.htmlToTextWithLinks( caption ) );
}
if ( text ) {
this.$imageDesc.html( this.htmlUtils.htmlToTextWithLinks( text ) );
} else {
this.$imageDesc.empty().append( mw.message( 'multimediaviewer-desc-nil' ).text() );
}
};
/**
* @inheritdoc
*/
Description.prototype.empty = function () {
this.$imageDesc.empty();
this.$imageDescDiv.addClass( 'empty' );
this.$imageCaption.empty().addClass( 'empty' );
};
mw.mmv.ui.Description = Description;
}( mediaWiki, jQuery, OO ) );