Skip to content

Commit c5e20a5

Browse files
author
城西
committed
doc: SDK 标准文档更新
1 parent 3c2c39c commit c5e20a5

39 files changed

+1022
-109
lines changed

Doc/LuaViewSDK/CollectionView.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
--- CollectionView
22
-- 类似于Cell大小任意的TableView
33
--
4-
-- CollectionView的父类是[HScrollView](./HScrollView.html)
4+
-- CollectionView的父类是[VScrollView](./VScrollView.html)
55
-- @classmod CollectionView
66

77

Doc/LuaViewSDK/HScrollView.lua

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
--- HScrollView
2-
-- 可滚动的View
2+
-- 水平滚动的View
33
--
4-
-- HScrollView的父类是[View](./View.html), 子类有[TableView](./TableView.html), [CollectionView](./CollectionView.html)
4+
-- HScrollView的父类是[View](./View.html)
55
-- @classmod HScrollView
66

77

Doc/LuaViewSDK/Mtop.lua

Lines changed: 20 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,26 @@
77
-- @table params Mtop请求参数 (可选)
88
-- @tparam function callback (可选)
99
-- @usage
10-
-- Mtop(
11-
-- {
12-
-- method = "mtop.ju.block.optionminisite.get",
13-
-- version= "1.0",
14-
-- params = {
15-
-- platformId = "8001",
16-
-- page = 1,
17-
-- pageSize = 10000,
18-
-- optStr = self.optStr
19-
-- },
20-
-- },
21-
-- ^( data, error){
22-
-- self.isLoading = false;
23-
-- if( data ) {
24-
-- local model = data.model;
25-
-- if( self.extend==nil )
26-
-- self.extend = {};
27-
-- self.extend.syncOutput = model;
28-
-- self.haveItems = true;
29-
-- print(self.displayName, self.optStr, "loaded: ");
30-
-- } else {
31-
-- print(self.displayName, self.optStr, "error: ", error);
32-
-- }
33-
-- if( callback ) {
34-
-- callback(option);
35-
-- }
36-
-- self.hiddenLoadingView();
37-
-- }
38-
-- );
10+
-- function net.updateOptionBanner()
11+
-- local mtop = Mtop(
12+
-- {
13+
-- method = "mtop.options.get",
14+
-- version= "1.0",
15+
-- params = {
16+
-- platformId = "7101",
17+
-- page = 1,
18+
-- pageSize = 1000,
19+
-- },
20+
-- },
21+
-- function( data, error)
22+
-- if ( data ) then
23+
-- print("updateOptionBanner", data);
24+
-- end
25+
-- end
26+
-- );
27+
-- mtop.request();
28+
-- end
29+
--
3930
function Mtop()
4031
end
4132

Doc/LuaViewSDK/PagerView.lua

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
--- PageView
1+
--- PagerView
22
-- 横向分页滚动的View
33
--
4-
-- PageView的父类是[View](View.html)
5-
-- @classmod PageView
4+
-- PagerView的父类是[HScrollView](./HScrollView.html)
5+
-- @classmod PagerView
66

77

88

9-
--- 创建一个PageView对象
9+
--- 创建一个PagerView对象
1010
-- @tparam table delegate 参数
11-
-- @treturn PageView pageView
12-
-- @usage local pageView = PageView();
11+
-- @treturn PagerView pageView
12+
-- @usage local pageView = PagerView();
1313
-- require "lv_kit"
1414
--
1515
-- local width, height= System.screenSize()
1616
--
17-
-- pageView = PageView({
17+
-- pageView = PagerView({
1818
-- PageCount = 12,
1919
-- Pages = {
2020
-- Init = function(page, pos)
@@ -40,7 +40,7 @@
4040
--
4141
-- windowWidth , windowHeight = window.size();
4242
-- pageView.frame(0,0,windowWidth,windowHeight-64)
43-
function PageView()
43+
function PagerView()
4444
end
4545

4646
--- 设置当前页面
@@ -52,7 +52,7 @@ end
5252
function currentPage( )
5353
end
5454

55-
--- 重新加载PageView
55+
--- 重新加载PagerView
5656
function reload()
5757
end
5858

Doc/LuaViewSDK/TableView.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
--- TableView
22
-- 每行高度样式可定制和重复利用的列表
33
--
4-
-- TableView的父类是[HScrollView](./HScrollView.html)
4+
-- TableView的父类是[VScrollView](./VScrollView.html)
55
-- @classmod TableView
66

77

Doc/LuaViewSDK/VScrollView.lua

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
--- VScrollView
2+
-- 垂直滚动的View
3+
--
4+
-- VScrollView的父类是[View](./View.html), 子类有[TableView](./TableView.html), [CollectionView](./CollectionView.html)
5+
-- @classmod VScrollView
6+
7+
8+
--- 通过这个方法创建一个VScrollView对象
9+
-- @treturn VScrollView view
10+
-- @usage
11+
-- Cell
12+
-- local scrW, scrH = System.screenSize();
13+
-- local cellW = scrW;
14+
-- local cellH = 130;
15+
-- CellJinrishouxuan = {};
16+
-- CellJinrishouxuan.width = cellW;
17+
-- CellJinrishouxuan.height = cellH;
18+
-- function CellJinrishouxuan.create(originCell)
19+
-- local cell = {};
20+
-- cell.cellInited = false;
21+
-- function cell.init()
22+
-- if (self.cellInited == false ) then
23+
-- self.cellInited = true;
24+
-- self.scrollView = VScrollView();
25+
-- self.scrollView.frame( 0, 0, cellW, cellH );
26+
-- self.items = {};
27+
-- for i=1,3 do
28+
-- local item = CellProductSmall.create(nil, cellW / 3, cellH );
29+
-- self.scrollView.addView(item.view);
30+
-- item.xy(cellH*(i-1),0 );
31+
-- self.items[i] = item;
32+
-- item.bizIconUrl = "https://gw.alicdn.com/tps/TB1Q6oxKpXXXXbcXVXXXXXXXXXX-86-96.png";
33+
-- end
34+
-- self.scrollView.contentSize(3*cellH, cellH);
35+
-- self.scrollView.showScrollIndicator(true,false)
36+
-- self.scrollView.backgroundColor(0xffffff);
37+
-- end
38+
-- end
39+
-- function cell.layout(model,option)
40+
-- if(not model) then return end
41+
-- local itemList = model.itemList;
42+
-- local num = table:getn(itemList);
43+
-- for i=1, num do
44+
-- local model = itemList[i];
45+
-- local item = self.items[i];
46+
-- item.layout(model,option);
47+
-- end
48+
-- end
49+
-- cell.init();
50+
-- return cell;
51+
-- end
52+
function VScrollView()
53+
end
54+
55+
--- 设置ContentSize大小
56+
-- @number w 宽
57+
-- @number h 高
58+
function contentSize()
59+
end
60+
61+
--- 获取ContentSize大小
62+
-- @treturn number w 宽
63+
-- @treturn number h 高
64+
function contentSize()
65+
end
66+
67+
--- 设置ContentSize大小
68+
-- @number x x滚动偏移位置
69+
-- @number y y滚动偏移位置
70+
-- @bool animation 是否动画 参数可以省略
71+
function offset()
72+
end
73+
74+
--- 获取contentOffset大小
75+
-- @treturn number x
76+
-- @treturn number y
77+
function offset()
78+
end
79+
80+
--- 设置contentInset(只对IOS有效)
81+
-- @number top
82+
-- @number left
83+
-- @number bottom
84+
-- @number right
85+
function contentInset()
86+
end
87+
88+
--- 获取contentInset(只对IOS有效)
89+
-- @treturn number top
90+
-- @treturn number left
91+
-- @treturn number bottom
92+
-- @treturn number right
93+
function contentInset()
94+
end
95+
96+
--- 设置是否显示滚动条
97+
-- @bool showsHorizontal 显示水平滚动条
98+
function showScrollIndicator()
99+
end
100+
101+
--- 获取是否显示滚动条信息
102+
-- @treturn bool showsHorizontal 显示水平滚动条
103+
function showScrollIndicator()
104+
end
105+
106+
-- --- 代码控制 开始下拉刷新动画
107+
-- function startRefreshing()
108+
-- end
109+
110+
-- --- 停止下拉刷新动画(数据已经加载完成后调用)
111+
-- function stopRefreshing()
112+
-- end
113+
114+
-- --- 是否正在下拉刷新动画中
115+
-- function isRefreshing()
116+
-- end
117+

Doc/doc/index.html

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,14 @@ <h2>类</h2>
6161
<li><a href="类/Mtop.html">Mtop</a></li>
6262
<li><a href="类/Navigation.html">Navigation</a></li>
6363
<li><a href="类/PagerIndicator.html">PagerIndicator</a></li>
64-
<li><a href="类/PageView.html">PageView</a></li>
64+
<li><a href="类/PagerView.html">PagerView</a></li>
6565
<li><a href="类/StyledString.html">StyledString</a></li>
6666
<li><a href="类/TableView.html">TableView</a></li>
6767
<li><a href="类/TextField.html">TextField</a></li>
6868
<li><a href="类/Timer.html">Timer</a></li>
6969
<li><a href="类/Toast.html">Toast</a></li>
7070
<li><a href="类/Transform3D.html">Transform3D</a></li>
71+
<li><a href="类/VScrollView.html">VScrollView</a></li>
7172
<li><a href="类/View.html">View</a></li>
7273
<li><a href="类/string.html">string</a></li>
7374
</ul>
@@ -161,7 +162,7 @@ <h2>类</h2>
161162
<tr>
162163
<td class="name" nowrap><a href="类/HScrollView.html">HScrollView</a></td>
163164
<td class="summary">HScrollView
164-
可滚动的View</td>
165+
水平滚动的View</td>
165166
</tr>
166167
<tr>
167168
<td class="name" nowrap><a href="类/Image.html">Image</a></td>
@@ -192,8 +193,8 @@ <h2>类</h2>
192193
banner滚动第几页的小圆点</td>
193194
</tr>
194195
<tr>
195-
<td class="name" nowrap><a href="类/PageView.html">PageView</a></td>
196-
<td class="summary">PageView
196+
<td class="name" nowrap><a href="类/PagerView.html">PagerView</a></td>
197+
<td class="summary">PagerView
197198
横向分页滚动的View</td>
198199
</tr>
199200
<tr>
@@ -225,6 +226,11 @@ <h2>类</h2>
225226
<td class="name" nowrap><a href="类/Transform3D.html">Transform3D</a></td>
226227
<td class="summary">Transform3D
227228
用于设置View的3D变换矩阵</td>
229+
</tr>
230+
<tr>
231+
<td class="name" nowrap><a href="类/VScrollView.html">VScrollView</a></td>
232+
<td class="summary">VScrollView
233+
垂直滚动的View</td>
228234
</tr>
229235
<tr>
230236
<td class="name" nowrap><a href="类/View.html">View</a></td>

Doc/doc/topics/readme.md.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,14 @@ <h2>类</h2>
6868
<li><a href="../类/Mtop.html">Mtop</a></li>
6969
<li><a href="../类/Navigation.html">Navigation</a></li>
7070
<li><a href="../类/PagerIndicator.html">PagerIndicator</a></li>
71-
<li><a href="../类/PageView.html">PageView</a></li>
71+
<li><a href="../类/PagerView.html">PagerView</a></li>
7272
<li><a href="../类/StyledString.html">StyledString</a></li>
7373
<li><a href="../类/TableView.html">TableView</a></li>
7474
<li><a href="../类/TextField.html">TextField</a></li>
7575
<li><a href="../类/Timer.html">Timer</a></li>
7676
<li><a href="../类/Toast.html">Toast</a></li>
7777
<li><a href="../类/Transform3D.html">Transform3D</a></li>
78+
<li><a href="../类/VScrollView.html">VScrollView</a></li>
7879
<li><a href="../类/View.html">View</a></li>
7980
<li><a href="../类/string.html">string</a></li>
8081
</ul>

Doc/doc/全局函数/Align.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,14 @@ <h2>类</h2>
6767
<li><a href="../类/Mtop.html">Mtop</a></li>
6868
<li><a href="../类/Navigation.html">Navigation</a></li>
6969
<li><a href="../类/PagerIndicator.html">PagerIndicator</a></li>
70-
<li><a href="../类/PageView.html">PageView</a></li>
70+
<li><a href="../类/PagerView.html">PagerView</a></li>
7171
<li><a href="../类/StyledString.html">StyledString</a></li>
7272
<li><a href="../类/TableView.html">TableView</a></li>
7373
<li><a href="../类/TextField.html">TextField</a></li>
7474
<li><a href="../类/Timer.html">Timer</a></li>
7575
<li><a href="../类/Toast.html">Toast</a></li>
7676
<li><a href="../类/Transform3D.html">Transform3D</a></li>
77+
<li><a href="../类/VScrollView.html">VScrollView</a></li>
7778
<li><a href="../类/View.html">View</a></li>
7879
<li><a href="../类/string.html">string</a></li>
7980
</ul>

Doc/doc/全局函数/FontStyle.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,14 @@ <h2>类</h2>
6767
<li><a href="../类/Mtop.html">Mtop</a></li>
6868
<li><a href="../类/Navigation.html">Navigation</a></li>
6969
<li><a href="../类/PagerIndicator.html">PagerIndicator</a></li>
70-
<li><a href="../类/PageView.html">PageView</a></li>
70+
<li><a href="../类/PagerView.html">PagerView</a></li>
7171
<li><a href="../类/StyledString.html">StyledString</a></li>
7272
<li><a href="../类/TableView.html">TableView</a></li>
7373
<li><a href="../类/TextField.html">TextField</a></li>
7474
<li><a href="../类/Timer.html">Timer</a></li>
7575
<li><a href="../类/Toast.html">Toast</a></li>
7676
<li><a href="../类/Transform3D.html">Transform3D</a></li>
77+
<li><a href="../类/VScrollView.html">VScrollView</a></li>
7778
<li><a href="../类/View.html">View</a></li>
7879
<li><a href="../类/string.html">string</a></li>
7980
</ul>

0 commit comments

Comments
 (0)