mediawiki-extensions-Multim.../resources/mmv/model/mmv.model.ThumbnailWidth.js
Mark Holmquist 1733df8dc9 Grand Unified Documentation Patch Jr.
The GRUDP is dead, long live the GRUDPJ

Change-Id: I71a22c3aa42b2eb799ce8104159e8c7e56fe13ae
2014-02-21 00:55:43 +00:00

68 lines
2.6 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/>.
*/
/**
* Represents image width information.
*
* To utilize caching as much as possible, we use images which are displayed at a slightly
* different size than their screen size. The ThumbnailWidth model stores the various types of
* sizes and helps avoiding accidental incompatible assignments. (Think of it as a slightly
* overcomplicated Hungarian notation :)
* @class mw.mmv.model.ThumbnailWidth
* @constructor
* @param {number} css width in CSS pixels
* @param {number} screen width in screen pixels
* @param {number} real width in real pixels
*/
function ThumbnailWidth( css, screen, real ) {
if ( !css || !screen || !real ) {
throw 'All parameters are required and cannot be empty or zero';
}
/**
* Width of the thumbnail on the screen, in CSS pixels. This is the number which can be plugged
* into UI code like $element.width(x).
* @property {number}
*/
this.css = css;
/**
* Width of the thumbnail on the screen, in device pixels. On most devices this is the same as
* the CSS width, but devices with high pixel density displays have multiple screen pixels
* in a CSS pixel.
* This value is mostly used internally; for most purposes you will need one of the others.
* @property {number}
*/
this.screen = screen;
/**
* "Real" width of the thumbnail. This is the number you need to use in API requests when
* obtaining the thumbnail URL. This is usually larger than the screen width, since
* downscaling images via CSS looks OK but upscaling them looks ugly. However, for images
* where the full size itself is very small, this can be smaller than the screen width, since
* we cannot create a thumbnail which is larger than the original image. (In such cases the
* image is just positioned to the center of the intended area and the space around it is
* left empty.)
* @property {number}
*/
this.real = real;
}
( function ( mw ) {
mw.mmv.model.ThumbnailWidth = ThumbnailWidth;
}( mediaWiki ) );