docs: update to latest
This commit is contained in:
@@ -76,19 +76,32 @@
|
||||
<ul>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floaty">Floaty</a></span><ul>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floaty_window_layout">floaty.window(layout)</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floaty_rawwindow_layout">floaty.rawWindow(layout)</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floaty_closeall">floaty.closeAll()</a></span></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floatywindow">FloatyWindow</a></span><ul>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floatywindow_setadjustenabled_enabled">FloatyWindow.setAdjustEnabled(enabled)</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floatywindow_setposition_x_y">FloatyWindow.setPosition(x, y)</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floatywindow_getx">FloatyWindow.getX()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floatywindow_gety">FloatyWindow.getY()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floatywindow_setsize_width_height">FloatyWindow.setSize(width, height)</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floatywindow_getwidht">FloatyWindow.getWidht()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floatywindow_getheight">FloatyWindow.getHeight()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floatywindow_close">FloatyWindow.close()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floatywindow_exitonclose">FloatyWindow.exitOnClose()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_setadjustenabled_enabled">window.setAdjustEnabled(enabled)</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_setposition_x_y">window.setPosition(x, y)</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_getx">window.getX()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_gety">window.getY()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_setsize_width_height">window.setSize(width, height)</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_getwidht">window.getWidht()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_getheight">window.getHeight()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_close">window.close()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_exitonclose">window.exitOnClose()</a></span></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_floatyrawwindow">FloatyRawWindow</a></span><ul>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_settouchable_touchable">window.setTouchable(touchable)</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_setposition_x_y_1">window.setPosition(x, y)</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_getx_1">window.getX()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_gety_1">window.getY()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_setsize_width_height_1">window.setSize(width, height)</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_getwidht_1">window.getWidht()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_getheight_1">window.getHeight()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_close_1">window.close()</a></span></li>
|
||||
<li><span class="stability_undefined"><a href="#floaty_window_exitonclose_1">window.exitOnClose()</a></span></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -105,6 +118,7 @@
|
||||
<li><code>layout</code> <span class="type"><xml></span> | <span class="type"><View></span> 悬浮窗界面的XML或者View</li>
|
||||
</ul>
|
||||
</div><p>指定悬浮窗的布局,创建并<strong>显示</strong>一个悬浮窗,返回一个<code>FloatyWindow</code>对象。</p>
|
||||
<p>该悬浮窗自带关闭、调整大小、调整位置按键,可根据需要调用<code>setAdjustEnabled()</code>函数来显示或隐藏。</p>
|
||||
<p>其中layout参数可以是xml布局或者一个View,更多信息参见ui模块的说明。</p>
|
||||
<p>例子:</p>
|
||||
<pre><code>var w = floaty.window(
|
||||
@@ -120,40 +134,116 @@ setTimeout(()=>{
|
||||
<pre><code>ui.run(function(){
|
||||
w.text.setText("文本");
|
||||
});
|
||||
</code></pre><h2>floaty.closeAll()<span><a class="mark" href="#floaty_floaty_closeall" id="floaty_floaty_closeall">#</a></span></h2>
|
||||
</code></pre><p>有关返回的<code>FloatyWindow</code>对象的说明,参见下面的<code>FloatyWindow</code>章节。</p>
|
||||
<h2>floaty.rawWindow(layout)<span><a class="mark" href="#floaty_floaty_rawwindow_layout" id="floaty_floaty_rawwindow_layout">#</a></span></h2>
|
||||
<div class="signature"><ul>
|
||||
<li><code>layout</code> <span class="type"><xml></span> | <span class="type"><View></span> 悬浮窗界面的XML或者View</li>
|
||||
</ul>
|
||||
</div><p>指定悬浮窗的布局,创建并<strong>显示</strong>一个原始悬浮窗,返回一个<code>FloatyRawWindow</code>对象。</p>
|
||||
<p>与<code>floaty.window()</code>函数不同的是,该悬浮窗不会增加任何额外设施(例如调整大小、位置按钮),您可以根据自己需要编写任何布局。</p>
|
||||
<p>而且,该悬浮窗支持完全全屏,可以覆盖状态栏,因此可以做护眼模式之类的应用。</p>
|
||||
<pre><code>var w = floaty.rawWindow(
|
||||
<frame gravity="center">
|
||||
<text id="text">悬浮文字</text>
|
||||
</frame>
|
||||
);
|
||||
|
||||
w.setPosition(500, 500);
|
||||
|
||||
setTimeout(()=>{
|
||||
w.close();
|
||||
}, 2000);
|
||||
</code></pre><p>这段代码运行后将会在屏幕上显示悬浮文字,并在两秒后消失。</p>
|
||||
<p>有关返回的<code>FloatyRawWindow</code>对象的说明,参见下面的<code>FloatyRawWindow</code>章节。</p>
|
||||
<h2>floaty.closeAll()<span><a class="mark" href="#floaty_floaty_closeall" id="floaty_floaty_closeall">#</a></span></h2>
|
||||
<p>关闭所有本脚本的悬浮窗。</p>
|
||||
<h1>FloatyWindow<span><a class="mark" href="#floaty_floatywindow" id="floaty_floatywindow">#</a></span></h1>
|
||||
<p>悬浮窗对象,可通过<code>FloatyWindow.{id}</code>获取悬浮窗界面上的元素。例如, 悬浮窗window上一个控件的id为aaa, 那么<code>window.aaa</code>即可获取到该控件,类似于ui。</p>
|
||||
<h2>FloatyWindow.setAdjustEnabled(enabled)<span><a class="mark" href="#floaty_floatywindow_setadjustenabled_enabled" id="floaty_floatywindow_setadjustenabled_enabled">#</a></span></h2>
|
||||
<h2>window.setAdjustEnabled(enabled)<span><a class="mark" href="#floaty_window_setadjustenabled_enabled" id="floaty_window_setadjustenabled_enabled">#</a></span></h2>
|
||||
<div class="signature"><ul>
|
||||
<li><code>enabled</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> 是否启用悬浮窗调整(大小、位置)</li>
|
||||
</ul>
|
||||
</div><p>如果enabled为true,则在悬浮窗左上角、右上角显示可供位置、大小调整的标示,就像控制台一样;
|
||||
如果enabled为false,则隐藏上述标示。</p>
|
||||
<h2>FloatyWindow.setPosition(x, y)<span><a class="mark" href="#floaty_floatywindow_setposition_x_y" id="floaty_floatywindow_setposition_x_y">#</a></span></h2>
|
||||
<h2>window.setPosition(x, y)<span><a class="mark" href="#floaty_window_setposition_x_y" id="floaty_window_setposition_x_y">#</a></span></h2>
|
||||
<div class="signature"><ul>
|
||||
<li><code>x</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> x</li>
|
||||
<li><code>x</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> y</li>
|
||||
</ul>
|
||||
</div><p>设置悬浮窗位置。</p>
|
||||
<h2>FloatyWindow.getX()<span><a class="mark" href="#floaty_floatywindow_getx" id="floaty_floatywindow_getx">#</a></span></h2>
|
||||
<h2>window.getX()<span><a class="mark" href="#floaty_window_getx" id="floaty_window_getx">#</a></span></h2>
|
||||
<p>返回悬浮窗位置的X坐标。</p>
|
||||
<h2>FloatyWindow.getY()<span><a class="mark" href="#floaty_floatywindow_gety" id="floaty_floatywindow_gety">#</a></span></h2>
|
||||
<h2>window.getY()<span><a class="mark" href="#floaty_window_gety" id="floaty_window_gety">#</a></span></h2>
|
||||
<p>返回悬浮窗位置的Y坐标。</p>
|
||||
<h2>FloatyWindow.setSize(width, height)<span><a class="mark" href="#floaty_floatywindow_setsize_width_height" id="floaty_floatywindow_setsize_width_height">#</a></span></h2>
|
||||
<h2>window.setSize(width, height)<span><a class="mark" href="#floaty_window_setsize_width_height" id="floaty_window_setsize_width_height">#</a></span></h2>
|
||||
<div class="signature"><ul>
|
||||
<li><code>width</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> 宽度</li>
|
||||
<li><code>height</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> 高度</li>
|
||||
</ul>
|
||||
</div><p>设置悬浮窗宽高。</p>
|
||||
<h2>FloatyWindow.getWidht()<span><a class="mark" href="#floaty_floatywindow_getwidht" id="floaty_floatywindow_getwidht">#</a></span></h2>
|
||||
<h2>window.getWidht()<span><a class="mark" href="#floaty_window_getwidht" id="floaty_window_getwidht">#</a></span></h2>
|
||||
<p>返回悬浮窗宽度。</p>
|
||||
<h2>FloatyWindow.getHeight()<span><a class="mark" href="#floaty_floatywindow_getheight" id="floaty_floatywindow_getheight">#</a></span></h2>
|
||||
<h2>window.getHeight()<span><a class="mark" href="#floaty_window_getheight" id="floaty_window_getheight">#</a></span></h2>
|
||||
<p>返回悬浮窗高度。</p>
|
||||
<h2>FloatyWindow.close()<span><a class="mark" href="#floaty_floatywindow_close" id="floaty_floatywindow_close">#</a></span></h2>
|
||||
<h2>window.close()<span><a class="mark" href="#floaty_window_close" id="floaty_window_close">#</a></span></h2>
|
||||
<p>关闭悬浮窗。如果悬浮窗已经是关闭状态,则此函数将不执行任何操作。</p>
|
||||
<p>被关闭后的悬浮窗不能再显示。</p>
|
||||
<h2>FloatyWindow.exitOnClose()<span><a class="mark" href="#floaty_floatywindow_exitonclose" id="floaty_floatywindow_exitonclose">#</a></span></h2>
|
||||
<h2>window.exitOnClose()<span><a class="mark" href="#floaty_window_exitonclose" id="floaty_window_exitonclose">#</a></span></h2>
|
||||
<p>使悬浮窗被关闭时自动结束脚本运行。</p>
|
||||
<h1>FloatyRawWindow<span><a class="mark" href="#floaty_floatyrawwindow" id="floaty_floatyrawwindow">#</a></span></h1>
|
||||
<p>原始悬浮窗对象,可通过<code>window.{id}</code>获取悬浮窗界面上的元素。例如, 悬浮窗window上一个控件的id为aaa, 那么<code>window.aaa</code>即可获取到该控件,类似于ui。</p>
|
||||
<h2>window.setTouchable(touchable)<span><a class="mark" href="#floaty_window_settouchable_touchable" id="floaty_window_settouchable_touchable">#</a></span></h2>
|
||||
<div class="signature"><ul>
|
||||
<li><code>touchable</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><Boolean></a> 是否可触摸</li>
|
||||
</ul>
|
||||
</div><p>设置悬浮窗是否可触摸,如果为true, 则悬浮窗将接收到触摸、点击等事件并且无法继续传递到悬浮窗下面;如果为false, 悬浮窗上的触摸、点击等事件将被直接传递到悬浮窗下面。处于安全考虑,被悬浮窗接收的触摸事情无法再继续传递到下层。</p>
|
||||
<p>可以用此特性来制作护眼模式脚本。</p>
|
||||
<pre><code>var w = floaty.rawWindow(
|
||||
<frame gravity="center" bg="#44ffcc00"/>
|
||||
);
|
||||
|
||||
w.setSize(-1, -1);
|
||||
w.setTouchable(false);
|
||||
|
||||
setTimeout(()=>{
|
||||
w.close();
|
||||
}, 4000);
|
||||
</code></pre><h2>window.setPosition(x, y)<span><a class="mark" href="#floaty_window_setposition_x_y_1" id="floaty_window_setposition_x_y_1">#</a></span></h2>
|
||||
<div class="signature"><ul>
|
||||
<li><code>x</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> x</li>
|
||||
<li><code>x</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> y</li>
|
||||
</ul>
|
||||
</div><p>设置悬浮窗位置。</p>
|
||||
<h2>window.getX()<span><a class="mark" href="#floaty_window_getx_1" id="floaty_window_getx_1">#</a></span></h2>
|
||||
<p>返回悬浮窗位置的X坐标。</p>
|
||||
<h2>window.getY()<span><a class="mark" href="#floaty_window_gety_1" id="floaty_window_gety_1">#</a></span></h2>
|
||||
<p>返回悬浮窗位置的Y坐标。</p>
|
||||
<h2>window.setSize(width, height)<span><a class="mark" href="#floaty_window_setsize_width_height_1" id="floaty_window_setsize_width_height_1">#</a></span></h2>
|
||||
<div class="signature"><ul>
|
||||
<li><code>width</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> 宽度</li>
|
||||
<li><code>height</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> 高度</li>
|
||||
</ul>
|
||||
</div><p>设置悬浮窗宽高。</p>
|
||||
<p>特别地,如果设置为-1,则为占满全屏;设置为-2则为根据悬浮窗内容大小而定。例如:</p>
|
||||
<pre><code>var w = floaty.rawWindow(
|
||||
<frame gravity="center" bg="#77ff0000">
|
||||
<text id="text">悬浮文字</text>
|
||||
</frame>
|
||||
);
|
||||
|
||||
w.setSize(-1, -1);
|
||||
|
||||
setTimeout(()=>{
|
||||
w.close();
|
||||
}, 2000);
|
||||
</code></pre><h2>window.getWidht()<span><a class="mark" href="#floaty_window_getwidht_1" id="floaty_window_getwidht_1">#</a></span></h2>
|
||||
<p>返回悬浮窗宽度。</p>
|
||||
<h2>window.getHeight()<span><a class="mark" href="#floaty_window_getheight_1" id="floaty_window_getheight_1">#</a></span></h2>
|
||||
<p>返回悬浮窗高度。</p>
|
||||
<h2>window.close()<span><a class="mark" href="#floaty_window_close_1" id="floaty_window_close_1">#</a></span></h2>
|
||||
<p>关闭悬浮窗。如果悬浮窗已经是关闭状态,则此函数将不执行任何操作。</p>
|
||||
<p>被关闭后的悬浮窗不能再显示。</p>
|
||||
<h2>window.exitOnClose()<span><a class="mark" href="#floaty_window_exitonclose_1" id="floaty_window_exitonclose_1">#</a></span></h2>
|
||||
<p>使悬浮窗被关闭时自动结束脚本运行。</p>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user