wikimedia/mediawiki-extensions-VisualEditor

View on GitHub
modules/ve-mw/ce/nodes/ve.ce.MWInlineImageNode.js

Summary

Maintainability
A
2 hrs
Test Coverage
/*!
 * VisualEditor ContentEditable MWInlineImageNode class.
 *
 * @copyright See AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */

/**
 * ContentEditable MediaWiki image node.
 *
 * @class
 * @extends ve.ce.LeafNode
 * @mixes ve.ce.MWImageNode
 *
 * @constructor
 * @param {ve.dm.MWInlineImageNode} model Model to observe
 * @param {Object} [config] Configuration options
 */
ve.ce.MWInlineImageNode = function VeCeMWInlineImageNode( model, config ) {
    let $image;
    let hasHref = false;

    if ( model.getAttribute( 'isError' ) ) {
        this.$element = $( '<a>' )
            .addClass( 'new' )
            .append(
                $( '<span>' )
                    .addClass( 'mw-file-element mw-broken-media' )
                    .text( model.getAttribute( 'errorText' ) )
            );
        $image = $( [] );
    } else {
        $image = $( '<img>' ).addClass( 'mw-file-element' );
        if ( model.getAttribute( 'href' ) ) {
            hasHref = true;
            this.$element = $( '<a>' ).addClass( 'mw-file-description' );
            $image.appendTo( this.$element );
        } else {
            this.$element = $image;
        }
    }

    // Parent constructor
    // this.$element has already been created and styled, so pass through as config.$element
    // The constructor will add more classes to this.$element, such as ve-ce-leafNode
    ve.ce.MWInlineImageNode.super.call( this, model, ve.extendObject( {}, config, { $element: this.$element } ) );

    // Mixin constructors
    ve.ce.MWImageNode.call( this, this.$element, $image );

    $image
        .attr( 'src', this.getResolvedAttribute( 'src' ) )
        .attr( 'width', this.model.getAttribute( 'width' ) )
        .attr( 'height', this.model.getAttribute( 'height' ) );

    if ( hasHref ) {
        // T322704
        ve.setAttributeSafe( this.$element[ 0 ], 'href', this.getResolvedAttribute( 'href' ) || '', '#' );
    }

    this.showHandles( [ this.$element.css( 'direction' ) === 'rtl' ? 'sw' : 'se' ] );

    this.updateClasses();

    // DOM changes
    this.$element.addClass( 've-ce-mwInlineImageNode' );
};

/* Inheritance */

OO.inheritClass( ve.ce.MWInlineImageNode, ve.ce.LeafNode );

// Need to mixin base class as well (T92540)
OO.mixinClass( ve.ce.MWInlineImageNode, ve.ce.GeneratedContentNode );

OO.mixinClass( ve.ce.MWInlineImageNode, ve.ce.MWImageNode );

/* Static Properties */

ve.ce.MWInlineImageNode.static.name = 'mwInlineImage';

/* Methods */

/**
 * Update CSS classes based on current attributes
 */
ve.ce.MWInlineImageNode.prototype.updateClasses = function () {
    const valign = this.model.getAttribute( 'valign' );

    // Border
    this.$element.toggleClass( 'mw-image-border', !!this.model.getAttribute( 'borderImage' ) );

    // default size
    this.$element.toggleClass( 'mw-default-size', !!this.model.getAttribute( 'defaultSize' ) );

    // valign
    if ( valign !== 'default' ) {
        this.$image.css( 'vertical-align', valign );
    }
};

/**
 * @inheritdoc
 */
ve.ce.MWInlineImageNode.prototype.onAttributeChange = function ( key, from, to ) {
    // Mixin method
    ve.ce.MWImageNode.prototype.onAttributeChange.apply( this, arguments );

    if ( key === 'height' || key === 'width' ) {
        to = parseInt( to, 10 );
    }

    if ( from !== to ) {
        switch ( key ) {
            // TODO: 'align', 'src', 'valign', 'border'
            case 'width':
                this.$image.css( 'width', to );
                break;
            case 'height':
                this.$image.css( 'height', to );
                break;
            case 'mediaType':
                this.updateMediaType();
                break;
        }
        this.updateClasses();
    }
};

/* Registration */

ve.ce.nodeFactory.register( ve.ce.MWInlineImageNode );