Page MenuHomeWickedGov Phorge
Files F4130029

EditCheckAction.js
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

EditCheckAction.js
View Options

/**
* EditCheckAction
*
* @param {Object} config
* @param {mw.editcheck.BaseEditCheck} check
* @param {ve.dm.SurfaceFragment[]} fragments Affected fragments
* @param {jQuery|string|Function|OO.ui.HtmlSnippet} message Check message body
* @param {jQuery|string|Function|OO.ui.HtmlSnippet} title Check title
*/
mw.editcheck.EditCheckAction = function MWEditCheckAction( config ) {
// Mixin constructors
OO.EventEmitter.call( this );
this.check = config.check;
this.fragments = config.fragments;
this.focusFragment = config.focusFragment;
this.message = config.message;
this.id = config.id;
this.title = config.title;
this.icon = config.icon;
this.type = config.type || 'warning';
};
OO.initClass( mw.editcheck.EditCheckAction );
OO.mixinClass( mw.editcheck.EditCheckAction, OO.EventEmitter );
/**
* Get the action's title
*
* @return {jQuery|string|Function|OO.ui.HtmlSnippet}
*/
mw.editcheck.EditCheckAction.prototype.getTitle = function () {
return this.title || this.check.getTitle( this );
};
/**
* Get the available choices
*
* @return {Object[]}
*/
mw.editcheck.EditCheckAction.prototype.getChoices = function () {
return this.check.getChoices( this );
};
/**
* Get selections to highlight for this check
*
* @return {ve.dm.Selection[]}
*/
mw.editcheck.EditCheckAction.prototype.getHighlightSelections = function () {
return this.fragments.map( ( fragment ) => fragment.getSelection() );
};
mw.editcheck.EditCheckAction.prototype.getFocusSelection = function () {
// TOOD: Instead of fragments[0], create a fragment that covers all fragments?
return ( this.focusFragment || this.fragments[ 0 ] ).getSelection();
};
/**
* Get a description of the check
*
* @return {string}
*/
mw.editcheck.EditCheckAction.prototype.getDescription = function () {
return this.message || this.check.getDescription( this );
};
mw.editcheck.EditCheckAction.prototype.getType = function () {
return this.type;
};
/**
* Get the name of the check type
*
* @return {string} Check type name
*/
mw.editcheck.EditCheckAction.prototype.getName = function () {
return this.check.getName();
};
mw.editcheck.EditCheckAction.prototype.render = function ( collapsed, singleAction, surface ) {
const widget = new mw.editcheck.EditCheckActionWidget( {
type: this.type,
icon: this.icon,
label: this.getTitle(),
message: this.getDescription(),
classes: collapsed ? [ 've-ui-editCheckActionWidget-collapsed' ] : '',
mode: this.check.mode,
singleAction: singleAction
} );
widget.actions.connect( this, {
click: [ 'onActionClick', surface ]
} );
widget.actions.add( this.getChoices().map(
( choice ) => new OO.ui.ActionWidget( ve.extendObject( { modes: [ '' ], framed: true }, choice ) )
) );
return widget;
};
/**
* Called when a button in the rendered widget is clicked
*
* @param {ve.ui.Surface} surface
* @param {OO.ui.ActionWidget} actionWidget ActionWidget for the choice that was clicked
*/
mw.editcheck.EditCheckAction.prototype.onActionClick = function ( surface, actionWidget ) {
const promise = this.check.act( actionWidget.action, this, surface );
this.emit( 'act', promise || ve.createDeferred().resolve().promise() );
ve.track( 'activity.editCheck-' + this.getName(), { action: 'action-' + ( actionWidget.getAction() || 'unknown' ) } );
};
/**
* @param {mw.editcheck.EditCheckAction} other
* @return {boolean}
*/
mw.editcheck.EditCheckAction.prototype.equals = function ( other ) {
// Same check type?
if ( this.check.constructor !== other.check.constructor ) {
return false;
}
// If ids are present, they're the only thing that counts
if ( this.id || other.id ) {
return this.id === other.id;
}
// Shortcut the fragment check if possible
if ( this.fragments.length !== other.fragments.length ) {
return false;
}
// Now they're the same if every fragment is found in both actions
return this.fragments.every( ( fragment ) => {
const selection = fragment.getSelection();
return other.fragments.some( ( otherFragment ) => otherFragment.getSelection().equals( selection ) );
} );
};
mw.editcheck.EditCheckActionWidget = function MWEditCheckActionWidget( config ) {
// Configuration initialization
config = config || {};
this.singleAction = config.singleAction;
this.mode = config.mode || '';
this.actions = new OO.ui.ActionSet();
this.actions.connect( this, {
change: 'onActionsChange'
} );
// Parent constructor
mw.editcheck.EditCheckActionWidget.super.call( this, config );
this.message = new OO.ui.LabelWidget( { label: config.message } );
this.$actions = $( '<div>' ).addClass( 've-ui-editCheckActionWidget-actions oo-ui-element-hidden' );
this.$element.on( 'click', this.onClick.bind( this ) );
this.$body = $( '<div>' )
.append( this.message.$element, this.$actions )
.addClass( 've-ui-editCheckActionWidget-body' );
this.$element
.append( this.$body )
.addClass( 've-ui-editCheckActionWidget' );
};
OO.inheritClass( mw.editcheck.EditCheckActionWidget, OO.ui.MessageWidget );
/**
* Called when actions are changed
*/
mw.editcheck.EditCheckActionWidget.prototype.onActionsChange = function () {
this.$actions.empty().addClass( 'oo-ui-element-hidden' );
this.actions.get( { modes: [ this.mode ] } ).forEach( ( actionWidget ) => {
this.$actions.append( actionWidget.$element ).removeClass( 'oo-ui-element-hidden' );
} );
};
/**
* @inheritdoc
*/
mw.editcheck.EditCheckActionWidget.prototype.setDisabled = function ( disabled ) {
OO.ui.Widget.prototype.setDisabled.call( this, disabled );
this.actions.forEach( null, ( action ) => {
action.setDisabled( disabled );
} );
};
mw.editcheck.EditCheckActionWidget.prototype.onClick = function ( e ) {
if ( this.singleAction ) {
return;
}
if ( this.$body[ 0 ].contains( e.target ) ) {
return;
}
e.preventDefault();
// eslint-disable-next-line no-jquery/no-class-state
this.$element.toggleClass( 've-ui-editCheckActionWidget-collapsed' );
// eslint-disable-next-line no-jquery/no-class-state
this.emit( 'togglecollapse', this.$element.hasClass( 've-ui-editCheckActionWidget-collapsed' ) );
};

File Metadata

Mime Type
text/plain
Expires
Wed, Aug 19, 10:12 (2 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
99/2e/286c1c4b3768b93bdac1d02e5583
Default Alt Text
EditCheckAction.js (5 KB)

Event Timeline