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 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 | 1x 1x 1x 1x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /*! * VisualEditor ContentEditable GeneratedContentNode class. * * @copyright See AUTHORS.txt */ /** * ContentEditable generated content node. * * @class * @abstract * * @constructor */ ve.ce.GeneratedContentNode = function VeCeGeneratedContentNode() { // Properties this.generatingPromise = null; this.generatedContentsInvalid = null; // Events this.model.connect( this, { update: 'onGeneratedContentNodeUpdate' } ); this.connect( this, { teardown: 'abortGenerating' } ); // Initialization this.update(); }; /* Inheritance */ OO.initClass( ve.ce.GeneratedContentNode ); /* Events */ /** * @event ve.ce.GeneratedContentNode#rerender */ /* Static members */ // We handle rendering ourselves, no need to render attributes from originalDomElements ve.ce.GeneratedContentNode.static.renderHtmlAttributes = false; /* Static methods */ /** * Wait for all content-generation within a given node to finish * * If no GeneratedContentNodes are within the node, a resolved promise will be * returned. * * @param {ve.ce.View} view Any view node * @return {jQuery.Promise} Promise, resolved when content is generated */ ve.ce.GeneratedContentNode.static.awaitGeneratedContent = function ( view ) { const promises = []; function queueNode( node ) { Iif ( typeof node.generateContents === 'function' ) { if ( node.isGenerating() ) { const promise = ve.createDeferred(); node.once( 'rerender', promise.resolve ); promises.push( promise ); } } } // Traverse children to see when they are all rerendered if ( view instanceof ve.ce.BranchNode ) { view.traverse( queueNode ); } else E{ queueNode( view ); } return ve.promiseAll( promises ); }; /* Abstract methods */ /** * Start a deferred process to generate the contents of the node. * * If successful, the returned promise must be resolved with the generated DOM elements passed * in as the first parameter, i.e. promise.resolve( domElements ); . Any other parameters to * .resolve() are ignored. * * If the returned promise object is abortable (has an .abort() method), .abort() will be called if * a newer update is started before the current update has finished. When a promise is aborted, it * should cease its work and shouldn't be resolved or rejected. If an outdated update's promise * is resolved or rejected anyway (which may happen if an aborted promise misbehaves, or if the * promise wasn't abortable), this is ignored and doneGenerating()/failGenerating() is not called. * * Additional data may be passed in the config object to instruct this function to render something * different than what's in the model. This data is implementation-specific and is passed through * by forceUpdate(). * * @abstract * @method * @param {Object} [config] Optional additional data * @return {jQuery.Promise} Promise object, may be abortable */ ve.ce.GeneratedContentNode.prototype.generateContents = null; /* Methods */ /** * Handler for the update event * * @param {boolean} staged Update happened in staging mode */ ve.ce.GeneratedContentNode.prototype.onGeneratedContentNodeUpdate = function ( staged ) { this.update( undefined, staged ); }; /** * Make an array of DOM elements suitable for rendering. * * Subclasses can override this to provide their own cleanup steps. This function takes an * array of DOM elements cloned within the source document and returns an array of DOM elements * cloned into the target document. If it's important that the DOM elements still be associated * with the original document, you should modify domElements before calling the parent * implementation, otherwise you should call the parent implementation first and modify its * return value. * * @param {Node[]} domElements Clones of the DOM elements from the store * @return {HTMLElement[]} Clones of the DOM elements in the right document, with modifications */ ve.ce.GeneratedContentNode.prototype.getRenderedDomElements = function ( domElements ) { const doc = this.getElementDocument(); let rendering = this.filterRenderedDomElements( // Clone the elements into the target document ve.copyDomElements( domElements, doc ) ); if ( rendering.length ) { // Span wrap root text nodes so they can be measured rendering = rendering.map( ( node ) => { if ( node.nodeType === Node.TEXT_NODE ) { const span = document.createElement( 'span' ); span.appendChild( node ); return span; } return node; } ); // Render the computed values of some attributes ve.resolveAttributes( rendering, domElements[ 0 ].ownerDocument, ve.dm.Converter.static.computedAttributes ); } else { rendering = [ document.createElement( 'span' ) ]; } if ( rendering.every( ve.isVoidElement ) ) { // Should contain at least one non-void element, e.g. for attaching // a visibility button in ve.ce.FocusableNode#updateInvisibleIconSync rendering.push( document.createElement( 'span' ) ); } return rendering; }; /** * Filter out elements from the rendered content which we don't want to display in the CE. * * @param {Node[]} domElements Clones of the DOM elements from the store, already copied into the document * @return {Node[]} DOM elements to keep */ ve.ce.GeneratedContentNode.prototype.filterRenderedDomElements = function ( domElements ) { return ve.filterMetaElements( domElements ); }; /** * Rerender the contents of this node. * * @param {Object|string|Array} generatedContents Generated contents, in the default case an HTMLElement array * @param {boolean} [staged] Update happened in staging mode * @fires ve.ce.View#setup * @fires ve.ce.View#teardown * @fires ve.dm.GeneratedContentNode#generatedContentsError */ ve.ce.GeneratedContentNode.prototype.render = function ( generatedContents, staged ) { if ( this.live ) { this.emit( 'teardown' ); } const $newElements = $( this.getRenderedDomElements( ve.copyDomElements( generatedContents ) ) ); this.generatedContentsInvalid = !this.validateGeneratedContents( $( generatedContents ) ); if ( !staged || !this.generatedContentsInvalid ) { if ( !this.$element[ 0 ].parentNode ) { // this.$element hasn't been attached yet, so just overwrite it this.$element = $newElements; } else { // Switch out this.$element (which can contain multiple siblings) in place const lengthChange = this.$element.length !== $newElements.length; this.$element.first().replaceWith( $newElements ); this.$element.remove(); this.$element = $newElements; if ( lengthChange ) { // Changing the DOM node count can move the cursor, so re-apply // the cursor position from the model (T231094). setTimeout( () => { if ( this.getRoot() && this.getRoot().getSurface() ) { this.getRoot().getSurface().showModelSelection(); } } ); } } } else { this.generatedContentsValid = false; this.model.emit( 'generatedContentsError', $newElements ); } // Prevent tabbing to focusable elements inside the editable surface this.preventTabbingInside(); // Update focusable and resizable elements if necessary // TODO: Move these method definitions to their respective mixins. if ( this.$focusable ) { this.$focusable = this.getFocusableElement(); this.$bounding = this.getBoundingElement(); } if ( this.$resizable ) { this.$resizable = this.getResizableElement(); } this.initialize(); if ( this.live ) { this.emit( 'setup' ); } this.afterRender(); }; /** * Prevent tabbing to focusable elements inside the editable surface, because it conflicts with * allowing tabbing out of the surface. (The surface takes the focus back when it moves to an * element inside it.) * * In the future, this might be implemented using the `inert` property, currently not supported by * any browser: https://html.spec.whatwg.org/multipage/interaction.html#inert-subtrees * https://caniuse.com/mdn-api_htmlelement_inert * * @private */ ve.ce.GeneratedContentNode.prototype.preventTabbingInside = function () { // Like OO.ui.findFocusable(), but find *all* such nodes rather than the first one. const selector = 'input, select, textarea, button, object, a, area, [contenteditable], [tabindex]', $focusableCandidates = this.$element.find( selector ).addBack( selector ); $focusableCandidates.each( ( i, element ) => { const $element = $( element ); if ( OO.ui.isFocusableElement( $element ) ) { $element.attr( 'tabindex', -1 ); } } ); }; /** * Trigger rerender events after rendering the contents of the node. * * Nodes may override this method if the rerender event needs to be deferred (e.g. until images have loaded) * * @fires ve.ce.GeneratedContentNode#rerender */ ve.ce.GeneratedContentNode.prototype.afterRender = function () { this.emit( 'rerender' ); }; /** * Check whether the response HTML contains an error. * * The default implementation always returns true. * * @param {jQuery} $element The generated element * @return {boolean} There is no error */ ve.ce.GeneratedContentNode.prototype.validateGeneratedContents = function () { return true; }; /** * Update the contents of this node based on the model and config data. If this combination of * model and config data has been rendered before, the cached rendering in the store will be used. * * @param {Object} [config] Optional additional data to pass to generateContents() * @param {boolean} [staged] Update happened in staging mode */ ve.ce.GeneratedContentNode.prototype.update = function ( config, staged ) { const store = this.model.doc.getStore(), contents = store.value( store.hashOfValue( null, OO.getHash( [ this.model.getHashObjectForRendering(), config ] ) ) ); if ( contents ) { this.render( contents, staged ); } else { this.forceUpdate( config, staged ); } }; /** * Force the contents to be updated. Like update(), but bypasses the store. * * @param {Object} [config] Optional additional data to pass to generateContents() * @param {boolean} [staged] Update happened in staging mode */ ve.ce.GeneratedContentNode.prototype.forceUpdate = function ( config, staged ) { if ( this.generatingPromise ) { // Abort the currently pending generation process if possible this.abortGenerating(); } else { // Only call startGenerating if we weren't generating before this.startGenerating(); } // Create a new promise const promise = this.generatingPromise = this.generateContents( config ); promise // If this promise is no longer the currently pending one, ignore it completely .done( ( generatedContents ) => { if ( this.generatingPromise === promise ) { this.doneGenerating( generatedContents, config, staged ); } } ) .fail( () => { if ( this.generatingPromise === promise ) { this.failGenerating(); } } ); }; /** * Called when the node starts generating new content. * * This function is only called when the node wasn't already generating content. If a second update * comes in, this function will only be called if the first update has already finished (i.e. * doneGenerating or failGenerating has already been called). */ ve.ce.GeneratedContentNode.prototype.startGenerating = function () { this.$element.addClass( 've-ce-generatedContentNode-generating' ); }; /** * Abort the currently pending generation, if any, and remove the generating CSS class. * * This invokes .abort() on the pending promise if the promise has that method. It also ensures * that if the promise does get resolved or rejected later, this is ignored. */ ve.ce.GeneratedContentNode.prototype.abortGenerating = function () { const promise = this.generatingPromise; if ( promise ) { // Unset this.generatingPromise first so that if the promise is resolved or rejected // from within .abort(), this is ignored as it should be this.generatingPromise = null; if ( typeof promise.abort === 'function' ) { promise.abort(); } } this.$element.removeClass( 've-ce-generatedContentNode-generating' ); }; /** * Called when the node successfully finishes generating new content. * * @param {Object|string|Array} generatedContents Generated contents * @param {Object} [config] Config object passed to forceUpdate() * @param {boolean} [staged] Update happened in staging mode */ ve.ce.GeneratedContentNode.prototype.doneGenerating = function ( generatedContents, config, staged ) { this.$element.removeClass( 've-ce-generatedContentNode-generating' ); this.generatingPromise = null; // Because doneGenerating is invoked asynchronously, the model node may have become detached // in the meantime. Handle this gracefully. if ( this.model && this.model.doc ) { const store = this.model.doc.getStore(); const hash = OO.getHash( [ this.model.getHashObjectForRendering(), config ] ); store.hash( generatedContents, hash ); this.render( generatedContents, staged ); } }; /** * Called when the GeneratedContentNode has failed to generate new content. */ ve.ce.GeneratedContentNode.prototype.failGenerating = function () { this.$element.removeClass( 've-ce-generatedContentNode-generating' ); this.generatingPromise = null; }; /** * Check whether this GeneratedContentNode is currently generating new content. * * @return {boolean} Whether we're generating */ ve.ce.GeneratedContentNode.prototype.isGenerating = function () { return !!this.generatingPromise; }; /** * Get the focusable element * * @return {jQuery} Focusable element */ ve.ce.GeneratedContentNode.prototype.getFocusableElement = function () { return this.$element; }; /** * Get the bounding element * * @return {jQuery} Bounding element */ ve.ce.GeneratedContentNode.prototype.getBoundingElement = function () { return this.$element; }; /** * Get the resizable element * * @return {jQuery} Resizable element */ ve.ce.GeneratedContentNode.prototype.getResizableElement = function () { return this.$element; }; |