liza/src/ui/styler/NaFieldStyler.js

/**
 * N/A field styler
 *
 *  Copyright (C) 2010-2019 R-T Specialty, LLC.
 *
 *  This file is part of liza.
 *
 *  liza is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

var Class       = require( 'easejs' ).Class,
    FieldStyler = require( './FieldStyler' );


/**
 * Style fields that are not applicable (and so do not need to collect data
 * from the user)
 *
 * @todo Detaching should be done by DomField
 */
module.exports = Class( 'NaFieldStyler' )
    .extend( FieldStyler,
{
    /**
     * Retrieve unique identifier
     *
     * @return {string} unique identifier
     */
    'public getId': function()
    {
        return 'na';
    },


    /**
     * Determines whether the field has been styled
     *
     * Having this predicate on the styler rather than the field ensures
     * that, even if the two somehow get out of sync (or styles are applied
     * elsewhere), application/revocation will function sanely.
     *
     * @param {DomField}            field   field to style
     * @param {HTMLElement}         element DOM element to style
     *
     * @return {boolean} whether FIELD has been styled by this styler
     */
    'public isApplied': function( field, element )
    {
        return /\bhidden\b/.test( element.className );
    },


    /**
     * Apply style to field
     *
     * @param {DomField}            field   field to style
     * @param {HTMLElement}         element DOM element to style
     * @param {Array.<HTMLElement>} row     DOM elements of containing row
     *
     * @return {FieldStyler} self
     */
    'public applyStyle': function( field, element, row )
    {

        if ( this.isSubField( field ) )
        {
            this.hideField( element, [] );
            field.getParent().removeChild( element );

            // this is a child of another field; don't consider it a
            // containing row, since we don't want our operations affecting
            // it
            return;
        }

        this.hideField( element, row );
    },


    /**
     * Remove style from field
     *
     * @param {DomField}            field   field to unstyle
     * @param {HTMLElement}         element DOM element to unstyle
     * @param {Array.<HTMLElement>} row     DOM elements of containing row
     *
     * @return {FieldStyler} self
     */
    'public revokeStyle': function( field, element, row )
    {
        if ( this.isSubField( field ) )
        {
            this.showField( element, [] );
            field.getParent().appendChild( element );

            return;
        }

        this.showField( element, row );
    },


    /**
     * Determine whether element ELEMENT represents a sub-field
     *
     * A sub-field is a field within a field; the distinction is important
     * because we probably don't want operations on a sub-field affecting
     * its parent.
     *
     * @todo: move somewhere else (Field perhaps?)
     *
     * @param {HTMLElement} element DOM element associated with field
     *
     * @return {boolean} whether ELEMENT represents a sub-field
     */
    'protected isSubField': function( field )
    {
        var parent = field.getParent();

        // ES3-compatible (don't use classList)
        return !!( parent && /\bwidget\b/.test( parent.className ) );
    },


    'virtual protected hideField': function( element, row )
    {
        this.addClass( element, 'hidden' );

        // This is a workaround from the old days where jQuery would add
        // styles to hide elements, which we wanted to override; this can be
        // removed once jQuery is eradicated from the framework.
        //
        // setAttribute is intentional!  IE<9 doesn't support element.style
        // as an lvalue.
        element.setAttribute( 'style', '' );

        for ( var i in row )
        {
            this.addClass( row[ i ], 'hidden' );
            row[ i ].setAttribute( 'style', '' );
        }
    },


    'virtual protected showField': function( element, row )
    {
        this.removeClass( element, 'hidden' );
        this.removeClass( row, 'hidden' );
    }
} );