Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /*!
* VisualEditor UserInterface Toolbar class.
*
* @copyright See AUTHORS.txt
*/
/**
* UserInterface surface toolbar.
*
* @class
* @extends OO.ui.Toolbar
*
* @constructor
* @param {Object} [config] Configuration options
*/
ve.ui.Toolbar = function VeUiToolbar( config ) {
config = config || {};
// Parent constructor
ve.ui.Toolbar.super.call( this, ve.ui.toolFactory, ve.ui.toolGroupFactory, config );
this.updateToolStateDebounced = ve.debounce( this.updateToolState.bind( this ) );
this.groups = null;
// Default directions
this.contextDirection = { inline: 'ltr', block: 'ltr' };
// The following classes are used here:
// * ve-ui-dir-inline-ltr
// * ve-ui-dir-inline-rtl
// * ve-ui-dir-block-ltr
// * ve-ui-dir-block-rtl
this.$element
.addClass( 've-ui-toolbar' )
.addClass( 've-ui-dir-inline-' + this.contextDirection.inline )
.addClass( 've-ui-dir-block-' + this.contextDirection.block );
};
/* Inheritance */
OO.inheritClass( ve.ui.Toolbar, OO.ui.Toolbar );
/* Events */
/**
* @event ve.ui.Toolbar#updateState
* @param {ve.dm.SurfaceFragment|null} fragment Surface fragment. Null if no surface is active.
* @param {Object|null} direction Context direction with 'inline' & 'block' properties if a surface exists. Null if no surface is active.
* @param {string[]} activeDialogs List of names of currently open dialogs.
*/
/**
* @event ve.ui.Toolbar#surfaceChange
* @param {ve.ui.Surface|null} oldSurface Old surface being controlled
* @param {ve.ui.Surface|null} newSurface New surface being controlled
*/
/**
* @event ve.ui.Toolbar#resize
*/
/* Methods */
/**
* Setup toolbar
*
* @param {Object} groups List of tool group configurations
* @param {ve.ui.Surface} [surface] Surface to attach to
* @fires ve.ui.Toolbar#surfaceChange
* @fires ve.ui.Toolbar#resize
*/
ve.ui.Toolbar.prototype.setup = function ( groups, surface ) {
let oldSurface,
surfaceChange = false;
this.detach();
if ( surface !== this.surface ) {
// this.surface should be changed before we fire the event
oldSurface = this.surface;
this.surface = surface;
surfaceChange = true;
}
// The parent method just rebuilds the tool groups so only
// do this if they have changed
if ( groups !== this.groups ) {
// Parent method
groups = groups.map( ( group ) => {
if ( group.name ) {
group.classes = group.classes || [];
group.classes.push( 've-ui-toolbar-group-' + group.name );
} else {
OO.ui.warnDeprecation( 'No name: ' + JSON.stringify( group ) );
}
return group;
} );
ve.ui.Toolbar.super.prototype.setup.call( this, groups );
}
this.groups = groups;
if ( groups.length ) {
this.$element.removeClass( 've-ui-toolbar-empty' );
} else {
this.$element.addClass( 've-ui-toolbar-empty' );
}
if ( surfaceChange ) {
// Emit surface change event after tools have been setup
this.emit( 'surfaceChange', oldSurface, surface );
// Emit another resize event to let the surface know about the toolbar size
this.emit( 'resize' );
}
// Events
this.getSurface().getModel().connect( this, { contextChange: 'onContextChange' } );
this.getSurface().getDialogs().connect( this, {
opening: 'onInspectorOrDialogOpeningOrClosing',
closing: 'onInspectorOrDialogOpeningOrClosing'
} );
this.getSurface().getToolbarDialogs().connect( this, {
opening: 'onInspectorOrDialogOpeningOrClosing',
closing: 'onInspectorOrDialogOpeningOrClosing'
} );
this.getSurface().getContext().getInspectors().connect( this, {
opening: 'onInspectorOrDialogOpeningOrClosing',
closing: 'onInspectorOrDialogOpeningOrClosing'
} );
};
/**
* @inheritdoc
*/
ve.ui.Toolbar.prototype.isToolAvailable = function ( name ) {
if ( !ve.ui.Toolbar.super.prototype.isToolAvailable.apply( this, arguments ) ) {
return false;
}
// Check the tool's command is available on the surface
const tool = this.getToolFactory().lookup( name );
if ( !tool ) {
return false;
}
// FIXME should use .static.getCommandName(), but we have tools that aren't ve.ui.Tool subclasses :(
const commandName = tool.static.commandName;
return !commandName || this.getCommands().indexOf( commandName ) !== -1;
};
/**
* Handle windows opening or closing in the dialogs' or inspectors' window manager.
*
* @param {OO.ui.Window} win
* @param {jQuery.Promise} openingOrClosing
* @param {Object} data
*/
ve.ui.Toolbar.prototype.onInspectorOrDialogOpeningOrClosing = function ( win, openingOrClosing ) {
openingOrClosing.then( () => {
this.updateToolStateDebounced();
} );
};
/**
* Handle context changes on the surface.
*
* @fires ve.ui.Toolbar#updateState
*/
ve.ui.Toolbar.prototype.onContextChange = function () {
this.updateToolStateDebounced();
};
/**
* Update the state of the tools
*
* @fires ve.ui.Toolbar#updateState
*/
ve.ui.Toolbar.prototype.updateToolState = function () {
if ( !this.getSurface() ) {
this.emit( 'updateState', null, null );
return;
}
const fragment = this.getSurface().getModel().getFragment();
// Update context direction for button icons UI.
// By default, inline and block directions are the same.
// If no context direction is available, use document model direction.
let dirInline = this.surface.getView().getSelectionDirectionality();
const dirBlock = dirInline;
// 'inline' direction is different only if we are inside a language annotation
const fragmentAnnotation = fragment.getAnnotations();
if ( fragmentAnnotation.hasAnnotationWithName( 'meta/language' ) ) {
dirInline = fragmentAnnotation.getAnnotationsByName( 'meta/language' ).get( 0 ).getAttribute( 'dir' );
}
if ( dirInline !== this.contextDirection.inline ) {
// Remove previous class:
this.$element.removeClass( 've-ui-dir-inline-rtl ve-ui-dir-inline-ltr' );
// The following classes are used here:
// * ve-ui-dir-inline-ltr
// * ve-ui-dir-inline-rtl
this.$element.addClass( 've-ui-dir-inline-' + dirInline );
this.contextDirection.inline = dirInline;
}
if ( dirBlock !== this.contextDirection.block ) {
this.$element.removeClass( 've-ui-dir-block-rtl ve-ui-dir-block-ltr' );
// The following classes are used here:
// * ve-ui-dir-block-ltr
// * ve-ui-dir-block-rtl
this.$element.addClass( 've-ui-dir-block-' + dirBlock );
this.contextDirection.block = dirBlock;
}
const activeDialogs = [
this.surface.getDialogs(),
this.surface.getContext().getInspectors(),
this.surface.getToolbarDialogs()
].map( ( windowManager ) => {
if ( windowManager.getCurrentWindow() ) {
return windowManager.getCurrentWindow().constructor.static.name;
}
return null;
} ).filter( ( name ) => name !== null );
this.emit( 'updateState', fragment, this.contextDirection, activeDialogs );
};
/**
* Get triggers for a specified name.
*
* @param {string} name Trigger name
* @return {ve.ui.Trigger[]|undefined} Triggers
*/
ve.ui.Toolbar.prototype.getTriggers = function ( name ) {
return this.getSurface().triggerListener.getTriggers( name );
};
/**
* Get a list of commands available to this toolbar's surface
*
* @return {string[]} Command names
*/
ve.ui.Toolbar.prototype.getCommands = function () {
return this.getSurface().getCommands();
};
/**
* @inheritdoc
*/
ve.ui.Toolbar.prototype.getToolAccelerator = function ( name ) {
const messages = ve.ui.triggerRegistry.getMessages( name );
return messages ? messages.join( ', ' ) : undefined;
};
/**
* Gets the surface which the toolbar controls.
*
* Returns null if the toolbar hasn't been set up yet.
*
* @return {ve.ui.Surface|null} Surface being controlled
*/
ve.ui.Toolbar.prototype.getSurface = function () {
return this.surface;
};
/**
* Detach toolbar from surface and all event listeners
*/
ve.ui.Toolbar.prototype.detach = function () {
// Events
if ( this.getSurface() ) {
this.getSurface().getModel().disconnect( this );
this.surface = null;
}
// Reset narrow state/cache as when we setup again it
// may be with a different tool list.
// TODO: Create upstream detach/teardown
this.setNarrow( false );
this.narrowThreshold = null;
};
/**
* Destroys toolbar, removing event handlers and DOM elements.
*
* Call this whenever you are done using a toolbar.
*/
ve.ui.Toolbar.prototype.destroy = function () {
// Parent method
ve.ui.Toolbar.super.prototype.destroy.call( this );
// Detach surface last, because tool destructors need getSurface()
this.detach();
};
|