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 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 | 1x 178x 178x 178x 178x 178x 178x 178x 178x 178x 178x 178x 178x 178x 178x 58x 178x 178x 178x 1x 1x 1x 1x 1x 58x 101x 101x 101x 101x 101x 58x 58x 101x 58x 58x 58x 40x 58x 58x 49x 49x 49x 48x 1x 1x 1x 1x 58x 48x 48x 58x 1x 49x 1x 49x 1x 153x 153x 153x 11x 153x 153x 44x 153x 153x 61x 61x 153x 153x 1x 61x 61x 61x 61x 61x 1x 80x 7x 73x 46x 46x 46x 46x 46x 27x 1x 46x 46x 46x 1x 48x 1x 48x 48x 1x 126x 126x 126x 126x 126x 126x 126x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 23x 1x 91x 91x 91x 91x 55x 55x 55x 55x 55x 36x 36x 36x 36x 1x 55x 55x 55x 55x 55x 55x 55x 1x 1x 163x 109x 54x 54x 54x 54x 54x 1x 153x 2x 2x 1x 58x 58x 58x 58x 58x 58x 1x 58x 58x 58x 58x 49x 49x 1x 2x 2x 1x 11x 11x 11x 1x 9x 9x 8x 9x 1x 58x 61x 58x 47x 33x 33x 58x 1x | /*!
* VisualEditor ContentEditable FocusableNode class.
*
* @copyright See AUTHORS.txt
*/
/**
* ContentEditable focusable node.
*
* Focusable elements have a special treatment by ve.ce.Surface. When the user selects only a single
* node, if it is focusable, the surface will set the focusable node's focused state. Other systems,
* such as the context, may also use a focusable node's $focusable property as a hint of where the
* primary element in the node is. Typically, and by default, the primary element is the root
* element, but in some cases it may need to be configured to be a specific child element within the
* node's DOM rendering.
*
* If your focusable node changes size and the highlight must be redrawn, call redrawHighlights().
* 'resizeEnd' and 'rerender' are already bound to call this.
*
* @class
* @abstract
*
* @constructor
* @param {jQuery} [$focusable=this.$element] Primary element user is focusing on
* @param {Object} [config] Configuration options
* @param {jQuery} [config.$bounding=$focusable] Element to consider for bounding box calculations (e.g.
* attaching inspectors)
* @param {string[]} [config.classes] CSS classes to be added to the highlight container
*/
ve.ce.FocusableNode = function VeCeFocusableNode( $focusable, config ) {
config = config || {};
// Properties
this.focused = false;
this.highlighted = false;
this.isFocusableSetup = false;
this.$highlights = $( '<div>' ).addClass( 've-ce-focusableNode-highlights' )
// Allow the highlight to take focus, so that focus is not removed from
// the surface when clicking on it (T341681)
.attr( 'tabIndex', 0 );
this.$focusable = $focusable || this.$element;
this.$bounding = config.$bounding || this.$focusable;
this.focusableSurface = null;
this.rects = null;
this.boundingRect = null;
this.startAndEndRects = null;
this.icon = null;
this.touchMoved = false;
if ( Array.isArray( config.classes ) ) {
// eslint-disable-next-line mediawiki/class-doc
this.$highlights.addClass( config.classes );
}
// Use a debounced handler as some actions can trigger redrawHighlights
// twice in quick succession resizeEnd+rerender
this.redrawHighlightsDebounced = ve.debounce( this.redrawHighlights.bind( this ), 100 );
// DOM changes
this.$element
.addClass( 've-ce-focusableNode' )
.prop( 'contentEditable', 'false' );
// Events
this.connect( this, {
setup: 'onFocusableSetup',
teardown: 'onFocusableTeardown',
resizeStart: 'onFocusableResizeStart',
resizeEnd: 'onFocusableResizeEnd',
rerender: 'onFocusableRerender'
} );
};
/* Inheritance */
OO.initClass( ve.ce.FocusableNode );
/* Events */
/**
* @event ve.ce.FocusableNode#focus
*/
/**
* @event ve.ce.FocusableNode#blur
*/
/* Static properties */
/**
* Icon to use when the rendering is considered not visible, as defined in #hasRendering
*
* No icon is show if null.
*
* @static
* @property {string|null}
* @inheritable
*/
ve.ce.FocusableNode.static.iconWhenInvisible = null;
/**
* Command to execute when Enter is pressed while this node is focused, or when the node is double-clicked.
*
* @static
* @property {string|null}
* @inheritable
*/
ve.ce.FocusableNode.static.primaryCommandName = null;
/**
* Command to execute when Delete or Backspace is pressed while this node is focused.
*
* @static
* @property {string|null}
* @inheritable
*/
ve.ce.FocusableNode.static.deleteCommandName = null;
/* Static methods */
/**
* Get rects for an element
*
* @param {jQuery} $element Element to get highlights
* @param {Object} [relativeRect] Rect with top & left to get position relative to
* @return {Object} Object containing rects and boundingRect
*/
ve.ce.FocusableNode.static.getRectsForElement = function ( $element, relativeRect ) {
let $set;
let rects = [];
function process( el ) {
Iif ( el.classList.contains( 've-ce-noHighlight' ) ) {
return;
}
const $el = $( el );
// Don't descend if overflow is anything but visible as this prevents child
// elements appearing beyond the bounding box of the parent, *unless* display
// is inline, in which case the overflow setting will be ignored
const overflow = $el.css( 'overflow' );
Iif ( overflow && overflow !== 'visible' && $el.css( 'display' ) !== 'inline' ) {
$set = $set.not( $el.find( '*' ) );
}
ve.batchPush( rects, el.getClientRects() );
}
$set = $element.find( '*' ).addBack();
// Calling process() may change $set.length
for ( let i = 0; i < $set.length; i++ ) {
process( $set[ i ] );
}
rects = ve.minimizeRects( rects );
// Elements with a width/height of 0 return a clientRect with a width/height of 1
// As elements with an actual width/height of 1 aren't that useful anyway, just
// throw away anything that is <=1
const filteredRects = rects.filter( ( rect ) => rect.width > 1 && rect.height > 1 );
// But if this filtering doesn't leave any rects at all, then we do want to use the 1px rects
if ( filteredRects.length > 0 ) {
rects = filteredRects;
}
let boundingRect = null;
for ( let i = 0, l = rects.length; i < l; i++ ) {
// Translate to relative
Eif ( relativeRect ) {
rects[ i ] = ve.translateRect( rects[ i ], -relativeRect.left, -relativeRect.top );
}
if ( !boundingRect ) {
boundingRect = ve.copy( rects[ i ] );
} else {
boundingRect.top = Math.min( boundingRect.top, rects[ i ].top );
boundingRect.left = Math.min( boundingRect.left, rects[ i ].left );
boundingRect.bottom = Math.max( boundingRect.bottom, rects[ i ].bottom );
boundingRect.right = Math.max( boundingRect.right, rects[ i ].right );
}
}
if ( boundingRect ) {
boundingRect.width = boundingRect.right - boundingRect.left;
boundingRect.height = boundingRect.bottom - boundingRect.top;
}
return {
rects: rects,
boundingRect: boundingRect
};
};
/* Methods */
/**
* Create a highlight element.
*
* @return {jQuery} A highlight element
*/
ve.ce.FocusableNode.prototype.createHighlight = function () {
// eslint-disable-next-line mediawiki/class-doc
return $( '<div>' )
.addClass( [ 've-ce-focusableNode-highlight', ...this.getExtraHighlightClasses() ] )
.prop( {
title: this.constructor.static.getDescription( this.model ),
draggable: true
} )
.on( {
dragstart: this.onFocusableDragStart.bind( this ),
dragend: this.onFocusableDragEnd.bind( this )
} );
};
/**
* Array of CSS classes to add to highlights
*
* @return {string[]}
*/
ve.ce.FocusableNode.prototype.getExtraHighlightClasses = function () {
return this.generatedContentsInvalid ? [ 've-ce-focusableNode-highlight-error' ] : [];
};
/**
* Handle node setup.
*/
ve.ce.FocusableNode.prototype.onFocusableSetup = function () {
// Exit if already setup or not attached
Iif ( this.isFocusableSetup || !this.root ) {
return;
}
this.focusableSurface = this.root.getSurface();
// DOM changes (duplicated from constructor in case this.$element is replaced)
// eslint-disable-next-line no-jquery/no-class-state
if ( !this.$element.hasClass( 've-ce-focusableNode' ) ) {
// Optimization: If this.$element has the correct class assume it has already
// been setup in the construct and avoid expensive DOM property manipulation
this.$element
.addClass( 've-ce-focusableNode' )
.prop( 'contentEditable', 'false' );
}
// Events
this.$focusable.on( {
'mouseenter.ve-ce-focusableNode': this.onFocusableMouseEnter.bind( this ),
'touchstart.ve-ce-focusableNode': this.onFocusableTouchStart.bind( this ),
'touchmove.ve-ce-focusableNode': this.onFocusableTouchMove.bind( this ),
'mousedown.ve-ce-focusableNode touchend.ve-ce-focusableNode': this.onFocusableMouseDown.bind( this )
} );
// $element is ce=false so make sure nothing happens when you click
// on it, just in case the browser decides to do something.
// If $element == $focusable then this can be skipped as $focusable already
// handles mousedown events.
if ( !this.$element.is( this.$focusable ) ) {
this.$element.on( {
'mousedown.ve-ce-focusableNode': function ( e ) {
if ( !ve.isContentEditable( e.target ) ) {
e.preventDefault();
}
}
} );
}
// Note that preventing default on mousedown doesn't suppress click
// events, so link navigation would still occur:
this.$element.on( {
'click.ve-ce-focusableNode': function ( e ) {
if ( !ve.isContentEditable( e.target ) && e.which === OO.ui.MouseButtons.LEFT ) {
e.preventDefault();
}
}
} );
if ( this.constructor.static.iconWhenInvisible ) {
// Set up the invisible icon, and watch for its continued necessity if
// unloaded images which don't specify their width or height are
// involved.
this.$element
.find( 'img:not([width]),img:not([height])' )
.addBack( 'img:not([width]),img:not([height])' )
.on( 'load', this.updateInvisibleIcon.bind( this ) );
this.updateInvisibleIcon();
}
// A node may be re-setup when focused. redrawHighlights will only do
// something if the node is currently focused.
this.redrawHighlightsDebounced();
this.isFocusableSetup = true;
};
/**
* Update the state of icon if this node is invisible
*
* If the node doesn't have a visible rendering, we insert an icon to represent
* it. If the icon was already present, and this is called again when rendering
* has developed, we remove the icon.
*/
ve.ce.FocusableNode.prototype.updateInvisibleIcon = function () {
Iif ( !this.constructor.static.iconWhenInvisible ) {
return;
}
// Make sure any existing icon is detached before measuring
Iif ( this.icon ) {
this.icon.$element.detach();
}
const showIcon = !this.hasRendering();
// Defer updating the DOM. If we don't do this, the hasRendering() call for the next
// FocusableNode will force a reflow, which is slow.
requestAnimationFrame( () => {
this.updateInvisibleIconSync( showIcon );
} );
};
/**
* Synchronous part of #updateInvisibleIconSync
*
* @param {boolean} showIcon Show the icon
* @private
*/
ve.ce.FocusableNode.prototype.updateInvisibleIconSync = function ( showIcon ) {
if ( !this.getModel() ) {
// Check the node hasn't been destroyed, as this method is called after a requestAnimationFrame
return;
}
if ( showIcon ) {
// Don't try to append to void tags, or unrendered tags
const voidAndHiddenTypes = [ 'style', 'script', ...ve.elementTypes.void ];
const $firstElement = this.$element.not( voidAndHiddenTypes.join( ',' ) ).first();
this.createInvisibleIcon();
Iif (
// Not needed if node is not attached (e.g. if used in the converter)
document.body.contains( $firstElement[ 0 ] ) &&
// eslint-disable-next-line no-jquery/no-sizzle
!$firstElement.is( ':visible' )
) {
// The first element to which we want to attach our icon is invisible.
// In this case make sure it *is* visible, so the button is visible,
// but remove the contents, so we don't start showing them (T305110).
$firstElement.empty().css( 'display', 'inline-block' );
}
$firstElement
.addClass( 've-ce-focusableNode-invisible' )
.prepend( this.icon.$element );
} else Iif ( this.icon ) {
this.$element.removeClass( 've-ce-focusableNode-invisible' );
this.icon.$element.detach();
}
};
/**
* Create a element to show if the node is invisible
*/
ve.ce.FocusableNode.prototype.createInvisibleIcon = function () {
Iif ( this.icon ) {
return;
}
this.icon = new OO.ui.ButtonWidget( {
classes: [ 've-ce-focusableNode-invisibleIcon' ],
framed: false,
// Make button unfocusable, T198912
tabIndex: null,
icon: this.constructor.static.iconWhenInvisible
} );
this.updateInvisibleIconLabel();
};
/**
* Get a label for the invisible icon
*
* Defaults to #getDescription
*
* @return {jQuery|string|OO.ui.HtmlSnippet|Function|null} Invisible icon label
*/
ve.ce.FocusableNode.prototype.getInvisibleIconLabel = function () {
return this.model ? this.constructor.static.getDescription( this.model ) : '';
};
/**
* Update the invisible icon's label
*/
ve.ce.FocusableNode.prototype.updateInvisibleIconLabel = function () {
Eif ( this.icon ) {
this.icon.setLabel( this.getInvisibleIconLabel() || null );
}
};
/**
* Handle node teardown.
*/
ve.ce.FocusableNode.prototype.onFocusableTeardown = function () {
// Exit if not setup or not attached
Iif ( !this.isFocusableSetup || !this.root ) {
return;
}
// Events
this.$focusable.off( '.ve-ce-focusableNode' );
this.$element.off( '.ve-ce-focusableNode' );
// Highlights
this.clearHighlights();
// DOM changes
this.$element
.removeClass( 've-ce-focusableNode' )
.removeProp( 'contentEditable' );
this.focusableSurface = null;
this.isFocusableSetup = false;
};
/**
* Handle highlight mouse down events.
*
* @param {jQuery.Event} e Mouse down event
*/
ve.ce.FocusableNode.prototype.onFocusableMouseDown = function ( e ) {
if ( e.type === 'touchend' && this.touchMoved ) {
return;
}
if ( this.isInContentEditableDisabled() ) {
return;
}
const surfaceModel = this.focusableSurface.getModel(),
selection = surfaceModel.getSelection(),
nodeRange = this.model.getOuterRange();
if ( e.which === OO.ui.MouseButtons.RIGHT ) {
// The same technique is used in ve.ce.TableNode:
// Make ce=true so we get cut/paste options in the context menu
this.$highlights.prop( 'contentEditable', 'true' );
// Select the clicked element so we get a copy option in the context menu
ve.selectElement( this.$highlights[ 0 ] );
setTimeout( () => {
// Undo ce=true as soon as the context menu is shown
this.$highlights.prop( 'contentEditable', 'false' );
this.focusableSurface.prepareClipboardHandlerForCopy();
} );
}
// Wait for native selection to change before correcting
setTimeout( () => {
// Check surface still exists after timeout
if ( this.focusableSurface ) {
const range = selection instanceof ve.dm.LinearSelection && selection.getRange();
surfaceModel.getLinearFragment(
e.shiftKey && range ?
ve.Range.static.newCoveringRange(
[ range, nodeRange ], range.from > nodeRange.from
) :
nodeRange
).select();
this.focusableSurface.updateActiveAnnotations();
// Ensure surface is active as native 'focus' event won't be fired
this.focusableSurface.activate();
}
} );
};
/**
* Handle highlight double click events.
*
* @param {jQuery.Event} e Double click event
*/
ve.ce.FocusableNode.prototype.onFocusableDblClick = function () {
if ( this.isInContentEditableDisabled() ) {
return;
}
if ( this.getModel().isEditable() ) {
this.executeCommand();
}
};
/**
* Execute the command associated with this node.
*/
ve.ce.FocusableNode.prototype.executeCommand = function () {
Iif ( !this.model.isInspectable() ) {
return;
}
const surface = this.focusableSurface.getSurface();
const command = surface.commandRegistry.getCommandForNode( this );
Iif ( command ) {
command.execute( surface );
}
};
/**
* Handle element drag start.
*
* @param {jQuery.Event} e Drag start event
*/
ve.ce.FocusableNode.prototype.onFocusableDragStart = function ( e ) {
if ( this.focusableSurface ) {
// Pass event up to the surface
this.focusableSurface.$element.trigger( e );
}
};
/**
* Handle element drag end.
*
* If a relocation actually takes place the node is destroyed before this events fires.
*
* @param {jQuery.Event} e Drag end event
*/
ve.ce.FocusableNode.prototype.onFocusableDragEnd = function ( e ) {
// endRelocation is usually triggered by onDocumentDrop in the surface, but if it isn't
// trigger it here instead
if ( this.focusableSurface ) {
this.focusableSurface.$element.trigger( e );
}
};
/**
* Handle mouse enter events.
*
* @param {jQuery.Event} e Mouse enter event
*/
ve.ce.FocusableNode.prototype.onFocusableMouseEnter = function () {
if ( !this.root.getSurface().dragging && !this.root.getSurface().resizing && !this.isInContentEditableDisabled() ) {
this.createHighlights();
}
};
/**
* Handle touch start events.
*
* @param {jQuery.Event} e Touch start event
*/
ve.ce.FocusableNode.prototype.onFocusableTouchStart = function () {
this.touchMoved = false;
};
/**
* Handle touch move events.
*
* @param {jQuery.Event} e Touch move event
*/
ve.ce.FocusableNode.prototype.onFocusableTouchMove = function () {
this.touchMoved = true;
};
/**
* Handle surface mouse move events.
*
* @param {jQuery.Event} e Mouse move event
*/
ve.ce.FocusableNode.prototype.onSurfaceMouseMove = function ( e ) {
const $target = $( e.target );
if (
// eslint-disable-next-line no-jquery/no-class-state
!$target.hasClass( 've-ce-focusableNode-highlight' ) &&
!OO.ui.contains( this.$focusable.toArray(), $target[ 0 ], true )
) {
this.clearHighlights();
}
};
/**
* Handle surface mouse leave events.
*
* @param {jQuery.Event} e Mouse leave event
*/
ve.ce.FocusableNode.prototype.onSurfaceMouseLeave = function ( e ) {
if ( e.relatedTarget === null ) {
this.clearHighlights();
}
};
/**
* Handle resize start events.
*/
ve.ce.FocusableNode.prototype.onFocusableResizeStart = function () {
this.clearHighlights();
};
/**
* Handle resize end event.
*/
ve.ce.FocusableNode.prototype.onFocusableResizeEnd = function () {
this.redrawHighlightsDebounced();
};
/**
* Handle rerender event.
*/
ve.ce.FocusableNode.prototype.onFocusableRerender = function () {
if ( this.focused && this.focusableSurface ) {
this.redrawHighlightsDebounced();
// Reposition menu
this.focusableSurface.getSurface().getContext().updateDimensions( true );
}
};
/**
* Check if node is focused.
*
* @return {boolean} Node is focused
*/
ve.ce.FocusableNode.prototype.isFocused = function () {
return this.focused;
};
/**
* Set the selected state of the node.
*
* @param {boolean} value Node is focused
* @fires ve.ce.FocusableNode#focus
* @fires ve.ce.FocusableNode#blur
*/
ve.ce.FocusableNode.prototype.setFocused = function ( value ) {
value = !!value;
Eif ( this.focused !== value ) {
this.focused = value;
if ( this.focused ) {
this.emit( 'focus' );
this.$element.addClass( 've-ce-focusableNode-focused' );
this.createHighlights();
// this.focused may have changed, so re-attach in the correct container
this.focusableSurface.appendHighlights( this.$highlights, this.focused );
this.focusableSurface.$element.off( '.ve-ce-focusableNode' );
} else {
this.emit( 'blur' );
this.$element.removeClass( 've-ce-focusableNode-focused' );
this.$highlights.removeClass( 've-ce-focusableNode-highlights-deactivated' );
this.clearHighlights();
}
}
};
/**
* Creates highlights.
*/
ve.ce.FocusableNode.prototype.createHighlights = function () {
Iif ( this.highlighted ) {
return;
}
this.$highlights.on( {
mousedown: this.onFocusableMouseDown.bind( this ),
dblclick: this.onFocusableDblClick.bind( this )
} );
this.highlighted = true;
this.positionHighlights();
this.focusableSurface.appendHighlights( this.$highlights, this.focused );
this.focusableSurface.connect( this, {
position: 'positionHighlights',
activation: 'onSurfaceActivation'
} );
// Events
Iif ( !this.focused ) {
this.focusableSurface.$element.on( {
'mousemove.ve-ce-focusableNode': this.onSurfaceMouseMove.bind( this ),
'mouseleave.ve-ce-focusableNode': this.onSurfaceMouseLeave.bind( this )
} );
}
};
/**
* Handle activation events from the surface
*/
ve.ce.FocusableNode.prototype.onSurfaceActivation = function () {
this.$highlights.toggleClass( 've-ce-focusableNode-highlights-deactivated', !!this.focusableSurface.isShownAsDeactivated() );
};
/**
* Clears highlight.
*/
ve.ce.FocusableNode.prototype.clearHighlights = function () {
if ( !this.highlighted ) {
return;
}
this.$highlights.remove().empty();
this.focusableSurface.$element.off( '.ve-ce-focusableNode' );
this.focusableSurface.disconnect( this );
this.highlighted = false;
this.boundingRect = null;
};
/**
* Redraws highlight.
*/
ve.ce.FocusableNode.prototype.redrawHighlights = function () {
if ( this.focused && this.focusableSurface ) {
// setFocused will call clearHighlights/createHighlights
// and also re-bind events.
this.setFocused( false );
this.setFocused( true );
}
};
/**
* Re-calculate position of highlights
*/
ve.ce.FocusableNode.prototype.calculateHighlights = function () {
// Protect against calling before/after surface setup/teardown
Iif ( !this.focusableSurface ) {
this.rects = [];
this.boundingRect = null;
this.startAndEndRects = null;
return;
}
const surfaceOffset = this.focusableSurface.getSurface().getBoundingClientRect();
const allRects = this.constructor.static.getRectsForElement( this.$focusable, surfaceOffset );
this.rects = allRects.rects;
this.boundingRect = allRects.boundingRect;
// startAndEndRects is lazily evaluated in getStartAndEndRects from rects
this.startAndEndRects = null;
};
/**
* Positions highlights, and remove collapsed ones
*/
ve.ce.FocusableNode.prototype.positionHighlights = function () {
Iif ( !this.highlighted ) {
return;
}
this.calculateHighlights();
this.$highlights.empty()
// Append something selectable for right-click copy
.append( $( '<span>' ).addClass( 've-ce-focusableNode-highlight-selectable' ).text( '\u00a0' ) );
for ( let i = 0, l = this.rects.length; i < l; i++ ) {
const $highlight = this.createHighlight();
this.$highlights.append(
$highlight.css( {
top: this.rects[ i ].top,
left: this.rects[ i ].left,
width: this.rects[ i ].width,
height: this.rects[ i ].height
} )
);
}
};
/**
* Get list of rectangles outlining the shape of the node relative to the surface
*
* @return {Object[]} List of rectangle objects
*/
ve.ce.FocusableNode.prototype.getRects = function () {
Iif ( !this.highlighted ) {
this.calculateHighlights();
}
return this.rects;
};
/**
* Get the bounding rectangle of the focusable node highlight relative to the surface
*
* @return {Object|null} Top, left, bottom & right positions of the focusable node relative to the surface
*/
ve.ce.FocusableNode.prototype.getBoundingRect = function () {
Iif ( !this.$bounding.is( this.$focusable ) ) {
const surfaceOffset = this.focusableSurface.getSurface().getBoundingClientRect();
const allRects = this.constructor.static.getRectsForElement( this.$bounding, surfaceOffset );
return allRects.boundingRect;
}
Iif ( !this.highlighted ) {
this.calculateHighlights();
}
return this.boundingRect;
};
/**
* Get start and end rectangles of an inline focusable node relative to the surface
*
* @return {Object.<string,Object>|null} Start and end rectangles
*/
ve.ce.FocusableNode.prototype.getStartAndEndRects = function () {
Iif ( !this.highlighted ) {
this.calculateHighlights();
}
if ( !this.startAndEndRects ) {
this.startAndEndRects = ve.getStartAndEndRects( this.rects );
}
return this.startAndEndRects;
};
/**
* Check if the rendering is visible
*
* "Visible", in this case, is defined as at least 10px × 4px
* or 4px × 10px in dimensions (T307527)
*
* @return {boolean} The node has a visible rendering
*/
ve.ce.FocusableNode.prototype.hasRendering = function () {
let visible = false;
function checkSize( width, height ) {
return ( width >= 10 && height >= 4 ) ||
( height >= 10 && width >= 4 );
}
this.$element.each( ( i, element ) => {
if (
checkSize( element.offsetWidth, element.offsetHeight ) ||
// Check width/height attribute as well. (T125767)
checkSize( element.width, element.height )
) {
visible = true;
return false;
}
} );
return visible;
};
/**
* Check if the node is inside a ve.ce.ContentEditableNode with editing disabled
*
* Ignore nodes which just disable CE in the DOM manually (e.g. TableNode)
* as focusables should still be highlightable in these.
*
* @return {boolean} Editing disabled
*/
ve.ce.FocusableNode.prototype.isInContentEditableDisabled = function () {
return !!this.traverseUpstream( ( node ) => !(
node.isContentEditable && !node.isContentEditable()
) );
};
|