📄 bimovehandle.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><html><!--
Generated using api.website.xsl version 2003-07-17
-->
<head>
<META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>BiMoveHandle</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link type="text/css" rel="stylesheet" href="api.css"><script type="text/javascript">
function showDerivedClasses() {
var ul = document.getElementById("api-derived-classes");
var lis = ul.childNodes;
var l = lis.length;
for (var i = 1; i < l; i++)
lis[i].style.display = "";
lis[0].style.display = "none";
}
</script></head>
<body>
<h1 id="BiMoveHandle">BiMoveHandle</h1>
<p>
This component can be used to allow another component to become movable
using the mouse. The component can be used as a move handle for the
component to move. It can also be used without adding it to another
component by manually calling <code><a href="#startMove">startMove</a></code> in a mouse down
event handler.
</p>
<p>This class extends
<code><a href="BiComponent.html">BiComponent</a></code>
and therefore all methods and fields available for
<code><a href="BiComponent.html">BiComponent</a></code>
are also available for <code>BiMoveHandle</code>.</p>
<ul class="partial-class-tree">
<li><code><a href="BiObject.html">BiObject</a></code><ul>
<li><code><a href="BiEventTarget.html">BiEventTarget</a></code><ul><li><code><a href="BiComponent.html">BiComponent</a></code><ul><li><code>BiMoveHandle</code><ul id="api-derived-classes"></ul></li></ul></li></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiMoveHandle([<span class="methodArgument">oHandleFor</span>])</code></p>
<h3>Parameters</h3>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oHandleFor</code></td>
<td><code class="type"><code><a href="BiComponent.html">BiComponent</a></code></code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td></td>
<td>
The component that should be moveable.
</td>
</tr>
</tbody>
</table>
<h2>Properties</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="get-header">get</td>
<td class="set-header">set</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><a name="handleFor"></a><code>handleFor</code></td>
<td><code class="type"><code><a href="BiComponent.html">BiComponent</a></code></code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>
The component that the handle should be a move handle for.
</td>
</tr>
<tr>
<td><a name="moveDirection"></a><code>moveDirection</code></td>
<td><code class="type">String</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>
The direction the component can be moved. Possible values are:<br>
<br>
<code>vertical</code><br>
<code>horizontal</code><br>
<code>both</code>.
</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#startMove">startMove</a></code></td>
<td>Start the resizing of the component</td>
</tr>
</tbody>
</table>
<h2>Events</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="bubbles-header">Bubbles</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><a name="beforemove"></a><code>beforemove</code></td>
<td><code class="type"><code><a href="BiEvent.html">BiEvent</a></code></code></td>
<td class="bubbles-column"></td>
<td>
Fires continually during the moving of the component. Call
<code><a href="BiEvent.html#preventDefault">preventDefault</a></code>
on the event object to prevent the new location from being applied.
</td>
</tr>
<tr>
<td><a name="move"></a><code>move</code></td>
<td><code class="type"><code><a href="BiEvent.html">BiEvent</a></code></code></td>
<td class="bubbles-column"></td>
<td>
Fires continually during the moving of the component
</td>
</tr>
<tr>
<td><a name="moveend"></a><code>moveend</code></td>
<td><code class="type"><code><a href="BiEvent.html">BiEvent</a></code></code></td>
<td class="bubbles-column"></td>
<td>
This is fired when the movement is ended.
</td>
</tr>
<tr>
<td><a name="movestart"></a><code>movestart</code></td>
<td><code class="type"><code><a href="BiEvent.html">BiEvent</a></code></code></td>
<td class="bubbles-column"></td>
<td>
This is fired before the movement is started. To prevent this
from being moved call <code><a href="BiEvent.html#preventDefault">preventDefault</a></code>
on the event object.
</td>
</tr>
</tbody>
</table>
<h2>Static Methods</h2>
<p>None.</p>
<h2>Static Fields</h2>
<p>None.</p>
<h2>Remarks</h2>
<p>
When used in conjunction with <code><a href="#startMove">startMove</a></code> the component is
moved when the mouse is moved and the moving ends when the mouse up
event occurs. Therefore the logical place to call <code><a href="#startMove">startMove</a></code>
is inside an event handler for a <code><a href="BiComponent.html#mousedown">mousedown</a></code>
event.
</p>
<h2>Method Details</h2>
<h3><a name="startMove"></a>startMove</h3>
<p>Start the resizing of the component</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.startMove(<span class="methodArgument">oEvent</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oEvent</code></td>
<td><code class="type"><code><a href="BiMouseEvent.html">BiMouseEvent</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The event object used to
start the moving using the mouse</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -