utils.js 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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 { createNestedEditable } from '../widget/utils';
  10. const captionSymbol = Symbol( 'imageCaption' );
  11. /**
  12. * Returns a function that creates caption editable element for the given {@link module:engine/view/document~Document}.
  13. *
  14. * @param {module:engine/view/document~Document} viewDocument
  15. * @return {Function}
  16. */
  17. export function captionElementCreator( viewDocument ) {
  18. return () => {
  19. const editable = createNestedEditable( 'figcaption', viewDocument );
  20. editable.setCustomProperty( captionSymbol, true );
  21. return editable;
  22. };
  23. }
  24. /**
  25. * Returns `true` if given view element is image's caption editable.
  26. *
  27. * @param {module:engine/view/element~Element} viewElement
  28. * @return {Boolean}
  29. */
  30. export function isCaption( viewElement ) {
  31. return !!viewElement.getCustomProperty( captionSymbol );
  32. }
  33. /**
  34. * Returns caption model element from given image element. Returns `null` if no caption is found.
  35. *
  36. * @param {module:engine/model/element~Element} imageModelElement
  37. * @return {module:engine/model/element~Element|null}
  38. */
  39. export function getCaptionFromImage( imageModelElement ) {
  40. for ( let node of imageModelElement.getChildren() ) {
  41. if ( node instanceof ModelElement && node.name == 'caption' ) {
  42. return node;
  43. }
  44. }
  45. return null;
  46. }
  47. /**
  48. * {@link module:engine/view/matcher~Matcher} pattern. Checks if given element is `figcaption` element and is placed
  49. * inside image `figure` element.
  50. *
  51. * @param {module:engine/view/element~Element} element
  52. * @returns {Object|null} Returns object accepted by {@link module:engine/view/matcher~Matcher} or `null` if element
  53. * cannot be matched.
  54. */
  55. export function matchImageCaption( element ) {
  56. const parent = element.parent;
  57. // Convert only captions for images.
  58. if ( element.name == 'figcaption' && parent && parent.name == 'figure' && parent.hasClass( 'image' ) ) {
  59. return { name: true };
  60. }
  61. return null;
  62. }