Page MenuHomeWickedGov Phorge
Files F4096839

EditCheckGutterSidebarDialog.js
No OneTemporary
Actions

Size
6 KB
Referenced Files
None
Subscribers
None

EditCheckGutterSidebarDialog.js
View Options

/*!
* VisualEditor UserInterface EditCheckGutterSidebarDialog class.
*
* @copyright See AUTHORS.txt
*/
ve.ui.GutterSidebarEditCheckDialog = function VeUiGutterSidebarEditCheckDialog( config ) {
// Parent constructor
ve.ui.GutterSidebarEditCheckDialog.super.call( this, config );
this.$element.addClass( 've-ui-editCheckGutterSidebarDialog' );
};
OO.inheritClass( ve.ui.GutterSidebarEditCheckDialog, ve.ui.SidebarDialog );
ve.ui.GutterSidebarEditCheckDialog.static.name = 'gutterSidebarEditCheckDialog';
ve.ui.GutterSidebarEditCheckDialog.static.size = 'gutter';
// The gutter should never steal the focus, as it's intended to be a discreet notification
ve.ui.GutterSidebarEditCheckDialog.static.activeSurface = true;
ve.ui.GutterSidebarEditCheckDialog.prototype.initialize = function () {
// Parent method
ve.ui.GutterSidebarEditCheckDialog.super.prototype.initialize.call( this );
};
ve.ui.GutterSidebarEditCheckDialog.prototype.getSetupProcess = function ( data ) {
const process = this.constructor.super.prototype.getSetupProcess.call( this, data );
return process.first( () => {
this.controller = data.controller;
this.listener = data.listener || data.controller.listener;
this.surface = data.controller.surface;
this.surface.getTarget().$element.addClass( 've-ui-editCheck-gutter-active' );
this.controller.on( 'actionsUpdated', this.onActionsUpdated, null, this );
this.controller.on( 'position', this.onPosition, null, this );
this.renderActions( data.actions || this.controller.getActions( this.listener ) );
}, this );
};
ve.ui.GutterSidebarEditCheckDialog.prototype.getTeardownProcess = function ( data ) {
// Parent method
const process = ve.ui.GutterSidebarEditCheckDialog.super.prototype.getTeardownProcess.call( this, data );
return process.first( () => {
this.controller.disconnect( this );
this.surface = null;
this.controller = null;
}, this );
};
ve.ui.GutterSidebarEditCheckDialog.prototype.onActionsUpdated = function ( listener, actions ) {
if ( listener !== this.listener ) {
return;
}
this.renderActions( actions );
};
ve.ui.GutterSidebarEditCheckDialog.prototype.onPosition = function () {
this.renderActions( this.controller.getActions( this.listener ) );
};
ve.ui.GutterSidebarEditCheckDialog.prototype.renderActions = function ( actions ) {
if ( actions.length === 0 ) {
return this.close( 'complete' );
}
const surfaceView = this.surface.getView();
const sections = [];
// First join overlapping actions into "sections"
actions.forEach( ( action ) => {
const selection = action.getHighlightSelections()[ 0 ];
const selectionView = ve.ce.Selection.static.newFromModel( selection, surfaceView );
const rect = selectionView.getSelectionBoundingRect();
if ( !rect ) {
return;
}
// Look for any other section that the new one overlaps with
// TODO: join when two other sections are joined by the new one?
const prev = sections.find( ( p ) => !( p.rect.bottom < rect.top || rect.bottom < p.rect.top ) );
if ( prev ) {
// overlap, so merge
prev.actions.push( action );
// top, bottom, left, right, width, height
prev.rect.top = Math.min( prev.rect.top, rect.top );
prev.rect.bottom = Math.max( prev.rect.bottom, rect.bottom );
prev.rect.height = prev.rect.bottom - prev.rect.top;
return;
}
sections.push( { actions: [ action ], rect: rect } );
} );
// Now try to reuse old widgets if possible, to avoid icons flickering
const oldWidgets = this.widgets || [];
this.widgets = [];
sections.forEach( ( section ) => {
const action = section.actions[ 0 ];
let widget;
const index = oldWidgets.findIndex(
( owidget ) => owidget.actions.length === section.actions.length &&
owidget.actions.every( ( oact ) => section.actions.includes( oact ) )
);
if ( index !== -1 ) {
widget = oldWidgets.splice( index, 1 )[ 0 ];
} else {
const icon = new OO.ui.IconWidget( {
icon: mw.editcheck.EditCheckActionWidget.static.iconMap[ action.getType() ] || 'notice'
} );
const iconLabel = new OO.ui.LabelWidget( {
label: section.actions.length.toString(),
invisibleLabel: section.actions.length === 1
} );
widget = {
actions: section.actions,
icon: icon,
iconLabel: iconLabel,
$element: $( '<div>' )
.addClass( 've-ui-editCheck-gutter-action' )
// The following classes are used here:
// * ve-ui-editCheck-gutter-action-error
// * ve-ui-editCheck-gutter-action-warning
// * ve-ui-editCheck-gutter-action-notice
// * ve-ui-editCheck-gutter-action-success
.addClass( 've-ui-editCheck-gutter-action-' + action.getType() )
.append( icon.$element, iconLabel.$element )
.on( 'click', () => {
if ( this.listener === 'onDocumentChange' ) {
// mid-edit
const currentWindow = this.surface.getToolbarDialogs( ve.ui.FixedEditCheckDialog.static.position ).getCurrentWindow();
if ( !currentWindow || currentWindow.constructor.static.name !== 'fixedEditCheckDialog' ) {
const windowAction = ve.ui.actionFactory.create( 'window', this.surface, 'check' );
windowAction.open(
'fixedEditCheckDialog',
{
controller: this.controller,
listener: this.listener,
actions: section.actions,
footer: section.actions.length !== 1,
// just filter out any discarded actions from the allowed set
updateFilter: ( updatedActions, newActions, discardedActions, prevActions ) => prevActions.filter( ( pact ) => !discardedActions.includes( pact ) )
}
);
} else if ( section.actions.every( ( sact ) => currentWindow.hasAction( sact ) ) ) {
// Second click: defocus and close
return this.controller.closeDialog();
} else {
currentWindow.showActions( section.actions, [ action ] );
currentWindow.footer.toggle( section.actions.length !== 1 );
}
}
this.controller.focusAction( action, true );
} )
};
this.$body.append( widget.$element );
}
if ( widget.actions.includes( this.controller.focused ) ) {
widget.icon.setFlags( action.getType() );
} else {
widget.icon.clearFlags();
}
widget.$element.css( {
top: section.rect.top + 2,
height: section.rect.height
} ).toggleClass( 've-ui-editCheck-gutter-action-inactive', !section.actions.includes( this.controller.focused ) );
this.widgets.push( widget );
} );
oldWidgets.forEach( ( widget ) => widget.$element.remove() );
// surfaceView.$element.after( this.$mobile );
};
/* Registration */
ve.ui.windowFactory.register( ve.ui.GutterSidebarEditCheckDialog );

File Metadata

Mime Type
text/plain
Expires
Tue, Aug 18, 14:31 (3 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
1e/74/2fba688d1fe566ce632e0836b7bb
Default Alt Text
EditCheckGutterSidebarDialog.js (6 KB)

Event Timeline