JsonEncoder
Mixin

Implements data encoding functional that should be mixed to a AbstractCrudManager sub-class. Uses JSON as an encoding system.

// create a new CrudManager using AJAX as a transport system and JSON for encoding
class MyCrudManager extends JsonEncode(AjaxTransport(AbstractCrudManager)) {}

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class

encoder : Object

Configuration of the JSON encoder used by the Crud Manager.

requestData : Object

Static data to send with the data request.

new CrudManager({
    // add static "foo" property to all requests data
    encoder : {
        requestData : {
            foo : 'Bar'
        }
    },
    ...
});

The above snippet will result adding "foo" property to all requests data:

    {
        "requestId"   : 756,
        "type"        : "load",

        "foo"         : "Bar",

        "stores"      : [
            ...

Properties

Properties are getters/setters or publicly accessible variables on this class

isJsonEncoder : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of JsonEncoder class, or subclass thereof.

isJsonEncoder : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of JsonEncoder class, or subclass thereof.

Functions

Functions are methods available for calling on the class

decode( responseText )
: Object

Decodes (parses) a JSON response string to an object. If parsing fails, it returns null. Supposed to be overridden in case data provided by server has to be transformed into format requested by the Crud Manager.
encode( requestData )
: String

Encodes a request object to JSON encoded string. If encoding fails (due to circular structure), it returns null. Supposed to be overridden in case data provided by the Crud Manager has to be transformed into format requested by server.

Source path

Scheduler/crud/encoder/JsonEncoder.js

Inheritance tree1

JsonEncoder

JsonEncoder Mixin