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
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
/**
* JQuery UI Widget declaration: 'mage.rowBuilder'
*
* @api
*/
define([
'jquery',
'mage/template',
'jquery/ui'
], function ($, mageTemplate) {
'use strict';
$.widget('mage.rowBuilder', {
/**
* options with default values for setting up the template
*/
options: {
//Default template options
rowTemplate: '#template-registrant',
rowContainer: '#registrant-container',
//Row index used by the template rows.
rowIndex: 0,
//Row count: Should not be set externally
rowCount: 0,
rowParentElem: '<li></li>',
rowContainerClass: 'fields',
addRowBtn: '#add-registrant-button',
btnRemoveIdPrefix: 'btn-remove',
btnRemoveSelector: '.btn-remove',
rowIdPrefix: 'row',
//This class is added to rows added after the first one. Adds the dotted separator
additionalRowClass: 'add-row',
/*
This is provided during widget instantiation. eg :
formDataPost : {"formData":formData,"templateFields":['field1-name','field2-name'] }
-"formData" is the multi-dimensional array of form field values : [['a','b'],['c','b']]
received from the server and encoded
-"templateFields" are the input fields in the template with index suffixed after the field name
eg field1-name{index}
*/
formDataPost: null,
//Default selectors for add element of a template
addEventSelector: 'button',
//Default selectors for remove markup elements of a template
remEventSelector: 'a',
//This option allows adding first row delete option and a row separator
hideFirstRowAddSeparator: true,
//Max rows - This option should be set when instantiating the widget
maxRows: 1000,
maxRowsMsg: '#max-registrant-message'
},
/**
* Initialize create
* @private
*/
_create: function () {
this.rowTemplate = mageTemplate(this.options.rowTemplate);
this.options.rowCount = this.options.rowIndex = 0;
//On document ready related tasks
$($.proxy(this.ready, this));
//Binding template-wide events handlers for adding and removing rows
this.element.on(
'click',
this.options.addEventSelector + this.options.addRowBtn,
$.proxy(this.handleAdd, this)
);
this.element.on(
'click',
this.options.remEventSelector + this.options.btnRemoveSelector,
$.proxy(this.handleRemove, this)
);
},
/**
* Initialize template
* @public
*/
ready: function () {
if (this.options.formDataPost &&
this.options.formDataPost.formData &&
this.options.formDataPost.formData.length
) {
this.processFormDataArr(this.options.formDataPost);
} else if (this.options.rowIndex === 0 && this.options.maxRows !== 0) {
//If no form data , then add default row
this.addRow(0);
}
},
/**
* Process and loop through all row data to create preselected values. This is used for any error on submit.
* For complex implementations the inheriting widget can override this behavior
* @public
* @param {Object} formDataArr
*/
processFormDataArr: function (formDataArr) {
var formData = formDataArr.formData,
templateFields = formDataArr.templateFields,
formRow,
i, j;
for (i = this.options.rowIndex = 0; i < formData.length; this.options.rowIndex = i++) {
this.addRow(i);
formRow = formData[i];
for (j = 0; j < formRow.length; j++) {
this.setFieldById(templateFields[j] + i, formRow[j]);
}
}
},
/**
* Initialize and create markup for template row. Add it to the parent container.
* The template processing will substitute row index at all places marked with _index_ in the template
* using the template
* @public
* @param {Number} index - current index/count of the created template. This will be used as the id
* @return {*}
*/
addRow: function (index) {
var row = $(this.options.rowParentElem),
tmpl;
row.addClass(this.options.rowContainerClass).attr('id', this.options.rowIdPrefix + index);
tmpl = this.rowTemplate({
data: {
_index_: index
}
});
$(tmpl).appendTo(row);
$(this.options.rowContainer).append(row).trigger('contentUpdated');
row.addClass(this.options.additionalRowClass);
//Remove 'delete' link and additionalRowClass for first row
if (this.options.rowIndex === 0 && this.options.hideFirstRowAddSeparator) {
$('#' + this._esc(this.options.btnRemoveIdPrefix) + '0').remove();
$('#' + this._esc(this.options.rowIdPrefix) + '0').removeClass(this.options.additionalRowClass);
}
this.maxRowCheck(++this.options.rowCount);
return row;
},
/**
* Remove return item information row
* @public
* @param {*} rowIndex - return item information row index
* @return {Boolean}
*/
removeRow: function (rowIndex) {
$('#' + this._esc(this.options.rowIdPrefix) + rowIndex).remove();
this.maxRowCheck(--this.options.rowCount);
return false;
},
/**
* Function to check if maximum rows are exceeded and render/hide maxMsg and Add btn
* @public
* @param {Number} rowIndex
*/
maxRowCheck: function (rowIndex) {
var addRowBtn = $(this.options.addRowBtn),
maxRowMsg = $(this.options.maxRowsMsg);
//liIndex starts from 0
if (rowIndex >= this.options.maxRows) {
addRowBtn.hide();
maxRowMsg.show();
} else if (addRowBtn.is(':hidden')) {
addRowBtn.show();
maxRowMsg.hide();
}
},
/**
* Set the value on given element
* @public
* @param {String} domId
* @param {String} value
*/
setFieldById: function (domId, value) {
var x = $('#' + this._esc(domId));
if (x.length) {
if (x.is(':checkbox')) {
x.attr('checked', true);
} else if (x.is('option')) {
x.attr('selected', 'selected');
} else {
x.val(value);
}
}
},
/**
* Delegated handler for adding a row
* @public
* @return {Boolean}
*/
handleAdd: function () {
this.addRow(++this.options.rowIndex);
return false;
},
/**
* Delegated handler for removing a selected row
* @public
* @param {Object} e - Native event object
* @return {Boolean}
*/
handleRemove: function (e) {
this.removeRow($(e.currentTarget).closest('[id^="' + this.options.btnRemoveIdPrefix + '"]')
.attr('id').replace(this.options.btnRemoveIdPrefix, ''));
return false;
},
/**
* Utility function to add escape chars for jquery selector strings
* @private
* @param {String} str - String to be processed
* @return {String}
*/
_esc: function (str) {
return str ? str.replace(/([ ;&,.+*~\':"!\^$\[\]()=>|\/@])/g, '\\$1') : str;
}
});
return $.mage.rowBuilder;
});