utils.js 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /**
  6. * @module image/widget/utils
  7. */
  8. const widgetSymbol = Symbol( 'isWidget' );
  9. const labelSymbol = Symbol( 'label' );
  10. /**
  11. * CSS class added to each widget element.
  12. *
  13. * @const {String}
  14. */
  15. export const WIDGET_CLASS_NAME = 'ck-widget';
  16. /**
  17. * CSS class added to currently selected widget element.
  18. *
  19. * @const {String}
  20. */
  21. export const WIDGET_SELECTED_CLASS_NAME = 'ck-widget_selected';
  22. /**
  23. * Returns `true` if given {@link module:engine/view/element~Element} is a widget.
  24. *
  25. * @param {module:engine/view/element~Element} element
  26. * @returns {Boolean}
  27. */
  28. export function isWidget( element ) {
  29. return !!element.getCustomProperty( widgetSymbol );
  30. }
  31. /**
  32. * "Widgetizes" given {@link module:engine/view/element~Element}:
  33. * * sets `contenteditable` attribute to `true`,
  34. * * adds custom `getFillerOffset` method returning `null`,
  35. * * adds `ck-widget` CSS class,
  36. * * adds custom property allowing to recognize widget elements by using {@link ~isWidget}.
  37. *
  38. * @param {module:engine/view/element~Element} element
  39. * @param {Object} [options]
  40. * @param {String|Function} [options.label] Element's label provided to {@link ~setLabel} function. It can be passed as
  41. * a plain string or a function returning a string.
  42. * @returns {module:engine/view/element~Element} Returns same element.
  43. */
  44. export function widgetize( element, options ) {
  45. options = options || {};
  46. element.setAttribute( 'contenteditable', false );
  47. element.getFillerOffset = getFillerOffset;
  48. element.addClass( WIDGET_CLASS_NAME );
  49. element.setCustomProperty( widgetSymbol, true );
  50. if ( options.label ) {
  51. setLabel( element, options.label );
  52. }
  53. return element;
  54. }
  55. /**
  56. * Sets label for given element.
  57. * It can be passed as a plain string or a function returning a string. Function will be called each time label is retrieved by
  58. * {@link ~getLabel}.
  59. *
  60. * @param {module:engine/view/element~Element} element
  61. * @param {String|Function} labelOrCreator
  62. */
  63. export function setLabel( element, labelOrCreator ) {
  64. element.setCustomProperty( labelSymbol, labelOrCreator );
  65. }
  66. /**
  67. * Returns label for provided element.
  68. *
  69. * @param {module:engine/view/element~Element} element
  70. * @return {String}
  71. */
  72. export function getLabel( element ) {
  73. const labelCreator = element.getCustomProperty( labelSymbol );
  74. if ( !labelCreator ) {
  75. return '';
  76. }
  77. return typeof labelCreator == 'function' ? labelCreator() : labelCreator;
  78. }
  79. // Default filler offset function applied to all widget elements.
  80. //
  81. // @returns {null}
  82. function getFillerOffset() {
  83. return null;
  84. }