forked from romanych/ko.editables
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ko.editables.js
262 lines (217 loc) · 6.5 KB
/
ko.editables.js
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
// ko.editables v0.9 for KnockoutJS
// https://github.com/romanych/ko.editables/
// http://romanych.github.com/ko.editables/
// editable extender and ko.editable plugin for viewModels
// (c) Roman Gomolko - rgomolko@gmail.com
// License: MIT (http://www.opensource.org/licenses/mit-license.php)
/*
Exports:
ko.extenders.editable: ko.observable().extend({editable: true|false});
ko.editable: ko.editable(objectWithObservables, boolean autoInit);
Editable adds following methods into observables and objects:
- beginEdit()
- commit()
- rollback()
- hasChanges() - observable
*/
(function (ko, undefined) {
var deferredDependentObservable = function (readFunction) {
return ko.dependentObservable({ read: readFunction, deferEvaluation: true });
};
var defaultScope = '';
var editableObservables = {
_observables: {},
add: function (scope, observable) {
if (!this._observables.hasOwnProperty(scope)) {
this._observables[scope] = ko.observableArray();
}
this._observables[scope].push(observable);
},
get: function (scope) {
scope = scope === undefined ? defaultScope : scope;
if (!this._observables.hasOwnProperty(scope)) {
throw new Error('Unknown scope ' + scope);
}
return ko.utils.unwrapObservable(this._observables[scope]);
}
};
editableObservables._observables[defaultScope] = ko.observableArray();
function newScope() {
return '_scope' + (++newScope.counter);
}
newScope.counter = 0;
var comparers = {
'scalar': function (actualValue, originalValue) {
return actualValue == originalValue;
},
'array': function (actualValue, originalValue) {
actualValue = actualValue || [];
originalValue = originalValue || [];
if (actualValue.length != originalValue.length) {
return false;
}
for (var i = 0; i < actualValue.length; i++) {
if (actualValue[i] !== originalValue[i]) {
return false;
}
}
return true;
}
};
var defaultParams = {
enable: true,
scope: defaultScope
};
ko.extenders['editable'] = function (target, params) {
// Protect from double initialization
if (target.hasOwnProperty('editable')) {
return target;
}
if (typeof params != 'object') {
params = {
enable: params === undefined ? true : params,
scope: defaultScope
};
} else {
params = ko.utils.extend(ko.utils.extend({}, defaultParams), params);
}
target.editable = params.enable;
if (!target.editable) {
return target;
}
var oldValue;
var equalityComparer = comparers['scalar'];
var inTransaction = target.inTransaction = ko.observable(false);
target.beginEdit = function () {
if (inTransaction()) {
return;
}
var currentValue = target();
if (currentValue instanceof Array) {
currentValue = currentValue.slice(); // make copy
equalityComparer = comparers['array'];
}
oldValue = currentValue;
inTransaction(true);
};
target.commit = function () {
inTransaction(false);
};
target.rollback = function () {
if (inTransaction()) {
target(oldValue);
inTransaction(false);
}
};
target.oldValue = function () {
return oldValue;
};
target.hasChanges = deferredDependentObservable(function () {
var hasChanges = inTransaction() && !equalityComparer(target(), oldValue);
return hasChanges;
});
if (params.scope !== false) {
editableObservables.add(params.scope, target);
}
return target;
};
function makeEditable(rootObject, scope, editables, processedObjects) {
processedObjects = processedObjects || [];
for (var propertyName in rootObject) {
var propertyValue = rootObject[propertyName];
if (ko.isWriteableObservable(propertyValue)) {
if (propertyValue.editable !== false) {
propertyValue.extend({ editable: { enable: true, scope: scope} });
// Allow to skip observables extended with { editable: false } arguments
editables.push(propertyValue);
}
}
if (ko.utils.arrayIndexOf(processedObjects, propertyValue) > -1) {
continue;
}
processedObjects.push(propertyValue);
var underlyingPropertyValue = ko.utils.unwrapObservable(propertyValue);
if (typeof (underlyingPropertyValue) == 'object') {
var isObservable = ko.isObservable(propertyValue);
if (isObservable) {
if (ko.utils.arrayIndexOf(processedObjects, underlyingPropertyValue) > -1) {
continue;
}
processedObjects.push(underlyingPropertyValue);
}
makeEditable(underlyingPropertyValue, scope, editables, processedObjects);
}
}
};
ko.editable = function (viewModel, autoInit) {
if (typeof (viewModel.beginEdit) == 'function') {
return;
}
autoInit = autoInit === undefined ? true : autoInit;
var allEditables = ko.observableArray();
viewModel.beginEdit = function () {
ko.utils.arrayForEach(allEditables(), function (obj) {
obj.beginEdit();
});
};
viewModel.commit = function () {
ko.utils.arrayForEach(allEditables(), function (obj) {
obj.commit();
});
};
viewModel.rollback = function () {
ko.utils.arrayForEach(allEditables(), function (obj) {
obj.rollback();
});
};
viewModel.hasChanges = deferredDependentObservable(function () {
var editableWithChanges = ko.utils.arrayFirst(allEditables(), function (editable) {
return editable.hasChanges();
});
return editableWithChanges != null;
});
var scope = newScope();
viewModel.addEditable = function (obj) {
makeEditable(obj, scope, allEditables, []);
};
if (autoInit) {
makeEditable(viewModel, scope, allEditables, []);
}
};
ko.editable.enable = function (object, scope) {
if (scope === undefined) {
scope = defaultScope;
}
makeEditable(object, scope, []);
};
ko.editable.beginEdit = function (scope) {
ko.utils.arrayForEach(editableObservables.get(scope), function (observable) {
observable.beginEdit();
});
};
ko.editable.commit = function (scope) {
ko.utils.arrayForEach(editableObservables.get(scope), function (observable) {
observable.commit();
});
};
ko.editable.rollback = function (scope) {
ko.utils.arrayForEach(editableObservables.get(scope), function (observable) {
observable.rollback();
});
};
ko.editable.hasChanges = function (scope) {
var observables = editableObservables.get(scope);
for (var i = 0, l = observables.length; i < l; i++) {
if (observables[i].hasChanges()) {
return true;
}
}
return false;
};
ko.editable._editables = editableObservables;
ko.editable.getHasChangesFlag = function (scope) {
return deferredDependentObservable(function () {
return ko.editable.hasChanges(scope);
}).extend({ throttle: 100 });
};
})(ko);