normalizer.jsdoc 1.1 KB

12345678910111213141516171819202122232425262728293031323334
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /**
  6. * @module paste-from-office/normalizer
  7. */
  8. /**
  9. * Interface defining a content transformation pasted from an external editor.
  10. *
  11. * Normalizers are registered by the {@link module:paste-from-office/pastefromoffice~PasteFromOffice} plugin and run on
  12. * {@link module:clipboard/clipboard~Clipboard#event:inputTransformation inputTransformation event}. They detect environment-specific
  13. * quirks and transform it into a form compatible with other CKEditor features.
  14. *
  15. * @interface Normalizer
  16. */
  17. /**
  18. * Must return `true` if the `htmlString` contains content which this normalizer can transform.
  19. *
  20. * @method #isActive
  21. * @param {String} htmlString full content of `dataTransfer.getData( 'text/html' )`
  22. * @returns {Boolean}
  23. */
  24. /**
  25. * Executes the normalization of a given data.
  26. *
  27. * @method #execute
  28. * @param {Object} data object obtained from
  29. * {@link module:clipboard/clipboard~Clipboard#event:inputTransformation inputTransformation event}.
  30. */