all files / montage/core/meta/ event-descriptor.js

23.08% Statements 6/26
8.33% Branches 1/12
16.67% Functions 2/12
23.08% Lines 6/26
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168                                                                                                                                                                                                                                                                                                                                    
var Montage = require("../core").Montage,
    logger = require("../logger").logger("objectDescriptor"),
    deprecate = require("../deprecate"),
    Defaults = {
        name: "default",
        detailKeys: [],
        detailValueTypes: [],
        helpKey: ""
    };
 
/**
 * @class EventDescriptor
 */
exports.EventDescriptor = Montage.specialize( /** @lends EventDescriptor# */ {
 
    constructor: {
        value: function EventDescriptor() {
            this._detailKeys = [];
        }
    },
 
    /**
     * Initialize a newly allocated event descriptor.
     * @function
     * @param {string} name name of the event descriptor to create
     * @param {ObjectDescriptor} objectDescriptor
     * @returns itself
     */
    initWithNameAndObjectDescriptor: {
        value:function (name, objectDescriptor) {
            this._name = (name !== null ? name : Defaults.name);
            this._owner = objectDescriptor;
            return this;
        }
    },
 
    /**
     * Initialize a newly allocated event descriptor.
     * @deprecated
     * @function
     * @param {string} name name of the event descriptor to create
     * @param {ObjectDescriptor} objectDescriptor
     * @returns itself
     */
    initWithNameAndBlueprint: {
        value: deprecate.deprecateMethod(void 0, function (name, blueprint) {
            return this.initWithNameAndObjectDescriptor(name, blueprint);
        }, "new EventBlueprint().initWithNameAndBlueprint", "new EventDescriptor().initWithNameAndObjectDescriptor")
    },
 
    serializeSelf: {
        value:function (serializer) {
            serializer.setProperty("name", this.name);
            serializer.setProperty("objectDescriptor", this._owner, "reference");
            if (this.detailKeys.length > 0) {
                this._setPropertyWithDefaults(serializer, "detailKeys", this.detailKeys);
            }
            this._setPropertyWithDefaults(serializer, "helpKey", this.helpKey);
        }
    },
 
    deserializeSelf: {
        value:function (deserializer) {
            this._name = deserializer.getProperty("name");
            this._owner = deserializer.getProperty("objectDescriptor") || deserializer.getProperty("blueprint");
            this.detailKeys = this._getPropertyWithDefaults(deserializer, "detailKeys");
            this.helpKey = this._getPropertyWithDefaults(deserializer, "helpKey");
        }
    },
 
    _setPropertyWithDefaults: {
        value:function (serializer, propertyName, value) {
            if (value != Defaults[propertyName]) {
                serializer.setProperty(propertyName, value);
            }
        }
    },
 
    _getPropertyWithDefaults: {
        value:function (deserializer, propertyName) {
            var value = deserializer.getProperty(propertyName);
            return value ? value : Defaults[propertyName];
        }
    },
 
    _owner: {
        value:null
    },
 
    /**
     * Component description attached to this event descriptor.
     * @type {Component}
     */
    owner: {
        get:function () {
            return this._owner;
        }
    },
 
    _name: {
        value:null
    },
 
    /**
     * Name of the object. The name is used to define the property on the
     * object.
     * @readonly
     * @type {string}
     */
    name: {
        serializable:false,
        get:function () {
            return this._name;
        }
    },
 
    /**
     * The identifier is the name of the event descriptor, dot, the name of the event
     * descriptor, and is used to make the serialization of property descriptors
     * more readable.
     * @type {string}
     * @default `this.name`
     */
    identifier: {
        get:function () {
            return [
                this.owner.identifier,
                this.name
            ].join("_");
        }
    },
 
    _detailKeys: {
        value:null
    },
 
    /**
     * List of key for the details dictionary
     * @type {Array.<string>}
     * @default []
     */
    detailKeys: {
        get:function () {
            return this._detailKeys;
        },
        set:function (value) {
            if (Array.isArray(value)) {
                this._detailKeys = value;
            }
        }
    },
 
    helpKey: {
        value: Defaults["helpKey"]
    },
 
    objectDescriptorModuleId: require("../core")._objectDescriptorModuleIdDescriptor,
    objectDescriptor: require("../core")._objectDescriptorDescriptor,
 
    /******************************************************************************
     * Deprecated Methods
     */
 
    blueprintModuleId: require("../core")._blueprintModuleIdDescriptor,
    blueprint: require("../core")._blueprintDescriptor
 
});