META-INF.resources.primefaces.messages.messages.js Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of primefaces Show documentation

There is a newer version: 15.0.0-RC1

/**
 * __PrimeFaces Messages Widget__
 * 
 * Messages is a pre-skinned extended version of the standard JSF messages component.
 * 
 * @prop {JQuery} closer The DOM element for the icon that closes this panel.
 * @interface {PrimeFaces.widget.MessagesCfg} cfg The configuration for the {@link  Messages| Messages widget}.
 * You can access this configuration via {@link PrimeFaces.widget.BaseWidget.cfg|BaseWidget.cfg}. Please note that this
 * configuration is usually meant to be read-only and should not be modified.
 * @extends {PrimeFaces.widget.BaseWidgetCfg} cfg
 */
PrimeFaces.widget.Messages = PrimeFaces.widget.BaseWidget.extend({

    /**
     * @override
     * @inheritdoc
     * @param {PrimeFaces.PartialWidgetCfg} cfg
     */
    init: function(cfg) {
        this._super(cfg);
        this.closer = $('.ui-messages-close');
        PrimeFaces.skinCloseAction(this.closer);
    },

    /**
     * Creates the HTML elements for the given faces message, and adds it to the DOM.
     * @param {PrimeFaces.FacesMessage} msg A message to translate into an HTML element.
     */
    appendMessage: function(msg) {
        var closeLabel = this.getAriaLabel('close');

        var severityContainer =  this.jq.children('div.ui-messages-' + msg.severity);
        if (severityContainer.length === 0) {
            severityContainer = this.jq.append(
                 '' +
                    '' +
                        '' +
                    '' +
                    '' +
                    '' +

                    '' +
                '');
        }

        severityContainer.find('ul').append(
            '' +
                '' + (msg.summary ? msg.summary : '') + '' +
                '' + (msg.detail ? msg.detail : '') + '' +
            '');
    },

    /**
     * Clears all current messages from the DOM.
     */
    clearMessages: function() {
        this.jq.children().remove();
    },
});