comindware.ui/src/collections/behaviors/HighlightableBehavior.js

Comindware Core UI provides the basic components like editors, lists, dropdowns, popups that we so desperately need while creating Marionette-based single-page applications.

/**
 * Developer: Stepan Burguchev
 * Date: 7/23/2014
 * Copyright: 2009-2016 Comindware®
 *       All Rights Reserved
 * Published under the MIT license
 */


'use strict';

import 'lib';

/**
 * Конструктор Behavior никогда не вызывается явно. Описанные в объекте options свойства должны
 * быть переданы как свойства behavior (см. документацию Marionette).
 * @name HighlightableBehavior
 * @memberof module:core.collection.behaviors
 * @class Behavior требуется для подсветки текста в моделях коллекции. Стандартный сценарий использования:
 * текстовый поиск с подсветкой найденных фрагментах в элементах списка.
 * @constructor
 * */

const HighlightableBehavior = function() {
};

_.extend(HighlightableBehavior.prototype, /** @lends module:core.collection.behaviors.HighlightableBehavior.prototype */ {
    /**
     * Подсветить заданный текст во всех моделях.
     * @param {String} text Текст, который необходимо подсветить.
     * */
    highlight(text) {
        this.parentCollection.each(record => {
            if (record.highlight) {
                record.highlight(text);
            }
        });
    },

    /**
     * Снять подсветку во всех моделях.
     * */
    unhighlight() {
        this.parentCollection.each(record => {
            if (record.unhighlight) {
                record.unhighlight();
            }
        });
    }
});

export default HighlightableBehavior;