2021-03-07 05:58:59 +01:00

40 lines
24 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<head><meta charset="utf-8"/><link href="../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="http://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="http://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../jquery-1.9.1.min.js"></script><script src="../../bootstrap/js/bootstrap.min.js"></script><script src="../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../styles.css" rel="stylesheet"/><link href="../../haxe-nav.css" rel="stylesheet"/><script type="text/javascript">var dox = {rootPath: "../../",platforms: ["Neko","Android","Flash","iOS","macOS","Linux","HTML5","Windows"]};</script><script type="text/javascript" src="../../nav.js"></script><script type="text/javascript" src="../../index.js"></script><link rel="icon" href="../../favicon.ico" type="image/x-icon"></link><title>js.html.Range - API Reference</title><meta name="description" content="The &lt;code&gt;&lt;a href="../../js/html/Range.html"&gt;Range&lt;/a&gt;&lt;/code&gt; interface represents a fragment of a document that can contain nodes and parts of text nodes."/></head><body><style>
a, code .type {
color: #24afc4;
}
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
background: #24afc4;
color: #ffffff;
text-shadow: 0 0 0 transparent;
}
.navbar .container {
width: 940px ;
}
@media (max-width: 767px) {
.navbar .container {
width: auto;
}
}
@media (max-width: 979px) and (min-width: 768px) {
.navbar .container {
width: 724px;
}
}
@media (min-width: 1200px) {
.navbar .container {
width: 1170px;
}
}
.navbar .container img {
margin: 5px 0 0 4px;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="http://www.openfl.org"><img alt="" src="http://www.openfl.org/images/logo.png"/></a><a class="brand" style="color:#777777" href="../../">API Reference</a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="icon-search"></i></span><input id="search" type="text" placeholder="Search" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="true">All Platforms</option><option>Neko</option><option>Android</option><option>Flash</option><option>iOS</option><option>macOS</option><option>Linux</option><option>HTML5</option><option>Windows</option></select></div></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> Range</h1><h4><small>package <a href="../../js/html/index.html">js.html</a></small></h4> <p class="availability"><hr/><em>Available on HTML5</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p>The <code><a href="../../js/html/Range.html">Range</a></code> interface represents a fragment of a document that can contain nodes and parts of text nodes.</p>
<p>Documentation <a href="https://developer.mozilla.org/en-US/docs/Web/API/Range">Range</a> by <a href="https://developer.mozilla.org/en-US/docs/Web/API/Range$history">Mozilla Contributors</a>, licensed under <a href="https://creativecommons.org/licenses/by-sa/2.5/">CC-BY-SA 2.5</a>.</p><p class="javadoc">See:</p><div class="indent inline-content"><p><a href="https://developer.mozilla.org/en-US/docs/Web/API/Range">https://developer.mozilla.org/en-US/docs/Web/API/Range</a></p></div></div></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3><p><code><a href="#new"><span class="identifier">new</span></a> ()</code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="collapsed"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/Range.html#collapsed"><span class="identifier">collapsed</span></a>:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><div class="doc"><p>Returns a <code>Boolean</code> indicating whether the range's start and end points are at the same position.</p></div></div><div class="field "><a name="commonAncestorContainer"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/Range.html#commonAncestorContainer"><span class="identifier">commonAncestorContainer</span></a>:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></code></p></h3><div class="doc"><p>Returns the deepest <code><a href="../../js/html/Node.html">Node</a></code> that contains the <code>startContainer</code> and <code>endContainer</code> nodes.</p></div></div><div class="field "><a name="endContainer"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/Range.html#endContainer"><span class="identifier">endContainer</span></a>:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></code></p></h3><div class="doc"><p>Returns the <code><a href="../../js/html/Node.html">Node</a></code> within which the <code><a href="../../js/html/Range.html">Range</a></code> ends.</p></div></div><div class="field "><a name="endOffset"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/Range.html#endOffset"><span class="identifier">endOffset</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a></code></p></h3><div class="doc"><p>Returns a number representing where in the <code>endContainer</code> the <code><a href="../../js/html/Range.html">Range</a></code> ends.</p></div></div><div class="field "><a name="startContainer"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/Range.html#startContainer"><span class="identifier">startContainer</span></a>:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></code></p></h3><div class="doc"><p>Returns the <code><a href="../../js/html/Node.html">Node</a></code> within which the <code><a href="../../js/html/Range.html">Range</a></code> starts.</p></div></div><div class="field "><a name="startOffset"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/Range.html#startOffset"><span class="identifier">startOffset</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a></code></p></h3><div class="doc"><p>Returns a number representing where in the <code>startContainer</code> the <code><a href="../../js/html/Range.html">Range</a></code> starts.</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="cloneContents"></a><h3><p><code><a href="#cloneContents"><span class="identifier">cloneContents</span></a> ():<a class="type" title="The DocumentFragment interface represents a minimal document object that has no parent." href="../../js/html/DocumentFragment.html">DocumentFragment</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="cloneRange"></a><h3><p><code><a href="#cloneRange"><span class="identifier">cloneRange</span></a> ():<a class="type" title="The Range interface represents a fragment of a document that can contain nodes and parts of text nodes." href="../../js/html/Range.html">Range</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="collapse"></a><h3><p><code><a href="#collapse"><span class="identifier">collapse</span></a> (<span style="white-space:nowrap">toStart:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="compareBoundaryPoints"></a><h3><p><code><a href="#compareBoundaryPoints"><span class="identifier">compareBoundaryPoints</span></a> (<span style="white-space:nowrap">how:<a class="type" title="The standard Int type." href="../../Int.html">Int</a>,</span> <span style="white-space:nowrap">sourceRange:<a class="type" title="The Range interface represents a fragment of a document that can contain nodes and parts of text nodes." href="../../js/html/Range.html">Range</a></span>):<a class="type" title="The standard Int type." href="../../Int.html">Int</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="comparePoint"></a><h3><p><code><a href="#comparePoint"><span class="identifier">comparePoint</span></a> (<span style="white-space:nowrap">node:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a>,</span> <span style="white-space:nowrap">offset:<a class="type" title="The standard Int type." href="../../Int.html">Int</a></span>):<a class="type" title="The standard Int type." href="../../Int.html">Int</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="createContextualFragment"></a><h3><p><code><a href="#createContextualFragment"><span class="identifier">createContextualFragment</span></a> (<span style="white-space:nowrap">fragment:<a class="type" title="The basic String class." href="../../String.html">String</a></span>):<a class="type" title="The DocumentFragment interface represents a minimal document object that has no parent." href="../../js/html/DocumentFragment.html">DocumentFragment</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="deleteContents"></a><h3><p><code><a href="#deleteContents"><span class="identifier">deleteContents</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="detach"></a><h3><p><code><a href="#detach"><span class="identifier">detach</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="extractContents"></a><h3><p><code><a href="#extractContents"><span class="identifier">extractContents</span></a> ():<a class="type" title="The DocumentFragment interface represents a minimal document object that has no parent." href="../../js/html/DocumentFragment.html">DocumentFragment</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="getBoundingClientRect"></a><h3><p><code><a href="#getBoundingClientRect"><span class="identifier">getBoundingClientRect</span></a> ():<a class="type" title="A DOMRect represents a rectangle." href="../../js/html/DOMRect.html">DOMRect</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="getClientRects"></a><h3><p><code><a href="#getClientRects"><span class="identifier">getClientRects</span></a> ():<a class="type" title="" href="../../js/html/DOMRectList.html">DOMRectList</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="insertNode"></a><h3><p><code><a href="#insertNode"><span class="identifier">insertNode</span></a> (<span style="white-space:nowrap">node:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="intersectsNode"></a><h3><p><code><a href="#intersectsNode"><span class="identifier">intersectsNode</span></a> (<span style="white-space:nowrap">node:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="isPointInRange"></a><h3><p><code><a href="#isPointInRange"><span class="identifier">isPointInRange</span></a> (<span style="white-space:nowrap">node:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a>,</span> <span style="white-space:nowrap">offset:<a class="type" title="The standard Int type." href="../../Int.html">Int</a></span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="selectNode"></a><h3><p><code><a href="#selectNode"><span class="identifier">selectNode</span></a> (<span style="white-space:nowrap">refNode:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="selectNodeContents"></a><h3><p><code><a href="#selectNodeContents"><span class="identifier">selectNodeContents</span></a> (<span style="white-space:nowrap">refNode:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="setEnd"></a><h3><p><code><a href="#setEnd"><span class="identifier">setEnd</span></a> (<span style="white-space:nowrap">refNode:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a>,</span> <span style="white-space:nowrap">offset:<a class="type" title="The standard Int type." href="../../Int.html">Int</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="setEndAfter"></a><h3><p><code><a href="#setEndAfter"><span class="identifier">setEndAfter</span></a> (<span style="white-space:nowrap">refNode:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="setEndBefore"></a><h3><p><code><a href="#setEndBefore"><span class="identifier">setEndBefore</span></a> (<span style="white-space:nowrap">refNode:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="setStart"></a><h3><p><code><a href="#setStart"><span class="identifier">setStart</span></a> (<span style="white-space:nowrap">refNode:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a>,</span> <span style="white-space:nowrap">offset:<a class="type" title="The standard Int type." href="../../Int.html">Int</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="setStartAfter"></a><h3><p><code><a href="#setStartAfter"><span class="identifier">setStartAfter</span></a> (<span style="white-space:nowrap">refNode:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="setStartBefore"></a><h3><p><code><a href="#setStartBefore"><span class="identifier">setStartBefore</span></a> (<span style="white-space:nowrap">refNode:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="surroundContents"></a><h3><p><code><a href="#surroundContents"><span class="identifier">surroundContents</span></a> (<span style="white-space:nowrap">newParent:<a class="type" title="A Node is an interface from which a number of DOM types inherit, and allows these various types to be treated (or tested) similarly." href="../../js/html/Node.html">Node</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div></div><h3 class="section">Static variables</h3><div class="fields"><div class="field "><a name="END_TO_END"></a><h3><p><code><span class="label">static</span><span class="label">inline</span> <span class="label">read only</span><a href="../../js/html/Range.html#END_TO_END"><span class="identifier">END_TO_END</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a><span> = 2</span></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="END_TO_START"></a><h3><p><code><span class="label">static</span><span class="label">inline</span> <span class="label">read only</span><a href="../../js/html/Range.html#END_TO_START"><span class="identifier">END_TO_START</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a><span> = 3</span></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="START_TO_END"></a><h3><p><code><span class="label">static</span><span class="label">inline</span> <span class="label">read only</span><a href="../../js/html/Range.html#START_TO_END"><span class="identifier">START_TO_END</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a><span> = 1</span></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="START_TO_START"></a><h3><p><code><span class="label">static</span><span class="label">inline</span> <span class="label">read only</span><a href="../../js/html/Range.html#START_TO_START"><span class="identifier">START_TO_START</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a><span> = 0</span></code></p></h3><div class="doc"><p></p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">&copy; 2017 &nbsp;<a style="color:#777777" href="http://www.openfl.org">http://www.openfl.org</a></p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>