mediawiki-extensions-Echo/modules/ui/mw.echo.ui.ClonedNotificationItemWidget.js
Novem Linguae 030bc26ae9 JSDoc: convert @cfg to @param
- convert @cfg to @param
- in mw.echo.dm.NotificationItem.js, add backticks around
  a block of code in a docblock so that it renders nicely
  in the generated /docs/

Bug: T138401
Change-Id: If7df2ab72fa835af662a8f01cc0c5edb1cb79c2b
2024-05-26 18:43:21 -07:00

88 lines
2.4 KiB
JavaScript

( function () {
/* global moment:false */
/**
* A wrapper widget for a fake, cloned notification. This is used
* for the fade in/out effects while reordering.
*
* @class
* @extends OO.ui.Widget
*
* @constructor
* @param {jQuery} $element A clone of an mw.echo.ui.NotificationItemWidget's $element
* @param {Object} [config] Configuration options
* @param {string} [config.timestamp] The timestamp for this cloned widget, in UTC and ISO 8601 format
* @param {boolean} [config.read=false] The read state for this cloned widget
* @param {boolean} [config.foreign=false] The foreignness state of this cloned widget
* @param {number} [config.id] The id for this cloned widget
*/
mw.echo.ui.ClonedNotificationItemWidget = function MwEchoUiClonedNotificationItemWidget( $element, config ) {
config = config || {};
// Parent constructor
mw.echo.ui.ClonedNotificationItemWidget.super.call( this, config );
this.$element = $element;
this.timestamp = config.timestamp || moment.utc().format( 'YYYY-MM-DD[T]HH:mm:ss[Z]' );
this.read = !!config.read;
this.foreign = config.foreign === undefined ? true : config.foreign;
this.id = config.id;
this.$element.addClass( 'mw-echo-ui-clonedNotificationItemWidget' );
};
/* Initialization */
OO.inheritClass( mw.echo.ui.ClonedNotificationItemWidget, OO.ui.Widget );
/**
* Get the widget's timestamp
*
* @return {string} Timestamp in UTC, ISO 8601 format
*/
mw.echo.ui.ClonedNotificationItemWidget.prototype.getTimestamp = function () {
return this.timestamp;
};
/**
* Get the widget's read state
*
* @return {boolean} Widget is read
*/
mw.echo.ui.ClonedNotificationItemWidget.prototype.isRead = function () {
return this.read;
};
/**
* Get the widget's id
*
* @return {number} Widget id
*/
mw.echo.ui.ClonedNotificationItemWidget.prototype.getId = function () {
return this.id;
};
/**
* The foreign state of this widget
*
* @return {boolean} This item widget is foreign
*/
mw.echo.ui.ClonedNotificationItemWidget.prototype.isForeign = function () {
return this.foreign;
};
/**
* This widget is fake by definition.
*
* @return {boolean} true
*/
mw.echo.ui.ClonedNotificationItemWidget.prototype.isFake = function () {
return true;
};
/**
* No-op
*/
mw.echo.ui.ClonedNotificationItemWidget.prototype.resetInitiallyUnseen = function () {
};
}() );