/* * 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 . */ ( function ( mw, $, oo ) { var TTFP; /** * Represents any text field that needs to be truncated to be readable. * Depending on its length, text in that field might be truncated or its font size reduced (or neither). * * More specifically, TruncatableTextField should be invoked with a fixed-width container as the first * parameter and a flexible-width element (which gets its size from the text it contains) as the second * one. The first element gets overflow: hidden; if the second element overflows, TruncatableTextField * will go through the following: * - decrease size to 80% * - decrease size to 50%, use two lines (if the multiline flag is enabled) * - append an ellipse to the end, make the container flexible-width (in effect, untruncate the text) * on click * * @class mw.mmv.ui.TruncatableTextField * @extends mw.mmv.ui.Element * @constructor * @param {jQuery} $container The container for the element. * @param {jQuery} $element The element where we should put the text. * @param {Object} [options] * @param {string[]} [options.styles] a list of styles to try if the text does not fit into the container. * Will stop at the first which makes the text fit; the last one will be used even if it does not make * the text fit. */ function TruncatableTextField( $container, $element, options ) { mw.mmv.ui.Element.call( this, $container ); /** @property {jQuery} $element The DOM element that holds text for this element. */ this.$element = $element; /** @property {Object} options - */ this.options = $.extend( {}, this.defaultOptions, options ); /** @property {boolean} expanded true if the text is long enough to be truncated but the full text is shown */ this.expanded = false; /** @property {jQuery} ellipsis the element which marks that the text was truncated */ this.$ellipsis = null; /** @property {string} normalTitle title attribute to show when the text is not truncated */ this.normalTitle = null; /** @property {string} truncatedTitle title attribute to show when the text is not truncated */ this.truncatedTitle = null; /** @property {mw.mmv.HtmlUtils} htmlUtils Our HTML utility instance. */ this.htmlUtils = new mw.mmv.HtmlUtils(); this.init(); } oo.inheritClass( TruncatableTextField, mw.mmv.ui.Element ); TTFP = TruncatableTextField.prototype; /** * Default options * @property {Object} defaultOptions */ TTFP.defaultOptions = { styles: ['mw-mmv-ttf-small', 'mw-mmv-ttf-smaller', 'mw-mmv-ttf-smallest'] }; /** * @private * Initializes the DOM. */ TTFP.init = function () { this.$ellipsis = $( '' ) .text( '…' ) .hide() .addClass( 'mw-mmv-ttf-ellipsis'); this.$container .addClass( 'mw-mmv-ttf-container empty' ) .append( this.$element, this.$ellipsis ); }; TTFP.attach = function () { $( window ).on( 'resize.mmv-ttf', $.debounce( 100, $.proxy( this.repaint, this ) ) ); }; TTFP.unattach = function () { $( window ).off( 'resize.mmv-ttf' ); }; /** * Sets the string for the element. * @param {string} value Warning - unsafe HTML is allowed here. */ TTFP.set = function ( value ) { this.$element.empty().append( this.htmlUtils.htmlToTextWithLinks( value ) ); this.changeStyle(); this.$container.toggleClass( 'empty', !value ); this.$ellipsis.hide(); this.shrink(); }; TTFP.empty = function () { this.$element.empty(); this.$container .removeClass( this.options.styles.join( ' ' ) ) .removeClass( 'mw-mmv-ttf-untruncated mw-mmv-ttf-truncated' ) .addClass( 'empty' ); this.$ellipsis.hide(); this.setTitle( '', '' ); this.expanded = false; }; /** * Recalculate truncation after layout changes (such as resize) */ TTFP.repaint = function () { this.changeStyle(); this.$ellipsis.hide(); this.shrink(); }; /** * Allows setting different titles for fully visible and for truncated text. * @param {string} normal * @param {string} truncated */ TTFP.setTitle = function ( normal, truncated ) { this.normalTitle = normal; this.truncatedTitle = truncated; this.updateTitle(); }; /** * Selects the right title to use (for full or for truncated version). The title can be set with setTitle(). */ TTFP.updateTitle = function () { var $elementsWithTitle = this.$element.add( this.$ellipsis ); $elementsWithTitle.attr( 'original-title', this.isTruncated() ? this.truncatedTitle : this.normalTitle ); }; /** * Returns true if the text is long enough that it needs to be truncated. * @return {boolean} */ TTFP.isTruncatable = function () { // height calculation logic does not work for expanded state since the container expands // to envelop the element, but we never go into expanded state for non-truncatable elements anyway return this.$container.height() < this.$element.height() || this.expanded; }; /** * Returns true if the text is truncated at the moment. * @return {boolean} */ TTFP.isTruncated = function () { return this.isTruncatable() && !this.expanded; }; /** * Makes the container fixed-width, clipping the text. * This will only add a .mw-mmv-ttf-truncated class; it's the caller's responsibility to define the fixed * height for that class. */ TTFP.shrink = function () { if ( this.isTruncatable() ) { this.expanded = false; this.$container.addClass( 'mw-mmv-ttf-truncated' ).removeClass( 'mw-mmv-ttf-untruncated' ); this.$ellipsis.show(); this.updateTitle(); } }; /** * Makes the container flexible-width, thereby restoring the full text. */ TTFP.grow = function () { if ( this.isTruncatable() ) { this.expanded = true; this.$container.removeClass( 'mw-mmv-ttf-truncated' ).addClass( 'mw-mmv-ttf-untruncated' ); this.$ellipsis.hide(); this.updateTitle(); } }; /** * Changes the element style if a certain length is reached. */ TTFP.changeStyle = function () { var oldClass, newClass = 'mw-mmv-ttf-normal', field = this; this.$container .removeClass( this.options.styles.join( ' ' ) ) .removeClass( 'mw-mmv-ttf-untruncated mw-mmv-ttf-truncated' ) .addClass( newClass ); this.expanded = false; $.each( this.options.styles, function ( k, v ) { if ( !field.isTruncatable() ) { return false; } oldClass = newClass; newClass = v; field.$container.removeClass( oldClass).addClass( newClass ); } ); }; mw.mmv.ui.TruncatableTextField = TruncatableTextField; }( mediaWiki, jQuery, OO ) );