HuasoFoundries / backgrid_es6

/*

  backgrid

  http://github.com/wyuenho/backgrid

  Copyright (c) 2013 Jimmy Yuen Ho Wong and contributors

  Licensed under the MIT license.

*/

/**

   Just a convenient class for interested parties to subclass.

   The default Cell classes don't require the formatter to be a subclass of

   Formatter as long as the fromRaw(rawData) and toRaw(formattedData) methods

   are defined.

   @abstract

   @class Backgrid.CellFormatter

   @constructor

*/

var CellFormatter = function () {};

_.extend(CellFormatter.prototype, {

  /**

     Takes a raw value from a model and returns an optionally formatted string

     for display. The default implementation simply returns the supplied value

     as is without any type conversion.

     @member Backgrid.CellFormatter

     @param {*} rawData

     @param {Backbone.Model} model Used for more complicated formatting

     @return {*}

  */

    return rawData;

  },

  /**

     Takes a formatted string, usually from user input, and returns a

     appropriately typed value for persistence in the model.

     If the user input is invalid or unable to be converted to a raw value

     suitable for persistence in the model, toRaw must return `undefined`.

     @member Backgrid.CellFormatter

     @param {string} formattedData

     @param {Backbone.Model} model Used for more complicated formatting

     @return {*|undefined}

  */

    return formattedData;

  }

});

export {

  CellFormatter

};