utils.js 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /**
  6. * @module image/utils
  7. */
  8. import { widgetize, isWidget } from './widget/utils';
  9. import ModelElement from '@ckeditor/ckeditor5-engine/src/model/element';
  10. const imageSymbol = Symbol( 'isImage' );
  11. /**
  12. * Converts given {@link module:engine/view/element~Element} to image widget:
  13. * * adds {@link module:engine/view/element~Element#setCustomProperty custom property} allowing to recognize image widget element,
  14. * * calls {@link module:image/widget/utils~widgetize widgetize}.
  15. *
  16. * @param {module:engine/view/element~Element} viewElement
  17. * @returns {module:engine/view/element~Element}
  18. */
  19. export function toImageWidget( viewElement ) {
  20. viewElement.setCustomProperty( imageSymbol, true );
  21. return widgetize( viewElement );
  22. }
  23. /**
  24. * Checks if given view element is an image widget.
  25. *
  26. * @param {module:engine/view/element~Element} viewElement
  27. * @returns {Boolean}
  28. */
  29. export function isImageWidget( viewElement ) {
  30. return !!viewElement.getCustomProperty( imageSymbol ) && isWidget( viewElement );
  31. }
  32. /**
  33. * Checks if provided modelElement is an instance of {@link module:engine/model/element~Element Element} and its name
  34. * is `image`.
  35. *
  36. * @param {module:engine/model/element~Element} modelElement
  37. * @returns {Boolean}
  38. */
  39. export function isImage( modelElement ) {
  40. return modelElement instanceof ModelElement && modelElement.name == 'image';
  41. }