8
0

utils.js 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /**
  6. * @module image/imagecaption/utils
  7. */
  8. import ModelElement from '@ckeditor/ckeditor5-engine/src/model/element';
  9. import ViewEditableElement from '@ckeditor/ckeditor5-engine/src/view/editableelement';
  10. import { attachPlaceholder } from '@ckeditor/ckeditor5-engine/src/view/placeholder';
  11. import { toWidgetEditable } from '../widget/utils';
  12. const captionSymbol = Symbol( 'imageCaption' );
  13. /**
  14. * Returns a function that creates caption editable element for the given {@link module:engine/view/document~Document}.
  15. *
  16. * @param {module:engine/view/document~Document} viewDocument
  17. * @param {String} placeholderText Text to be displayed when caption is empty.
  18. * @return {Function}
  19. */
  20. export function captionElementCreator( viewDocument, placeholderText ) {
  21. return () => {
  22. const editable = new ViewEditableElement( 'figcaption' );
  23. editable.document = viewDocument;
  24. editable.setCustomProperty( captionSymbol, true );
  25. attachPlaceholder( editable, placeholderText );
  26. return toWidgetEditable( editable );
  27. };
  28. }
  29. /**
  30. * Returns `true` if given view element is image's caption editable.
  31. *
  32. * @param {module:engine/view/element~Element} viewElement
  33. * @return {Boolean}
  34. */
  35. export function isCaption( viewElement ) {
  36. return !!viewElement.getCustomProperty( captionSymbol );
  37. }
  38. /**
  39. * Returns caption model element from given image element. Returns `null` if no caption is found.
  40. *
  41. * @param {module:engine/model/element~Element} imageModelElement
  42. * @return {module:engine/model/element~Element|null}
  43. */
  44. export function getCaptionFromImage( imageModelElement ) {
  45. for ( let node of imageModelElement.getChildren() ) {
  46. if ( node instanceof ModelElement && node.name == 'caption' ) {
  47. return node;
  48. }
  49. }
  50. return null;
  51. }
  52. /**
  53. * {@link module:engine/view/matcher~Matcher} pattern. Checks if given element is `figcaption` element and is placed
  54. * inside image `figure` element.
  55. *
  56. * @param {module:engine/view/element~Element} element
  57. * @returns {Object|null} Returns object accepted by {@link module:engine/view/matcher~Matcher} or `null` if element
  58. * cannot be matched.
  59. */
  60. export function matchImageCaption( element ) {
  61. const parent = element.parent;
  62. // Convert only captions for images.
  63. if ( element.name == 'figcaption' && parent && parent.name == 'figure' && parent.hasClass( 'image' ) ) {
  64. return { name: true };
  65. }
  66. return null;
  67. }