-
Notifications
You must be signed in to change notification settings - Fork 29
/
Copy pathcola.util.html
170 lines (170 loc) · 44.3 KB
/
cola.util.html
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
<!DOCTYPE html><html><head><title>cola.util</title><meta charset="utf-8"><meta name="viewport" content="user-scalable=no, width=device-width, initial-scale=1, maximum-scale=1"><link rel="stylesheet" type="text/css" href="./resources/css.css"><link rel="stylesheet" type="text/css" href="./resources/doc.css"></head><body class="v-box"><div class="ui inverted menu doc-header box"><div class="ui header item">Cola UI API-v1.0.9</div><div class="right menu"><a id="showSidebarBtn" class="item"><i class="content icon"></i></a></div></div><div class="flex-box"><div class="row doc-body"><div id="toc" class="medium-3 large-2 columns"><div class="ui icon input fluid inverted transparent"><input id="searchInput" type="text" placeholder="搜索..."><i class="search icon"></i></div><div class="ui list"><a href="./$.html" class="item data-item">$</a><a href="./cola.html" class="item data-item">cola</a><a href="./cola.AbstractButton.html" class="item data-item">cola.AbstractButton</a><a href="./cola.AbstractCheckbox.html" class="item data-item">cola.AbstractCheckbox</a><a href="./cola.AbstractContainer.html" class="item data-item">cola.AbstractContainer</a><a href="./cola.AbstractDropdown.html" class="item data-item">cola.AbstractDropdown</a><a href="./cola.AbstractEditor.html" class="item data-item">cola.AbstractEditor</a><a href="./cola.AbstractInput.html" class="item data-item">cola.AbstractInput</a><a href="./cola.AbstractItemGroup.html" class="item data-item">cola.AbstractItemGroup</a><a href="./cola.AbstractList.html" class="item data-item">cola.AbstractList</a><a href="./cola.AbstractMenuItem.html" class="item data-item">cola.AbstractMenuItem</a><a href="./cola.AbstractSlotList.html" class="item data-item">cola.AbstractSlotList</a><a href="./cola.AjaxValidator.html" class="item data-item">cola.AjaxValidator</a><a href="./cola.AsyncValidator.html" class="item data-item">cola.AsyncValidator</a><a href="./cola.Avatar.html" class="item data-item">cola.Avatar</a><a href="./cola.Breadcrumb.html" class="item data-item">cola.Breadcrumb</a><a href="./cola.Button.html" class="item data-item">cola.Button</a><a href="./cola.ButtonGroup.html" class="item data-item">cola.ButtonGroup</a><a href="./cola.Calendar.html" class="item data-item">cola.Calendar</a><a href="./cola.CardBook.html" class="item data-item">cola.CardBook</a><a href="./cola.Carousel.html" class="item data-item">cola.Carousel</a><a href="./cola.CascadeBind.html" class="item data-item">cola.CascadeBind</a><a href="./cola.Checkbox.html" class="item data-item">cola.Checkbox</a><a href="./cola.ControlMenuItem.html" class="item data-item">cola.ControlMenuItem</a><a href="./cola.Corner.html" class="item data-item">cola.Corner</a><a href="./cola.CustomDropdown.html" class="item data-item">cola.CustomDropdown</a><a href="./cola.CustomValidator.html" class="item data-item">cola.CustomValidator</a><a href="./cola.DataType.html" class="item data-item">cola.DataType</a><a href="./cola.DatePicker.html" class="item data-item">cola.DatePicker</a><a href="./cola.DateTimePicker.html" class="item data-item">cola.DateTimePicker</a><a href="./cola.Definition.html" class="item data-item">cola.Definition</a><a href="./cola.Dialog.html" class="item data-item">cola.Dialog</a><a href="./cola.Divider.html" class="item data-item">cola.Divider</a><a href="./cola.Dropdown.html" class="item data-item">cola.Dropdown</a><a href="./cola.DropdownMenuItem.html" class="item data-item">cola.DropdownMenuItem</a><a href="./cola.Element.html" class="item data-item">cola.Element</a><a href="./cola.EmailValidator.html" class="item data-item">cola.EmailValidator</a><a href="./cola.Entity.html" class="item data-item">cola.Entity</a><a href="./cola.EntityDataType.html" class="item data-item">cola.EntityDataType</a><a href="./cola.EntityList.html" class="item data-item">cola.EntityList</a><a href="./cola.FieldSet.html" class="item data-item">cola.FieldSet</a><a href="./cola.GroupBox.html" class="item data-item">cola.GroupBox</a><a href="./cola.HeaderMenuItem.html" class="item data-item">cola.HeaderMenuItem</a><a href="./cola.IFrame.html" class="item data-item">cola.IFrame</a><a href="./cola.Image.html" class="item data-item">cola.Image</a><a href="./cola.Input.html" class="item data-item">cola.Input</a><a href="./cola.ItemsView.html" class="item data-item">cola.ItemsView</a><a href="./cola.Label.html" class="item data-item">cola.Label</a><a href="./cola.Layer.html" class="item data-item">cola.Layer</a><a href="./cola.LengthValidator.html" class="item data-item">cola.LengthValidator</a><a href="./cola.Link.html" class="item data-item">cola.Link</a><a href="./cola.ListView.html" class="item data-item">cola.ListView</a><a href="./cola.Menu.html" class="item data-item">cola.Menu</a><a href="./cola.MenuButton.html" class="item data-item">cola.MenuButton</a><a href="./cola.MenuItem.html" class="item data-item">cola.MenuItem</a><a href="./cola.Model.html" class="item data-item">cola.Model</a><a href="./cola.MultiSlotPicker.html" class="item data-item">cola.MultiSlotPicker</a><a href="./cola.NestedList.html" class="item data-item">cola.NestedList</a><a href="./cola.NestedListBind.html" class="item data-item">cola.NestedListBind</a><a href="./cola.NestedListNode.html" class="item data-item">cola.NestedListNode</a><a href="./cola.Node.html" class="item data-item">cola.Node</a><a href="./cola.NotifyTipManager.html" class="item data-item">cola.NotifyTipManager</a><a href="./cola.NumberValidator.html" class="item data-item">cola.NumberValidator</a><a href="./cola.Pager.html" class="item data-item">cola.Pager</a><a href="./cola.Panel.html" class="item data-item">cola.Panel</a><a href="./cola.PointingLabel.html" class="item data-item">cola.PointingLabel</a><a href="./cola.Progress.html" class="item data-item">cola.Progress</a><a href="./cola.Property.html" class="item data-item">cola.Property</a><a href="./cola.Provider.html" class="item data-item">cola.Provider</a><a href="./cola.RadioButton.html" class="item data-item">cola.RadioButton</a><a href="./cola.RadioGroup.html" class="item data-item">cola.RadioGroup</a><a href="./cola.RangeSlotList.html" class="item data-item">cola.RangeSlotList</a><a href="./cola.Rating.html" class="item data-item">cola.Rating</a><a href="./cola.RegExpValidator.html" class="item data-item">cola.RegExpValidator</a><a href="./cola.RenderableElement.html" class="item data-item">cola.RenderableElement</a><a href="./cola.RequiredValidator.html" class="item data-item">cola.RequiredValidator</a><a href="./cola.Reveal.html" class="item data-item">cola.Reveal</a><a href="./cola.Ribbon.html" class="item data-item">cola.Ribbon</a><a href="./cola.Segment.html" class="item data-item">cola.Segment</a><a href="./cola.Select.html" class="item data-item">cola.Select</a><a href="./cola.Sidebar.html" class="item data-item">cola.Sidebar</a><a href="./cola.Slider.html" class="item data-item">cola.Slider</a><a href="./cola.SlotList.html" class="item data-item">cola.SlotList</a><a href="./cola.SplitPane.html" class="item data-item">cola.SplitPane</a><a href="./cola.Stack.html" class="item data-item">cola.Stack</a><a href="./cola.Steps.html" class="item data-item">cola.Steps</a><a href="./cola.SubView.html" class="item data-item">cola.SubView</a><a href="./cola.Tab.html" class="item data-item">cola.Tab</a><a href="./cola.TabButton.html" class="item data-item">cola.TabButton</a><a href="./cola.Table.html" class="item data-item">cola.Table</a><a href="./cola.TableColumn.html" class="item data-item">cola.TableColumn</a><a href="./cola.TableContentColumn.html" class="item data-item">cola.TableContentColumn</a><a href="./cola.TableDataColumn.html" class="item data-item">cola.TableDataColumn</a><a href="./cola.TableGroupColumn.html" class="item data-item">cola.TableGroupColumn</a><a href="./cola.TableSelectColumn.html" class="item data-item">cola.TableSelectColumn</a><a href="./cola.Tag.html" class="item data-item">cola.Tag</a><a href="./cola.TimeLine.html" class="item data-item">cola.TimeLine</a><a href="./cola.TitleBar.html" class="item data-item">cola.TitleBar</a><a href="./cola.Toggle.html" class="item data-item">cola.Toggle</a><a href="./cola.Tree.html" class="item data-item">cola.Tree</a><a href="./cola.TreeNode.html" class="item data-item">cola.TreeNode</a><a href="./cola.TreeNodeBind.html" class="item data-item">cola.TreeNodeBind</a><a href="./cola.UrlValidator.html" class="item data-item">cola.UrlValidator</a><a href="./cola.Validator.html" class="item data-item">cola.Validator</a><a href="./cola.Widget.html" class="item data-item">cola.Widget</a><a href="./cola.breadcrumb.Section.html" class="item data-item">cola.breadcrumb.Section</a><a href="./cola.browser.html" class="item data-item">cola.browser</a><a href="./cola.buttonGroup.Separator.html" class="item data-item">cola.buttonGroup.Separator</a><a href="./cola.contants.html" class="item data-item">cola.contants</a><a href="./cola.defaultAction.html" class="item data-item">cola.defaultAction</a><a href="./cola.device.html" class="item data-item">cola.device</a><a href="./cola.os.html" class="item data-item">cola.os</a><a href="./cola.steps.Step.html" class="item data-item">cola.steps.Step</a><a href="./cola.tab.AbstractTabButton.html" class="item data-item">cola.tab.AbstractTabButton</a><a href="./cola.util.html" class="item data-item active">cola.util</a><a href="./cola.util.KeyedArray.html" class="item data-item">cola.util.KeyedArray</a></div></div><div id="doc-content" class="small-12 medium-9 large-10 columns"><div style="height:100%" class="v-box"><div class="box"><h2 class="ui header">cola.util</h2><div class="intro"><div class="sub header">Cola中各种工具方法的命名空间</div><div class="description"><p></p></div></div><div class="ui pointing secondary menu"><a data-tab="methods" class="item active">Methods</a></div></div><div class="flex-box"><div><div data-tab="methods" class="ui tab active"><div class="ui methods"><div class="item"><div class="item-header"><strong>filter</strong><span class="label">对一个数组或EntityList进行过滤</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">data</span><span class="type">array || cola.EntityList</span><p class="desc">要过滤的数组或EntityList</p></li><li class="param"><span class="name ui label mini horizontal">criteria</span><span class="type">stirng || object</span><p class="desc">此参数有两种定义方式：
<ul>
<li>
当我们传入一个字符串时，表示用该值匹配对象中的每一个属性（如果集合中的对象本身就是一个值而非对象，那么则直接匹配该值）。
</li>
<li>
如果criteria是一个JSON对象，那么我们就可以在JSON中定义更加详细的过滤规则。例如，它可能会是这个样子的...
<code>
{
name: { //属性名，如果属性名为"$"表示要匹配每一个属性
value: "b", //要匹配的值，模糊匹配
caseSensitive: true //是否大小写敏感，非必须
},
gendar: {
value: "male",
strict: true //是否严格匹配，非必须
}
}
</code>
以上的定义表示过滤出所有name属性中带有字母b（大小写敏感）的员工一级gendar属性为male的员工。
</li>
</ul>
</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">array</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>sort</strong><span class="label">对一个数组或EntityList进行排序</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">data</span><span class="type">array || cola.EntityList</span><p class="desc">要排序的数组或EntityList</p></li><li class="param"><span class="name ui label mini horizontal">comparator</span><span class="type">stirng || object</span><p class="desc">此参数有四种定义方式：
<ul>
<li>
如果comparator是字符串，表示是一个属性名，即按照此属性进行排序。如果第一个字符为'+'或'-'表示正向或逆向的排序。
例如： sort(employees, 'age') 表示按照age从小到大排序; sort(employees, '-age') 表示按照age从大到小排序。
如果集合中数据本身就是一个值而非对象，则可以省略上面的属性名，比如： sort(names, '-') 表示逆向排序names中的值。
</li>
<li>
如果comparator是一个JSON对象，那么我们就可以在JSON中定义更加详细的排序规则。例如，它可能会是这个样子的...
<code>
[
{ prop:"age", desc:true }, //按照age逆向排序
{ prop:"name", caseSensitive: true } //按照name排序，且大小写敏感
]
</code>
以上的定义先按照age逆向排序，再按照name排序，且大小写敏感。
</li>
<li>
如果comparator为$none，表示不排序，以原始顺序返回。
</li>
<li>
如果comparator为$random，表示随机排序。
</li>
</ul>
</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">array</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>where</strong><span class="label">根据给定的条件对数组或EntityList中的数据进行查询，并以数组的形式返回结果</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">data</span><span class="type">array || cola.EntityList</span><p class="desc">要过滤的数组或EntityList</p></li><li class="param"><span class="name ui label mini horizontal">criteria</span><span class="type">stirng || object</span><p class="desc">请参考 cola.util.filter() 的criteria参数</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">array</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>find</strong><span class="label">根据给定的条件对数组或EntityList中的数据进行查询，并返回匹配的第一比数据</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="return"><span class="label">Returns:</span><span class="type">object || cola.Entity</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>buildIndex</strong><span class="label">为一组Entity建立索引</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">data</span><span class="type">cola.EntityList || cola.Entity</span><p class="desc">要索引的EntityList或Entity</p></li><li class="param"><span class="name ui label mini horizontal">property</span><span class="type">stirng</span><p class="desc">目前只支持定义一个属性名</p></li><li class="param"><span class="name ui label mini horizontal">option</span><span class="type">json</span><p class="desc">选项</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">cola.EntityIndex</span></div><pre class="description">如果你需要频繁的利用某中特定的条件从一组Entity中查找实例，可以考虑利用此方法提高搜索效率。
</pre></div></div><div class="item"><div class="item-header"><strong>dirtyTree</strong><span class="label">从给定的一组数据中提取出"最小脏树"</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">data</span><span class="type">cola.Entity || cola.EntityList</span><p class="desc">源数据</p></li><li class="param"><span class="name ui label mini horizontal">options</span><span class="type">json</span><p class="desc">选项</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">json || [json]</span></div><pre class="description"><p>
"最小脏树"的概念是这样的，当我们提交一个EntityList或和包含子Entity的数据时出于性能考虑，
通常我们并不需要提交整个EntityList或Entity，原则上我们只需要提交其中那些"脏"状态的Entity就可以了。
</p>
<p>
但是，对于那些状结构的数据而言，简单提取出"脏"状态的Entity会破坏树原有的结构。
为了保证提交的数据仍然保持正确的数据结构，我们就不得不多提交一些必要的并不"脏"的Entity。
我们将以这种方式提取出来的仍然保持正确结构的"脏"数据树称为"最小脏树"。
</p>
</pre></div></div><div class="item"><div class="item-header"><strong>update</strong><span class="label">提交数据</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">url</span><span class="type">string</span><p class="desc">数据提交到的目标URL</p></li><li class="param"><span class="name ui label mini horizontal">data</span><span class="type">cola.Entity || cola.EntityList || json || [json] || any</span><p class="desc"><p>
如果给定的源数据是cola.Entity或cola.EntityList，此方法会在内部调用 cola.util.dirtyTree() 得到最终要提交到服务端的JSON数据。
</p>
<p>
默认情况下，当异常发生时Cola会自动提示异常信息。但是有时我们可能希望自行处理这些异常信息，有两个方法可以做到这一点...
<li>
利用Deferred对象的fail处理器，例如...
<code>
cola.util.update("/yourServiceUrl", data).fail(function(error) {
// 自行处理异常信息的代码
this.errorProcessed = true; // 通知Cola异常信息已被处理，后续的系统默认处理将被跳过
);
</code>
</li>
<li>
利用options中的errorProcessor选项，例如...
<code>
cola.util.update("/yourServiceUrl", data, {
errorProcessor: function(error) {
// 自行处理异常信息的代码
return false; // 通知Cola忽略系统默认处理机制
}
});
</code>
</li>
</p>
</p></li><li class="param"><span class="name ui label mini horizontal">options</span><span class="type">json</span><p class="desc">选项</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">Deferred</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>autoUpdate</strong><span class="label">自动提交</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">url</span><span class="type">string</span><p class="desc">数据提交到的目标URL</p></li><li class="param"><span class="name ui label mini horizontal">model</span><span class="type">cola.Model</span><p class="desc">要监听的Model</p></li><li class="param"><span class="name ui label mini horizontal">path</span><span class="type">string</span><p class="desc">要监听的数据路径</p></li><li class="param"><span class="name ui label mini horizontal">options</span><span class="type">json</span><p class="desc">选项。此选项支持 cola.util.update() 方法的options参数中的所有的子选项，同时还支持更多。</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">json || [json]</span></div><pre class="description">此方法可以监听Model中某个数据路径下的数据，当这些数据发生变化时Cola会自动将修改提交到指定的服务中。
</pre></div></div><div class="item"><div class="item-header"><strong>trim</strong><span class="label">取出字符串两端的空字符</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">str</span><span class="type">string</span><p class="desc">字符串</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">string</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>capitalize</strong><span class="label">将一个字符串的首字符转换成大写</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">str</span><span class="type">string</span><p class="desc">字符串</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">string</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>isSimpleValue</strong><span class="label">判断一个值是否简单数据类型</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">value</span><span class="type">any</span><p class="desc">值</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">boolean</span></div><pre class="description">即该值为string、number、boolean、Date，而不是object、array或其他的prototype实例。
</pre></div></div><div class="item"><div class="item-header"><strong>path</strong><span class="label">将一组url片段连接成一个url，该方法可以自动处理连接时的“/”分割符，避免遗漏或重复。</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">part...</span><span class="type">string</span><p class="desc">url片段</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">string</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>each</strong><span class="label">迭代一个数组或EntityList</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">data</span><span class="type">array || cola.EntityList</span><p class="desc">要迭代的数据</p></li><li class="param"><span class="name ui label mini horizontal">fn</span><span class="type">function</span><p class="desc">示例如下：
<code>
cola.util.each(employees, function(employee, i) {
if (employees.get("name") === "Nick") {
// do something
return false; // 返回false表示终止迭代
}
});
</code>
</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">void</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>findModel</strong><span class="label">根据传入的DOM元素查找其相关的Model</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">dom</span><span class="type">HTMLElement</span><p class="desc">DOM元素</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">cola.Model</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>formatDate</strong><span class="label">将传入的日期转换成特定格式的字符串</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">date</span><span class="type">Date</span><p class="desc">日期</p></li><li class="param"><span class="name ui label mini horizontal">pattern</span><span class="type">string</span><p class="desc">输出格式</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">string</span></div><pre class="description">参考以下部分示例:
<code>
cola.util.formatDate(date, "yyyy-MM-dd") // 2018-01-06
cola.util.formatDate(date, "HH:mm:ss") // 12:06:17.509
cola.util.formatDate(date, "yyyy'年'MM'月'dd'日' dddd") // 2018年01月06日 星期六
cola.util.formatDate(date, "yyyy-MM-dd'T'HH:mm:ss.fffzzz") // 2018-01-06T12:06:17.509+0800
cola.util.formatDate(date, "yyyy-MM-dd HH:mm:ss z") // 2018-01-06 12:15:28 +8
</code>
</pre></div></div><div class="item"><div class="item-header"><strong>formatNumber</strong><span class="label">将传入的数字转换成特定格式的字符串</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">number</span><span class="type">number</span><p class="desc">数字</p></li><li class="param"><span class="name ui label mini horizontal">pattern</span><span class="type">string</span><p class="desc">输出格式</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">string</span></div><pre class="description">参考以下部分示例:
<code>
cola.util.formatNumber(123456.789, "0") // 123457
cola.util.formatNumber(123456.789, "0.00") // 123456.79
cola.util.formatNumber(123456.789, "0.######") // 123456.789
cola.util.formatNumber(123456.789, "0.000000") // 123456.789000
cola.util.formatNumber(123456.789, "#,#0.00") // 12,34,56.79
cola.util.formatNumber(123456.789, "￥0.00") // ￥123456.79
cola.util.formatNumber(123456, "0.00") // 123456.00
</code>
</pre></div></div><div class="item"><div class="item-header"><strong>format</strong><span class="label">自动根据传入数据的类型转成特定格式的字符串</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">data</span><span class="type">number || date</span><p class="desc">数字或日期</p></li><li class="param"><span class="name ui label mini horizontal">pattern</span><span class="type">string</span><p class="desc">输出格式</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">string</span></div><pre class="description">此方法内部自动判断传入数据的类型来决定要调用cola.util.formatNumber()还是cola.util.formatDate()
</pre></div></div><div class="item"><div class="item-header"><strong>queryParams</strong><span class="label">将当前页面URL中的get参数转换成一个JSON对象</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="return"><span class="label">Returns:</span><span class="type">json</span></div><pre class="description">例如：
<code>
// 假设URL中目前是 http://cola-ui.com/search?type=event&keyword=beforeChange
var param = cola.util.queryParams();
/*
param的内容应该是这样的...
{
type: "event",
keyword: "beforeChange"
}
*/
</code>
</pre></div></div><div class="item"><div class="item-header"><strong>pathParams</strong><span class="label">将当前页面URL按照RESTFUL的规范解析成一个数组</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">prefix</span><span class="type">string</span><p class="desc">前缀片段，即本次解析只关注URL中该前缀后面的部分</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">string</span></div><pre class="description">例如：
<code>
// 假设URL中目前是 http://cola-ui.com/api/cola.Entity/member/get
var parts = cola.util.pathParams("api");
/*
parts的内容应该是这样的...
["cola.Entity", "member", "get"]
*/
</code>
</pre></div></div><div class="item"><div class="item-header"><strong>dictionary</strong><span class="label">注册一个键值对字典</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">name</span><span class="type">string</span><p class="desc">字典的名称</p></li><li class="param"><span class="name ui label mini horizontal">keyValues</span><span class="type">json | [json]</span><p class="desc">键值对数据</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">json</span></div><pre class="description"><p>
此方法通常与 cola.util.translate() 或绑定表达式中的 translate() 配合使用。
</p>
<p>
注册字典有两种方式...
<li>
以一个JSON对象来定义，例如：
<code>
cola.util.dictionary("currency", {
"CNY": "人民币",
"USD": "美元",
"EUR": "欧元"
});
</code>
以此种方式定义字典的缺点是无法按照顺序迭代所有键值对，当我们需要把字典项迭代出来的时候，各项的顺序是无法确定的。
因此我们还提供了另一种定义方式。
</li>
<li>
以数组方式定义，例如：
<code>
cola.util.dictionary("currency", [
{ key: "CNY", value: "人民币" },
{ key: "USD", value: "美元" },
{ key: "EUR", value: "欧元" }
]);
</code>
</li>
</p>
</pre></div></div><div class="item"><div class="item-header"><strong>dictionary</strong><span class="label">根据名称获得字典的键值对列表</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">name</span><span class="type">string</span><p class="desc">字典的名称</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">json</span></div><pre class="description">不论该字典的数据之前是以何种方式声明此方法返回的数据都是如下这种形式的：
<code>
[
{ key: "CNY", value: "人民币" },
{ key: "USD", value: "美元" },
{ key: "EUR", value: "欧元" }
]
</code>
</pre></div></div><div class="item"><div class="item-header"><strong>translate</strong><span class="label">根据字典名称和键返回值</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">name</span><span class="type">string</span><p class="desc">字典的名称</p></li><li class="param"><span class="name ui label mini horizontal">key</span><span class="type">string</span><p class="desc">键</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">string</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>addClass</strong><span class="label">为dom添加class，支持semantic连写模式</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">dom</span><span class="type">HTMLElement</span><p class="desc"></p></li><li class="param"><span class="name ui label mini horizontal">value</span><span class="type">string</span><p class="desc"></p></li><li class="param"><span class="name ui label mini horizontal">continuous</span><span class="type">boolean</span><p class="desc">是否连续</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">void</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>removeClass</strong><span class="label">删除dom class，支持semantic连写模式</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">dom</span><span class="type">HTMLElement</span><p class="desc"></p></li><li class="param"><span class="name ui label mini horizontal">value</span><span class="type">string</span><p class="desc"></p></li><li class="param"><span class="name ui label mini horizontal">continuous</span><span class="type">boolean</span><p class="desc">是否连写</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">void</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>toggleClass</strong><span class="label">与jqeury的toggleClass 功能类似，不过支持了semantic连写模式</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">dom</span><span class="type">HTMLElement</span><p class="desc"></p></li><li class="param"><span class="name ui label mini horizontal">value</span><span class="type">string</span><p class="desc"></p></li><li class="param"><span class="name ui label mini horizontal">stateVal</span><span class="type">boolean</span><p class="desc">状态</p></li><li class="param"><span class="name ui label mini horizontal">continuous</span><span class="type">boolean</span><p class="desc">是否连续</p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">void</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>hasClass</strong><span class="label">判断class的存在性</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">dom</span><span class="type">HTMLElement</span><p class="desc"></p></li><li class="param"><span class="name ui label mini horizontal">className</span><span class="type">string</span><p class="desc"></p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">void</span></div><pre class="description"></pre></div></div><div class="item"><div class="item-header"><strong>typeOf</strong><span class="label">判断对象类型,跨域了window scope。</span><em><a href="./cola.util.html"><code>cola.util</code></a></em></div><div class="item-body"><div class="parameters"><div class="label">Parameters:</div><ul><li class="param"><span class="name ui label mini horizontal">obj</span><span class="type">any</span><p class="desc"></p></li><li class="param"><span class="name ui label mini horizontal">type</span><span class="type">string</span><p class="desc"></p></li></ul></div><div class="return"><span class="label">Returns:</span><span class="type">void</span></div><pre class="description"></pre></div></div></div></div></div></div></div></div></div></div><div id="sidebar" c-widget="layer" class="ui layer"><div class="v-box"><div class="box"><div class="ui menu inverted"><a id="backButton" class="item icon"><i class="angle left icon"></i></a><div class="item"><div class="ui icon input transparent inverted"><input id="sidebarSearchInput" type="text" placeholder="搜索..."></div></div><a id="searchButton" class="item icon"><i class="search icon"></i></a></div></div><div class="flex-box"><div><div class="ui list"><a href="./$.html" class="item data-item">$</a><a href="./cola.html" class="item data-item">cola</a><a href="./cola.AbstractButton.html" class="item data-item">cola.AbstractButton</a><a href="./cola.AbstractCheckbox.html" class="item data-item">cola.AbstractCheckbox</a><a href="./cola.AbstractContainer.html" class="item data-item">cola.AbstractContainer</a><a href="./cola.AbstractDropdown.html" class="item data-item">cola.AbstractDropdown</a><a href="./cola.AbstractEditor.html" class="item data-item">cola.AbstractEditor</a><a href="./cola.AbstractInput.html" class="item data-item">cola.AbstractInput</a><a href="./cola.AbstractItemGroup.html" class="item data-item">cola.AbstractItemGroup</a><a href="./cola.AbstractList.html" class="item data-item">cola.AbstractList</a><a href="./cola.AbstractMenuItem.html" class="item data-item">cola.AbstractMenuItem</a><a href="./cola.AbstractSlotList.html" class="item data-item">cola.AbstractSlotList</a><a href="./cola.AjaxValidator.html" class="item data-item">cola.AjaxValidator</a><a href="./cola.AsyncValidator.html" class="item data-item">cola.AsyncValidator</a><a href="./cola.Avatar.html" class="item data-item">cola.Avatar</a><a href="./cola.Breadcrumb.html" class="item data-item">cola.Breadcrumb</a><a href="./cola.Button.html" class="item data-item">cola.Button</a><a href="./cola.ButtonGroup.html" class="item data-item">cola.ButtonGroup</a><a href="./cola.Calendar.html" class="item data-item">cola.Calendar</a><a href="./cola.CardBook.html" class="item data-item">cola.CardBook</a><a href="./cola.Carousel.html" class="item data-item">cola.Carousel</a><a href="./cola.CascadeBind.html" class="item data-item">cola.CascadeBind</a><a href="./cola.Checkbox.html" class="item data-item">cola.Checkbox</a><a href="./cola.ControlMenuItem.html" class="item data-item">cola.ControlMenuItem</a><a href="./cola.Corner.html" class="item data-item">cola.Corner</a><a href="./cola.CustomDropdown.html" class="item data-item">cola.CustomDropdown</a><a href="./cola.CustomValidator.html" class="item data-item">cola.CustomValidator</a><a href="./cola.DataType.html" class="item data-item">cola.DataType</a><a href="./cola.DatePicker.html" class="item data-item">cola.DatePicker</a><a href="./cola.DateTimePicker.html" class="item data-item">cola.DateTimePicker</a><a href="./cola.Definition.html" class="item data-item">cola.Definition</a><a href="./cola.Dialog.html" class="item data-item">cola.Dialog</a><a href="./cola.Divider.html" class="item data-item">cola.Divider</a><a href="./cola.Dropdown.html" class="item data-item">cola.Dropdown</a><a href="./cola.DropdownMenuItem.html" class="item data-item">cola.DropdownMenuItem</a><a href="./cola.Element.html" class="item data-item">cola.Element</a><a href="./cola.EmailValidator.html" class="item data-item">cola.EmailValidator</a><a href="./cola.Entity.html" class="item data-item">cola.Entity</a><a href="./cola.EntityDataType.html" class="item data-item">cola.EntityDataType</a><a href="./cola.EntityList.html" class="item data-item">cola.EntityList</a><a href="./cola.FieldSet.html" class="item data-item">cola.FieldSet</a><a href="./cola.GroupBox.html" class="item data-item">cola.GroupBox</a><a href="./cola.HeaderMenuItem.html" class="item data-item">cola.HeaderMenuItem</a><a href="./cola.IFrame.html" class="item data-item">cola.IFrame</a><a href="./cola.Image.html" class="item data-item">cola.Image</a><a href="./cola.Input.html" class="item data-item">cola.Input</a><a href="./cola.ItemsView.html" class="item data-item">cola.ItemsView</a><a href="./cola.Label.html" class="item data-item">cola.Label</a><a href="./cola.Layer.html" class="item data-item">cola.Layer</a><a href="./cola.LengthValidator.html" class="item data-item">cola.LengthValidator</a><a href="./cola.Link.html" class="item data-item">cola.Link</a><a href="./cola.ListView.html" class="item data-item">cola.ListView</a><a href="./cola.Menu.html" class="item data-item">cola.Menu</a><a href="./cola.MenuButton.html" class="item data-item">cola.MenuButton</a><a href="./cola.MenuItem.html" class="item data-item">cola.MenuItem</a><a href="./cola.Model.html" class="item data-item">cola.Model</a><a href="./cola.MultiSlotPicker.html" class="item data-item">cola.MultiSlotPicker</a><a href="./cola.NestedList.html" class="item data-item">cola.NestedList</a><a href="./cola.NestedListBind.html" class="item data-item">cola.NestedListBind</a><a href="./cola.NestedListNode.html" class="item data-item">cola.NestedListNode</a><a href="./cola.Node.html" class="item data-item">cola.Node</a><a href="./cola.NotifyTipManager.html" class="item data-item">cola.NotifyTipManager</a><a href="./cola.NumberValidator.html" class="item data-item">cola.NumberValidator</a><a href="./cola.Pager.html" class="item data-item">cola.Pager</a><a href="./cola.Panel.html" class="item data-item">cola.Panel</a><a href="./cola.PointingLabel.html" class="item data-item">cola.PointingLabel</a><a href="./cola.Progress.html" class="item data-item">cola.Progress</a><a href="./cola.Property.html" class="item data-item">cola.Property</a><a href="./cola.Provider.html" class="item data-item">cola.Provider</a><a href="./cola.RadioButton.html" class="item data-item">cola.RadioButton</a><a href="./cola.RadioGroup.html" class="item data-item">cola.RadioGroup</a><a href="./cola.RangeSlotList.html" class="item data-item">cola.RangeSlotList</a><a href="./cola.Rating.html" class="item data-item">cola.Rating</a><a href="./cola.RegExpValidator.html" class="item data-item">cola.RegExpValidator</a><a href="./cola.RenderableElement.html" class="item data-item">cola.RenderableElement</a><a href="./cola.RequiredValidator.html" class="item data-item">cola.RequiredValidator</a><a href="./cola.Reveal.html" class="item data-item">cola.Reveal</a><a href="./cola.Ribbon.html" class="item data-item">cola.Ribbon</a><a href="./cola.Segment.html" class="item data-item">cola.Segment</a><a href="./cola.Select.html" class="item data-item">cola.Select</a><a href="./cola.Sidebar.html" class="item data-item">cola.Sidebar</a><a href="./cola.Slider.html" class="item data-item">cola.Slider</a><a href="./cola.SlotList.html" class="item data-item">cola.SlotList</a><a href="./cola.SplitPane.html" class="item data-item">cola.SplitPane</a><a href="./cola.Stack.html" class="item data-item">cola.Stack</a><a href="./cola.Steps.html" class="item data-item">cola.Steps</a><a href="./cola.SubView.html" class="item data-item">cola.SubView</a><a href="./cola.Tab.html" class="item data-item">cola.Tab</a><a href="./cola.TabButton.html" class="item data-item">cola.TabButton</a><a href="./cola.Table.html" class="item data-item">cola.Table</a><a href="./cola.TableColumn.html" class="item data-item">cola.TableColumn</a><a href="./cola.TableContentColumn.html" class="item data-item">cola.TableContentColumn</a><a href="./cola.TableDataColumn.html" class="item data-item">cola.TableDataColumn</a><a href="./cola.TableGroupColumn.html" class="item data-item">cola.TableGroupColumn</a><a href="./cola.TableSelectColumn.html" class="item data-item">cola.TableSelectColumn</a><a href="./cola.Tag.html" class="item data-item">cola.Tag</a><a href="./cola.TimeLine.html" class="item data-item">cola.TimeLine</a><a href="./cola.TitleBar.html" class="item data-item">cola.TitleBar</a><a href="./cola.Toggle.html" class="item data-item">cola.Toggle</a><a href="./cola.Tree.html" class="item data-item">cola.Tree</a><a href="./cola.TreeNode.html" class="item data-item">cola.TreeNode</a><a href="./cola.TreeNodeBind.html" class="item data-item">cola.TreeNodeBind</a><a href="./cola.UrlValidator.html" class="item data-item">cola.UrlValidator</a><a href="./cola.Validator.html" class="item data-item">cola.Validator</a><a href="./cola.Widget.html" class="item data-item">cola.Widget</a><a href="./cola.breadcrumb.Section.html" class="item data-item">cola.breadcrumb.Section</a><a href="./cola.browser.html" class="item data-item">cola.browser</a><a href="./cola.buttonGroup.Separator.html" class="item data-item">cola.buttonGroup.Separator</a><a href="./cola.contants.html" class="item data-item">cola.contants</a><a href="./cola.defaultAction.html" class="item data-item">cola.defaultAction</a><a href="./cola.device.html" class="item data-item">cola.device</a><a href="./cola.os.html" class="item data-item">cola.os</a><a href="./cola.steps.Step.html" class="item data-item">cola.steps.Step</a><a href="./cola.tab.AbstractTabButton.html" class="item data-item">cola.tab.AbstractTabButton</a><a href="./cola.util.html" class="item data-item active">cola.util</a><a href="./cola.util.KeyedArray.html" class="item data-item">cola.util.KeyedArray</a></div></div></div></div></div></body><script src="./resources/javascript.js"></script><script src="./resources/doc.js"></script></html>