converters.js 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /**
  6. * @module image/converters
  7. */
  8. import ModelElement from '@ckeditor/ckeditor5-engine/src/model/element';
  9. import { isImageWidget } from './utils';
  10. /**
  11. * Returns function that converts image view representation:
  12. *
  13. * <figure class="image"><img src="..." alt="..."></img></figure>
  14. *
  15. * to model representation:
  16. *
  17. * <image src="..." alt="..."></image>
  18. *
  19. * @returns {Function}
  20. */
  21. export function viewToModelImage() {
  22. return ( evt, data, consumable, conversionApi ) => {
  23. const viewFigureElement = data.input;
  24. // *** Step 1: Validate conversion.
  25. // Check if figure element can be consumed.
  26. if ( !consumable.test( viewFigureElement, { name: true, class: 'image' } ) ) {
  27. return;
  28. }
  29. // Check if image element can be converted in current context.
  30. if ( !conversionApi.schema.check( { name: 'image', inside: data.context, attributes: 'src' } ) ) {
  31. return;
  32. }
  33. // Check if img element is placed inside figure element and can be consumed with `src` attribute.
  34. const viewImg = viewFigureElement.getChild( 0 );
  35. if ( !viewImg || viewImg.name != 'img' || !consumable.test( viewImg, { name: true, attribute: 'src' } ) ) {
  36. return;
  37. }
  38. // *** Step2: Convert to model.
  39. consumable.consume( viewFigureElement, { name: true, class: 'image' } );
  40. consumable.consume( viewImg, { name: true, attribute: 'src' } );
  41. // Create model element.
  42. const modelImage = new ModelElement( 'image', {
  43. src: viewImg.getAttribute( 'src' )
  44. } );
  45. // Convert `alt` attribute if present.
  46. if ( consumable.consume( viewImg, { attribute: [ 'alt' ] } ) ) {
  47. modelImage.setAttribute( 'alt', viewImg.getAttribute( 'alt' ) );
  48. }
  49. data.output = modelImage;
  50. };
  51. }
  52. /**
  53. * Returns model to view selection converter. This converter is applied after default selection conversion is made.
  54. * It creates fake view selection when {@link module:engine/view/selection~Selection#getSelectedElement} returns instance
  55. * of image widget.
  56. *
  57. * @param {Function} t {@link module:utils/locale~Locale#t Locale#t function} used to translate default fake selection's label.
  58. * @returns {Function}
  59. */
  60. export function modelToViewSelection( t ) {
  61. return ( evt, data, consumable, conversionApi ) => {
  62. const viewSelection = conversionApi.viewSelection;
  63. const selectedElement = viewSelection.getSelectedElement();
  64. if ( !selectedElement || !isImageWidget( selectedElement ) ) {
  65. return;
  66. }
  67. let fakeSelectionLabel = t( 'image widget' );
  68. const imgElement = selectedElement.getChild( 0 );
  69. const altText = imgElement.getAttribute( 'alt' );
  70. if ( altText ) {
  71. fakeSelectionLabel = `${ altText } ${ fakeSelectionLabel }`;
  72. }
  73. viewSelection.setFake( true, { label: fakeSelectionLabel } );
  74. };
  75. }
  76. /**
  77. * Creates image attribute converter for provided model conversion dispatchers.
  78. *
  79. * @param {Array.<module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher>} dispatchers
  80. * @param {String} attributeName
  81. */
  82. export function createImageAttributeConverter( dispatchers, attributeName ) {
  83. for ( let dispatcher of dispatchers ) {
  84. dispatcher.on( `addAttribute:${ attributeName }:image`, modelToViewAttributeConverter );
  85. dispatcher.on( `changeAttribute:${ attributeName }:image`, modelToViewAttributeConverter );
  86. dispatcher.on( `removeAttribute:${ attributeName }:image`, modelToViewAttributeConverter );
  87. }
  88. }
  89. // Model to view image converter converting given attribute, and adding it to `img` element nested inside `figure` element.
  90. //
  91. // @private
  92. function modelToViewAttributeConverter( evt, data, consumable, conversionApi ) {
  93. const parts = evt.name.split( ':' );
  94. const consumableType = parts[ 0 ] + ':' + parts[ 1 ];
  95. if ( !consumable.consume( data.item, consumableType ) ) {
  96. return;
  97. }
  98. const figure = conversionApi.mapper.toViewElement( data.item );
  99. const img = figure.getChild( 0 );
  100. if ( parts[ 0 ] == 'removeAttribute' ) {
  101. img.removeAttribute( data.attributeKey );
  102. } else {
  103. img.setAttribute( data.attributeKey, data.attributeNewValue );
  104. }
  105. }