js高级程序设计(十二)DOM2和DOM3
DOM 变化
“DOM2 级核心”没有引入新类型,它只是在DOM1 级的基础上通过增加新方法和新属性来增强了既有类型。“DOM3级核心”同样增强了既有类型,但也引入了一些新类型。
可以通过下列代码来确定浏览器是否支持这些DOM 模块。
var supportsDOM2Core = document.implementation.hasFeature("Core", "2.0"); var supportsDOM3Core = document.implementation.hasFeature("Core", "3.0"); var supportsDOM2HTML = document.implementation.hasFeature("HTML", "2.0"); var supportsDOM2Views = document.implementation.hasFeature("Views", "2.0"); var supportsDOM2XML = document.implementation.hasFeature("XML", "2.0");
针对XML命名空间的变化
有了XML 命名空间,不同XML 文档的元素就可以混合在一起,共同构成格式良好的文档,而不必担心发生命名冲突。从技术上说,HTML 不支持XML 命名空间,但XHTML 支持XML 命名空间。因此,本节给出的都是XHTML 的示例。
命名空间要使用xmlns 特性来指定。XHTML 的命名空间是http://www.w3.org/1999/xhtml,在任何格式良好XHTML 页面中,都应该将其包含在<html>元素中,如下面的例子所示。
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Example XHTML page</title>
</head>
<body>
Hello world!
</body>
</html>
对这个例子而言,其中的所有元素默认都被视为XHTML 命名空间中的元素。要想明确地为XML命名空间创建前缀,可以使用xmlns 后跟冒号,再后跟前缀
<xhtml:html xmlns:xhtml="http://www.w3.org/1999/xhtml">
<xhtml:head>
<xhtml:title>Example XHTML page</xhtml:title>
</xhtml:head>
<xhtml:body>
Hello world!
</xhtml:body>
</xhtml:html>
这里为XHTML 的命名空间定义了一个名为xhtml 的前缀,并要求所有XHTML 元素都以该前缀开头。有时候为了避免不同语言间的冲突,也需要使用命名空间来限定特性
<xhtml:html xmlns:xhtml="http://www.w3.org/1999/xhtml">
<xhtml:head>
<xhtml:title>Example XHTML page</xhtml:title>
</xhtml:head>
<xhtml:body xhtml:class="home">
Hello world!
</xhtml:body>
</xhtml:html>
这个例子中的特性class 带有一个xhtml 前缀。在只基于一种语言编写XML 文档的情况下,命名空间实际上也没有什么用。不过,在混合使用两种语言的情况下,命名空间的用处就非常大了。
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Example XHTML page</title>
</head>
<body>
<svg xmlns="http://www.w3.org/2000/svg" version="1.1"
viewBox="0 0 100 100" style="width:100%; height:100%">
<rect x="0" y="0" width="100" height="100" style="fill:red"/>
</svg>
</body>
</html>
在这个例子中,通过设置命名空间,将<svg>标识为了与包含文档无关的元素。此时,<svg>元素的所有子元素,以及这些元素的所有特性,都被认为属于http://www.w3.org/2000/svg 命名空间。即使这个文档从技术上说是一个XHTML文档,但因为有了命名空间,其中的SVG代码也仍然是有效的。
“DOM2 级核心”通过为大多数DOM1 级方法提供特定于命名空间的版本
1. Node 类型的变化
在DOM2 级中,Node 类型包含下列特定于命名空间的属性。
- localName:不带命名空间前缀的节点名称。
- namespaceURI:命名空间URI 或者(在未指定的情况下是)null。
- prefix:命名空间前缀或者(在未指定的情况下是)null。
当节点使用了命名空间前缀时,其nodeName 等于prefix+":"+ localName。
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Example XHTML page</title>
</head>
<body>
<s:svg xmlns:s="http://www.w3.org/2000/svg" version="1.1"
viewBox="0 0 100 100" style="width:100%; height:100%">
<s:rect x="0" y="0" width="100" height="100" style="fill:red"/>
</s:svg>
</body>
</html>
对于<html>元素来说,它的localName 和tagName 是"html",namespaceURI 是"http://www.w3.org/1999/xhtml",而prefix 是null。对于<s:svg>元素而言,它的localName 是"svg",tagName 是"s:svg",namespaceURI 是"http://www.w3.org/2000/svg",而prefix 是"s"。
DOM3 级在此基础上更进一步,又引入了下列与命名空间有关的方法。
-
isDefaultNamespace(namespaceURI):在指定的namespaceURI 是当前节点的默认命名空间的情况下返回true。
- lookupNamespaceURI(prefix):返回给定prefix 的命名空间。
- lookupPrefix(namespaceURI):返回给定namespaceURI 的前缀。
alert(document.body.isDefaultNamespace("http://www.w3.org/1999/xhtml"); //true //假设svg 中包含着对<s:svg>的引用 alert(svg.lookupPrefix("http://www.w3.org/2000/svg")); //"s" alert(svg.lookupNamespaceURI("s")); //"http://www.w3.org/2000/svg"
2. Document 类型的变化
DOM2 级中的Document 类型也发生了变化,包含了下列与命名空间有关的方法。
-
createElementNS(namespaceURI, tagName):使用给定的tagName 创建一个属于命名空间namespaceURI 的新元素。
-
createAttributeNS(namespaceURI, attributeName):使用给定的attributeName 创建一个属于命名空间namespaceURI 的新特性。
-
getElementsByTagNameNS(namespaceURI, tagName):返回属于命名空间namespaceURI的tagName 元素的NodeList。
使用这些方法时需要传入表示命名空间的URI(而不是命名空间前缀)
//创建一个新的SVG 元素 var svg = document.createElementNS("http://www.w3.org/2000/svg","svg"); //创建一个属于某个命名空间的新特性 var att = document.createAttributeNS("http://www.somewhere.com", "random"); //取得所有XHTML 元素 var elems = document.getElementsByTagNameNS("http://www.w3.org/1999/xhtml", "*");
只有在文档中存在两个或多个命名空间时,这些与命名空间有关的方法才是必需的。
3. Element 类型的变化
“DOM2 级核心”中有关Element 的变化,主要涉及操作特性。
-
getAttributeNS(namespaceURI,localName):取得属于命名空间namespaceURI 且名为localName 的特性。
-
getAttributeNodeNS(namespaceURI,localName):取得属于命名空间namespaceURI 且名为localName 的特性节点。
-
getElementsByTagNameNS(namespaceURI, tagName):返回属于命名空间namespaceURI的tagName 元素的NodeList。
-
hasAttributeNS(namespaceURI,localName):确定当前元素是否有一个名为localName的特性,而且该特性的命名空间是namespaceURI。注意,“DOM2 级核心”也增加了一个hasAttribute()方法,用于不考虑命名空间的情况。
-
removeAttriubteNS(namespaceURI,localName):删除属于命名空间namespaceURI 且名为localName 的特性。
-
setAttributeNS(namespaceURI,qualifiedName,value):设置属于命名空间namespace-URI 且名为qualifiedName 的特性的值为value。
- setAttributeNodeNS(attNode):设置属于命名空间namespaceURI 的特性节点。
4. NamedNodeMap 类型的变化
NamedNodeMap 类型也新增了下列与命名空间有关的方法。由于特性是通过NamedNodeMap 表示的,因此这些方法多数情况下只针对特性使用。
-
getNamedItemNS(namespaceURI,localName):取得属于命名空间namespaceURI 且名为localName 的项。
-
removeNamedItemNS(namespaceURI,localName):移除属于命名空间namespaceURI 且名为localName 的项。
- setNamedItemNS(node):添加node,这个节点已经事先指定了命名空间信息。
其他方面的变化
1. DocumentType 类型的变化
DocumentType 类型新增了3 个属性:publicId、systemId 和internalSubset。其中,前两个属性表示的是文档类型声明中的两个信息段,这两个信息段在DOM1 级中是没有办法访问到的。
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
对这个文档类型声明而言,publicId 是"-//W3C//DTD HTML 4.01//EN",而systemId 是"http://www.w3.org/TR/html4/strict.dtd"。在支持DOM2 级的浏览器中,应该可以运行下列代码。
alert(document.doctype.publicId);
alert(document.doctype.systemId);
实际上,很少需要在网页中访问此类信息。
最后一个属性internalSubset,用于访问包含在文档类型声明中的额外定义
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
[<!ELEMENT name (#PCDATA)>] >
访问document.doctype.internalSubset 将得到"<!ELEMENT name (#PCDATA)>"。这种内部子集(internal subset)在HTML 中极少用到,在XML 中可能会更常见一些。
2. Document 类型的变化
Document 类型的变化中唯一与命名空间无关的方法是importNode()。这个方法的用途是从一个文档中取得一个节点,然后将其导入到另一个文档,使其成为这个文档结构的一部分。需要注意的是,每个节点都有一个ownerDocument 属性,表示所属的文档。如果调用appendChild()时传入的节点属于不同的文档(ownerDocument 属性的值不一样),则会导致错误。但在调用importNode()时传入不同文档的节点则会返回一个新节点,这个新节点的所有权归当前文档所有。
importNode()方法与Element 的cloneNode()方法非常相似,它接受两个参数:要复制的节点和一个表示是否复制子节点的布尔值。返回的结果是原来节点的副本,但能够在当前文档中使用。
var newNode = document.importNode(oldNode, true); //导入节点及其所有子节点 document.body.appendChild(newNode);
这个方法在HTML 文档中并不常用,在XML 文档中用得比较多。
“DOM2 级视图”模块添加了一个名为defaultView 的属性,其中保存着一个指针,指向拥有给定文档的窗口(或框架)。除此之外,“视图”规范没有提供什么时候其他视图可用的信息,因而这是唯一一个新增的属性。除IE 之外的所有浏览器都支持defaultView 属性。在IE 中有一个等价的属性名叫parentWindow(Opera 也支持这个属性)。因此,要确定文档的归属窗口,可以使用以下代码。
var parentWindow = document.defaultView || document.parentWindow;
除了上述一个方法和一个属性之外,“DOM2 级核心”还为document.implementation 对象规定了两个新方法:createDocumentType()和createDocument()。前者用于创建一个新的DocumentType节点,接受3 个参数:文档类型名称、publicId、systemId。例如,下列代码会创建一个新的HTML4.01 Strict 文档类型。
var doctype = document.implementation.createDocumentType("html", "-//W3C//DTD HTML 4.01//EN", "http://www.w3.org/TR/html4/strict.dtd");
由于既有文档的文档类型不能改变,因此createDocumentType()只在创建新文档时有用;创建新文档时需要用到createDocument()方法。这个方法接受3 个参数:针对文档中元素的namespaceURI、文档元素的标签名、新文档的文档类型。下面这行代码将会创建一个空的新XML 文档。
var doc = document.implementation.createDocument("", "root", null);
这行代码会创建一个没有命名空间的新文档,文档元素为<root>,而且没有指定文档类型。要想创建一个XHTML 文档,可以使用以下代码。
var doctype = document.implementation.createDocumentType("html", " -//W3C//DTD XHTML 1.0 Strict//EN", "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"); var doc = document.implementation.createDocument("http://www.w3.org/1999/xhtml", "html", doctype);
这样,就创建了一个带有适当命名空间和文档类型的新XHTML 文档。不过,新文档当前只有文档元素<html>,剩下的所有元素都需要继续添加。
“DOM2 级HTML”模块也为document.implementation 新增了一个方法,名叫createHTMLDocument()。这个方法的用途是创建一个完整的HTML 文档,包括<html>、<head>、<title>和<body>元素。这个方法只接受一个参数,即新创建文档的标题(放在<title>元素中的字符串),返回新的HTML 文档。
var htmldoc = document.implementation.createHTMLDocument("New Doc"); alert(htmldoc.title); //"New Doc" alert(typeof htmldoc.body); //"object"
通过调用createHTMLDocument()创建的这个文档,是HTMLDocument 类型的实例,因而具有该类型的所有属性和方法,包括title 和body 属性。只有Opera 和Safari 支持这个方法。
3. Node 类型的变化
Node 类型中唯一与命名空间无关的变化,就是添加了isSupported()方法。与DOM1级为document.implementation 引入的hasFeature()方法类似,isSupported()方法用于确定当前节点具有什么能力。这个方法也接受相同的两个参数:特性名和特性版本号。如果浏览器实现了相应特性,而且能够基于给定节点执行该特性,isSupported()就返回true。
if (document.body.isSupported("HTML", "2.0")){ //执行只有"DOM2 级HTML"才支持的操作 }
由于不同实现在决定对什么特性返回true 或false 时并不一致,这个方法同样也存在与hasFeature()方法相同的问题。为此,我们建议在确定某个特性是否可用时,最好还是使用能力检测。
DOM3 级引入了两个辅助比较节点的方法:isSameNode()和isEqualNode()。这两个方法都接受一个节点参数,并在传入节点与引用的节点相同或相等时返回true。所谓相同,指的是两个节点引用的是同一个对象。所谓相等,指的是两个节点是相同的类型,具有相等的属性(nodeName、nodeValue,等等),而且它们的attributes 和childNodes 属性也相等(相同位置包含相同的值)。
var div1 = document.createElement("div"); div1.setAttribute("class", "box");
var div2 = document.createElement("div"); div2.setAttribute("class", "box");
alert(div1.isSameNode(div1)); //true alert(div1.isEqualNode(div2)); //true alert(div1.isSameNode(div2)); //false
这里创建了两个具有相同特性的<div>元素。这两个元素相等,但不相同。
DOM3 级还针对为DOM 节点添加额外数据引入了新方法。setUserData()方法会将数据指定给节点,它接受3 个参数:要设置的键、实际的数据(可以是任何数据类型)和处理函数。
document.body.setUserData("name", "Nicholas", function(){});
然后,使用getUserData()并传入相同的键,就可以取得该数据
var value = document.body.getUserData("name");
传入setUserData()中的处理函数会在带有数据的节点被复制、删除、重命名或引入一个文档时调用,因而你可以事先决定在上述操作发生时如何处理用户数据。处理函数接受5 个参数:表示操作类型的数值(1 表示复制,2 表示导入,3 表示删除,4 表示重命名)、数据键、数据值、源节点和目标节点。在删除节点时,源节点是null;除在复制节点时,目标节点均为null。在函数内部,你可以决定如何存储数据。
var div = document.createElement("div"); div.setUserData("name", "Nicholas", function(operation, key, value, src, dest){ if (operation == 1){ dest.setUserData(key, value, function(){});
} });
var newDiv = div.cloneNode(true); alert(newDiv.getUserData("name")); //"Nicholas"
这里,先创建了一个<div>元素,然后又为它添加了一些数据(用户数据)。在使用cloneNode()复制这个元素时,就会调用处理函数,从而将数据自动复制到了副本节点。结果在通过副本节点调用getUserData()时,就会返回与原始节点中包含的相同的值。
4. 框架的变化
框架和内嵌框架分别用HTMLFrameElement 和HTMLIFrameElement 表示,它们在DOM2级中都有了一个新属性,名叫contentDocument。这个属性包含一个指针,指向表示框架内容的文档对象。在此之前,无法直接通过元素取得这个文档对象(只能使用frames 集合)。可以像下面这样使用这个属性。
var iframe = document.getElementById("myIframe"); var iframeDoc = iframe.contentDocument; //在IE8 以前的版本中无效
由于contentDocument 属性是Document 类型的实例,因此可以像使用其他HTML 文档一样使用它,包括所有属性和方法。Opera、Firefox、Safari 和Chrome 支持这个属性。IE8 之前不支持框架中的contentDocument 属性,但支持一个名叫contentWindow 的属性,该属性返回框架的window 对象,而这个window 对象又有一个document 属性。因此,要想在上述所有浏览器中访问内嵌框架的文档对象,可以使用下列代码。
var iframe = document.getElementById("myIframe"); var iframeDoc = iframe.contentDocument || iframe.contentWindow.document;
所有浏览器都支持contentWindow 属性。
样式
在HTML 中定义样式的方式有3 种:通过<link/>元素包含外部样式表文件、使用<style/>元素定义嵌入式样式,以及使用style 特性定义针对特定元素的样式。“DOM2 级样式”模块围绕这3 种应用样式的机制提供了一套API。要确定浏览器是否支持DOM2 级定义的CSS 能力,可以使用下列代码。
var supportsDOM2CSS = document.implementation.hasFeature("CSS", "2.0"); var supportsDOM2CSS2 = document.implementation.hasFeature("CSS2", "2.0");
访问元素的样式
任何支持style 特性的HTML 元素在JavaScript 中都有一个对应的style 属性。这个style 对象是CSSStyleDeclaration 的实例,包含着通过HTML 的style 特性指定的所有样式信息,但不包含与外部样式表或嵌入样式表经层叠而来的样式。在style 特性中指定的任何CSS 属性都将表现为这个style 对象的相应属性。对于使用短划线(分隔不同的词汇,例如background-image)的CSS 属性名,必须将其转换成驼峰大小写形式,才能通过JavaScript 来访问。下表列出了几个常见的CSS 属性及其在style 对象中对应的属性名。
多数情况下,都可以通过简单地转换属性名的格式来实现转换。其中一个不能直接转换的CSS 属性就是float。由于float 是JavaScript 中的保留字,因此不能用作属性名。“DOM2 级样式”规范规定样式对象上相应的属性名应该是cssFloat;Firefox、Safari、Opera 和Chrome 都支持这个属性,而IE支持的则是styleFloat。
只要取得一个有效的DOM元素的引用,就可以随时使用JavaScript 为其设置样式。
var myDiv = document.getElementById("myDiv"); //设置背景颜色 myDiv.style.backgroundColor = "red"; //改变大小 myDiv.style.width = "100px"; myDiv.style.height = "200px"; //指定边框 myDiv.style.border = "1px solid black";
通过style 对象同样可以取得在style 特性中指定的样式。
<div id="myDiv" style="background-color:blue; width:10px; height:25px"></div> alert(myDiv.style.backgroundColor); //"blue" alert(myDiv.style.width); //"10px" alert(myDiv.style.height); //"25px"
1. DOM 样式属性和方法
“DOM2级样式”规范还为style 对象定义了一些属性和方法。这些属性和方法在提供元素的style特性值的同时,也可以修改样式。
- cssText:如前所述,通过它能够访问到style 特性中的CSS 代码。
- length:应用给元素的CSS 属性的数量。
- parentRule:表示CSS 信息的CSSRule 对象。本节后面将讨论CSSRule 类型。
- getPropertyCSSValue(propertyName):返回包含给定属性值的CSSValue 对象。
-
getPropertyPriority(propertyName):如果给定的属性使用了!important 设置,则返回"important";否则,返回空字符串。
- getPropertyValue(propertyName):返回给定属性的字符串值。
- item(index):返回给定位置的CSS 属性的名称。
- removeProperty(propertyName):从样式中删除给定属性。
-
setProperty(propertyName,value,priority):将给定属性设置为相应的值,并加上优先权标志("important"或者一个空字符串)。
通过cssText 属性可以访问style 特性中的CSS代码。在读取模式下,cssText 返回浏览器对style特性中CSS 代码的内部表示。在写入模式下,赋给cssText 的值会重写整个style 特性的值;也就是说,以前通过style 特性指定的样式信息都将丢失。
myDiv.style.cssText = "width: 25px; height: 100px; background-color: green";
alert(myDiv.style.cssText);
设计length 属性的目的,就是将其与item()方法配套使用,以便迭代在元素中定义的CSS 属性。在使用length 和item()时,style 对象实际上就相当于一个集合,都可以使用方括号语法来代替item()来取得给定位置的CSS 属性。
for (var i=0, len=myDiv.style.length; i < len; i++){ alert(myDiv.style[i]); //或者myDiv.style.item(i) }
无论是使用方括号语法还是使用item()方法,都可以取得CSS 属性名("background-color",不是"backgroundColor")。然后,就可以在getPropertyValue()中使用取得的属性名进一步取得属性的值。
var prop, value, i, len; for (i=0, len=myDiv.style.length; i < len; i++){ prop = myDiv.style[i]; //或者 myDiv.style.item(i) value = myDiv.style.getPropertyValue(prop); alert(prop + " : " + value); }
getPropertyValue()方法取得的始终都是CSS 属性值的字符串表示。如果你需要更多信息,可以使用getPropertyCSSValue()方法,它返回一个包含两个属性的CSSValue 对象,这两个属性分别是:cssText 和cssValueType。其中,cssText 属性的值与getPropertyValue()返回的值相同,而cssValueType 属性则是一个数值常量,表示值的类型:0 表示继承的值,1 表示基本的值,2 表示值列表,3 表示自定义的值。
var prop, value, i, len; for (i=0, len=myDiv.style.length; i < len; i++){ prop = myDiv.style[i]; //或者myDiv.style.item(i) value = myDiv.style.getPropertyCSSValue(prop); alert(prop + " : " + value.cssText + " (" + value.cssValueType + ")"); }
在实际开发中,getPropertyCSSValue()使用得比getPropertyValue()少得多。IE9+、Safarie3+以及Chrome 支持这个方法。Firefox 7 及之前版本也提供这个访问,但调用总返回null。
要从元素的样式中移除某个CSS 属性,需要使用removeProperty()方法。使用这个方法移除一个属性,意味着将会为该属性应用默认的样式(从其他样式表经层叠而来)。例如,要移除通过style特性设置的 border 属性,可以使用下面的代码。
myDiv.style.removeProperty("border");
在不确定某个给定的CSS 属性拥有什么默认值的情况下,就可以使用这个方法。只要移除相应的属性,就可以为元素应用默认值。
除非另有说明,本节讨论的属性和方法都得到了IE9+、Firefox、Safari、Opera 9+以及Chrome 的支持。
2. 计算的样式
虽然style 对象能够提供支持style 特性的任何元素的样式信息,但它不包含那些从其他样式表层叠而来并影响到当前元素的样式信息。“DOM2 级样式”增强了document.defaultView,提供了getComputedStyle()方法。这个方法接受两个参数:要取得计算样式的元素和一个伪元素字符串(例如":after")。如果不需要伪元素信息,第二个参数可以是null。getComputedStyle()方法返回一个CSSStyleDeclaration 对象(与style 属性的类型相同),其中包含当前元素的所有计算的样式。
<!DOCTYPE html> <html> <head> <title>Computed Styles Example</title> <style type="text/css"> #myDiv { background-color: blue; width: 100px; height: 200px; } </style> </head> <body> <div id="myDiv" style="background-color: red; border: 1px solid black"></div> </body> </html> var myDiv = document.getElementById("myDiv"); var computedStyle = document.defaultView.getComputedStyle(myDiv, null); alert(computedStyle.backgroundColor); // "red" alert(computedStyle.width); // "100px" alert(computedStyle.height); // "200px" alert(computedStyle.border); // 在某些浏览器中是"1px solid black"
IE 不支持getComputedStyle()方法,但它有一种类似的概念。在IE 中,每个具有style 属性的元素还有一个currentStyle 属性。这个属性是CSSStyleDeclaration 的实例,包含当前元素全部计算后的样式。
var myDiv = document.getElementById("myDiv"); var computedStyle = myDiv.currentStyle; alert(computedStyle.backgroundColor); //"red" alert(computedStyle.width); //"100px" alert(computedStyle.height); //"200px" alert(computedStyle.border); //undefined
无论在哪个浏览器中,最重要的一条是要记住所有计算的样式都是只读的;不能修改计算后样式对象中的CSS 属性。此外,计算后的样式也包含属于浏览器内部样式表的样式信息,因此任何具有默认值的CSS 属性都会表现在计算后的样式中。
操作样式表
CSSStyleSheet 类型表示的是样式表,包括通过<link>元素包含的样式表和在<style>元素中定义的样式表。有读者可能记得,这两个元素本身分别是由HTMLLinkElement 和HTMLStyleElement 类型表示的。但是,CSSStyleSheet 类型相对更加通用一些,它只表示样式表,而不管这些样式表在HTML中是如何定义的。此外,上述两个针对元素的类型允许修改HTML 特性,但CSSStyleSheet 对象则是一套只读的接口(有一个属性例外)。使用下面的代码可以确定浏览器是否支持DOM2 级样式表。
var supportsDOM2StyleSheets = document.implementation.hasFeature("StyleSheets", "2.0");
CSSStyleSheet 继承自StyleSheet,后者可以作为一个基础接口来定义非CSS 样式表。从StyleSheet 接口继承而来的属性如下。
-
disabled:表示样式表是否被禁用的布尔值。这个属性是可读/写的,将这个值设置为true 可以禁用样式表。
- href:如果样式表是通过<link>包含的,则是样式表的URL;否则,是null。
-
media:当前样式表支持的所有媒体类型的集合。与所有DOM 集合一样,这个集合也有一个length 属性和一个item()方法。也可以使用方括号语法取得集合中特定的项。如果集合是空列表,表示样式表适用于所有媒体。在IE 中,media 是一个反映<link>和<style>元素media特性值的字符串。
-
ownerNode:指向拥有当前样式表的节点的指针,样式表可能是在HTML 中通过<link>或<style/>引入的(在XML 中可能是通过处理指令引入的)。如果当前样式表是其他样式表通过@import 导入的,则这个属性值为null。IE 不支持这个属性。
-
parentStyleSheet:在当前样式表是通过@import 导入的情况下,这个属性是一个指向导入它的样式表的指针。
- title:ownerNode 中title 属性的值。
- type:表示样式表类型的字符串。对CSS 样式表而言,这个字符串是"type/css"。
除了disabled 属性之外,其他属性都是只读的。在支持以上所有这些属性的基础上,CSSStyleSheet 类型还支持下列属性和方法:
- cssRules:样式表中包含的样式规则的集合。IE 不支持这个属性,但有一个类似的rules 属性。
-
ownerRule:如果样式表是通过@import 导入的,这个属性就是一个指针,指向表示导入的规则;否则,值为null。IE 不支持这个属性。
-
deleteRule(index):删除cssRules 集合中指定位置的规则。IE 不支持这个方法,但支持一个类似的removeRule()方法。
-
insertRule(rule,index):向cssRules 集合中指定的位置插入rule 字符串。IE 不支持这个方法,但支持一个类似的addRule()方法。
应用于文档的所有样式表是通过document.styleSheets 集合来表示的。通过这个集合的length属性可以获知文档中样式表的数量,而通过方括号语法或item()方法可以访问每一个样式表。
var sheet = null; for (var i=0, len=document.styleSheets.length; i < len; i++){ sheet = document.styleSheets[i]; alert(sheet.href); }
以上代码可以输出文档中使用的每一个样式表的href 属性(<style>元素包含的样式表没有href 属性)。
不同浏览器的document.styleSheets 返回的样式表也不同。所有浏览器都会包含<style>元素和rel 特性被设置为"stylesheet"的<link>元素引入的样式表。IE 和Opera 也包含rel 特性被设置为"alternate stylesheet"的<link>元素引入的样式表。
也可以直接通过<link>或<style>元素取得CSSStyleSheet 对象。DOM 规定了一个包含CSSStyleSheet 对象的属性,名叫sheet;除了IE,其他浏览器都支持这个属性。IE 支持的是styleSheet 属性。要想在不同浏览器中都能取得样式表对象,可以使用下列代码。
function getStyleSheet(element){ return element.sheet || element.styleSheet; } //取得第一个<link/>元素引入的样式表 var link = document.getElementsByTagName("link")[0]; var sheet = getStylesheet(link);
这里的getStyleSheet()返回的样式表对象与document.styleSheets 集合中的样式表对象相同。
1. CSS 规则
CSSRule 对象表示样式表中的每一条规则。实际上,CSSRule 是一个供其他多种类型继承的基类型,其中最常见的就是CSSStyleRule 类型,表示样式信息(其他规则还有@import、@font-face、@page 和@charset,但这些规则很少有必要通过脚本来访问)。CSSStyleRule 对象包含下列属性。
-
cssText:返回整条规则对应的文本。由于浏览器对样式表的内部处理方式不同,返回的文本可能会与样式表中实际的文本不一样;Safari 始终都会将文本转换成全部小写。IE 不支持这个属性。
-
parentRule:如果当前规则是导入的规则,这个属性引用的就是导入规则;否则,这个值为null。IE 不支持这个属性。
- parentStyleSheet:当前规则所属的样式表。IE 不支持这个属性。
-
selectorText:返回当前规则的选择符文本。由于浏览器对样式表的内部处理方式不同,返回的文本可能会与样式表中实际的文本不一样(例如,Safari 3 之前的版本始终会将文本转换成全部小写)。在Firefox、Safari、Chrome 和IE 中这个属性是只读的。Opera 允许修改selectorText。
- style:一个CSSStyleDeclaration 对象,可以通过它设置和取得规则中特定的样式值。
- type:表示规则类型的常量值。对于样式规则,这个值是1。IE 不支持这个属性。
其中三个最常用的属性是cssText、selectorText 和style。cssText 属性与style.cssText属性类似,但并不相同。前者包含选择符文本和围绕样式信息的花括号,后者只包含样式信息(类似于元素的style.cssText)。此外,cssText 是只读的,而style.cssText 也可以被重写。
大多数情况下,仅使用style 属性就可以满足所有操作样式规则的需求了。这个对象就像每个元素上的style 属性一样,可以通过它读取和修改规则中的样式信息。
div.box { background-color: blue; width: 100px; height: 200px; } var sheet = document.styleSheets[0]; var rules = sheet.cssRules || sheet.rules; //取得规则列表 var rule = rules[0]; //取得第一条规则 alert(rule.selectorText); //"div.box" alert(rule.style.cssText); //完整的CSS 代码 alert(rule.style.backgroundColor); //"blue" alert(rule.style.width); //"100px" alert(rule.style.height); //"200px"
与使用元素的方式一样,在这种方式下也可以修改样式信息
var sheet = document.styleSheets[0]; var rules = sheet.cssRules || sheet.rules; //取得规则列表 var rule = rules[0]; //取得第一条规则 rule.style.backgroundColor = "red"
2. 创建规则
DOM 规定,要向现有样式表中添加新规则,需要使用insertRule()方法。这个方法接受两个参数:规则文本和表示在哪里插入规则的索引。
sheet.insertRule("body { background-color: silver }", 0); //DOM 方法
Firefox、Safari、Opera 和Chrome都支持insertRule()方法。
IE8 及更早版本支持一个类似的方法,名叫addRule(),也接收两必选参数:选择符文本和CSS样式信息;一个可选参数:插入规则的位置。
sheet.addRule("body", "background-color: silver", 0); //仅对IE 有效
要以跨浏览器的方式向样式表中插入规则,可以使用下面的函数。这个函数接受4 个参数:要向其中添加规则的样式表以及与addRule()相同的3 个参数
function insertRule(sheet, selectorText, cssText, position){ if (sheet.insertRule){ sheet.insertRule(selectorText + "{" + cssText + "}", position); } else if (sheet.addRule){ sheet.addRule(selectorText, cssText, position); } }
insertRule(document.styleSheets[0], "body", "background-color: silver", 0);
3. 删除规则
从样式表中删除规则的方法是deleteRule(),这个方法接受一个参数:要删除的规则的位置。
sheet.deleteRule(0); //DOM 方法
IE 支持的类似方法叫removeRule(),使用方法相同
sheet.removeRule(0); //仅对IE 有效
下面是一个能够跨浏览器删除规则的函数。
function deleteRule(sheet, index){ if (sheet.deleteRule){ sheet.deleteRule(index); } else if (sheet.removeRule){ sheet.removeRule(index); } } deleteRule(document.styleSheets[0], 0);
元素大小
DOM中没有规定如何确定页面中元素的大小。IE 为此率先引入了一些属性,以便开发人员使用。目前,所有主要的浏览器都已经支持这些属性。
1. 偏移量
元素的可见大小由其高度、宽度决定,包括所有内边距、滚动条和边框大小(注意,不包括外边距)。
-
offsetHeight:元素在垂直方向上占用的空间大小,以像素计。包括元素的高度、(可见的)水平滚动条的高度、上边框高度和下边框高度。
-
offsetWidth:元素在水平方向上占用的空间大小,以像素计。包括元素的宽度、(可见的)垂直滚动条的宽度、左边框宽度和右边框宽度。
- offsetLeft:元素的左外边框至包含元素的左内边框之间的像素距离。
- offsetTop:元素的上外边框至包含元素的上内边框之间的像素距离。
offsetLeft 和offsetTop 属性与包含元素有关,包含元素的引用保存在offsetParent属性中。offsetParent 属性不一定与parentNode 的值相等。例如,<td>元素的offsetParent 是作为其祖先元素的<table>元素,因为<table>是在DOM层次中距<td>最近的一个具有大小的元素。
要想知道某个元素在页面上的偏移量,将这个元素的offsetLeft 和offsetTop 与其offsetParent的相同属性相加,如此循环直至根元素,就可以得到一个基本准确的值。以下两个函数就可以用于分别取得元素的左和上偏移量。
function getElementLeft(element){ var actualLeft = element.offsetLeft; var current = element.offsetParent; while (current !== null){ actualLeft += current.offsetLeft; current = current.offsetParent; } return actualLeft; } function getElementTop(element){ var actualTop = element.offsetTop; var current = element.offsetParent; while (current !== null){ actualTop += current. offsetTop; current = current.offsetParent; } return actualTop; }
2. 客户区大小
元素的客户区大小(client dimension),指的是元素内容及其内边距所占据的空间大小。有关客户区大小的属性有两个:clientWidth 和clientHeight。其中,clientWidth 属性是元素内容区宽度加上左右内边距宽度;clientHeight 属性是元素内容区高度加上上下内边距高度。
从字面上看,客户区大小就是元素内部的空间大小,因此滚动条占用的空间不计算在内。最常用到这些属性的情况,就是像第8 章讨论的确定浏览器视口大小的时候。如下面的例子所示,要确定浏览器视口大小,可以使用document.documentElement 或document.body(在IE7 之前的版本中)的clientWidth 和clientHeight。
function getViewport(){ if (document.compatMode == "BackCompat"){ return { width: document.body.clientWidth, height: document.body.clientHeight }; } else { return { width: document.documentElement.clientWidth, height: document.documentElement.clientHeight }; } }
3. 滚动大小
- scrollHeight:在没有滚动条的情况下,元素内容的总高度。
- scrollWidth:在没有滚动条的情况下,元素内容的总宽度。
- scrollLeft:被隐藏在内容区域左侧的像素数。通过设置这个属性可以改变元素的滚动位置。
- scrollTop:被隐藏在内容区域上方的像素数。通过设置这个属性可以改变元素的滚动位置。
scrollWidth 和scrollHeight 主要用于确定元素内容的实际大小。通常认为<html>元素是在Web 浏览器的视口中滚动的元素(IE6 之前版本运行在混杂模式下时是<body>元素)。因此,带有垂直滚动条的页面总高度就是document.documentElement.scrollHeight。
对于不包含滚动条的页面而言, scrollWidth 和scrollHeight 与clientWidth 和clientHeight 之间的关系并不十分清晰。在这种情况下,基于document.documentElement 查看这些属性会在不同浏览器间发现一些不一致性问题。
-
Firefox 中这两组属性始终都是相等的,但大小代表的是文档内容区域的实际尺寸,而非视口的尺寸。
-
Opera、Safari 3.1 及更高版本、Chrome 中的这两组属性是有差别的,其中scrollWidth 和scrollHeight 等于视口大小,而clientWidth 和clientHeight 等于文档内容区域的大小。
-
IE(在标准模式)中的这两组属性不相等,其中scrollWidth 和scrollHeight 等于文档内容区域的大小,而clientWidth 和clientHeight 等于视口大小。
在确定文档的总高度时(包括基于视口的最小高度时),必须取得scrollWidth/clientWidth 和scrollHeight/clientHeight 中的最大值,才能保证在跨浏览器的环境下得到精确的结果。下面就是这样一个例子。
var docHeight = Math.max(document.documentElement.scrollHeight, document.documentElement.clientHeight); var docWidth = Math.max(document.documentElement.scrollWidth, document.documentElement.clientWidth);
通过scrollLeft 和scrollTop 属性既可以确定元素当前滚动的状态,也可以设置元素的滚动位置。在元素尚未被滚动时,这两个属性的值都等于0。如果元素被垂直滚动了,那么scrollTop 的值会大于0,且表示元素上方不可见内容的像素高度。如果元素被水平滚动了,那么scrollLeft 的值会大于0,且表示元素左侧不可见内容的像素宽度。这两个属性都是可以设置的,因此将元素的scrollLeft 和scrollTop 设置为0,就可以重置元素的滚动位置。下面这个函数会检测元素是否位于顶部,如果不是就将其回滚到顶部。
function scrollToTop(element){ if (element.scrollTop != 0){ element.scrollTop = 0; } }
4. 确定元素大小
IE、Firefox 3+、Safari 4+、Opera 9.5 及Chrome 为每个元素都提供了一个getBoundingClientRect()方法。这个方法返回会一个矩形对象,包含4 个属性:left、top、right 和bottom。这些属性给出了元素在页面中相对于视口的位置。但是,浏览器的实现稍有不同。IE8 及更早版本认为文档的左上角坐标是(2, 2),而其他浏览器包括IE9 则将传统的(0,0)作为起点坐标。因此,就需要在一开始检查一下位于(0,0)处的元素的位置,在IE8 及更早版本中,会返回(2,2),而在其他浏览器中会返回(0,0)。
function getBoundingClientRect(element){ if (typeof arguments.callee.offset != "number"){ var scrollTop = document.documentElement.scrollTop; var temp = document.createElement("div"); temp.style.cssText = "position:absolute;left:0;top:0;"; document.body.appendChild(temp); arguments.callee.offset = -temp.getBoundingClientRect().top - scrollTop; document.body.removeChild(temp); temp = null; } var rect = element.getBoundingClientRect(); var offset = arguments.callee.offset; return { left: rect.left + offset, right: rect.right + offset, top: rect.top + offset, bottom: rect.bottom + offset }; }
对于不支持getBoundingClientRect()的浏览器,可以通过其他手段取得相同的信息。
function getBoundingClientRect(element){ var scrollTop = document.documentElement.scrollTop; var scrollLeft = document.documentElement.scrollLeft; if (element.getBoundingClientRect){ if (typeof arguments.callee.offset != "number"){ var temp = document.createElement("div"); temp.style.cssText = "position:absolute;left:0;top:0;"; document.body.appendChild(temp); arguments.callee.offset = -temp.getBoundingClientRect().top - scrollTop; document.body.removeChild(temp); temp = null; } var rect = element.getBoundingClientRect(); var offset = arguments.callee.offset; return { left: rect.left + offset, right: rect.right + offset, top: rect.top + offset, bottom: rect.bottom + offset }; } else { var actualLeft = getElementLeft(element); var actualTop = getElementTop(element); return { left: actualLeft - scrollLeft, right: actualLeft + element.offsetWidth - scrollLeft, top: actualTop - scrollTop, bottom: actualTop + element.offsetHeight - scrollTop } } }
遍历
“DOM2 级遍历和范围”模块定义了两个用于辅助完成顺序遍历DOM 结构的类型:NodeIterator和TreeWalker。这两个类型能够基于给定的起点对DOM 结构执行深度优先(depth-first)的遍历操作。在与DOM 兼容的浏览器中(Firefox 1 及更高版本、Safari 1.3 及更高版本、Opera 7.6 及更高版本、Chrome0.2 及更高版本),都可以访问到这些类型的对象。IE 不支持DOM 遍历。使用下列代码可以检测浏览器对DOM2 级遍历能力的支持情况。
var supportsTraversals = document.implementation.hasFeature("Traversal", "2.0"); var supportsNodeIterator = (typeof document.createNodeIterator == "function"); var supportsTreeWalker = (typeof document.createTreeWalker == "function");
DOM 遍历是深度优先的DOM 结构遍历,也就是说,移动的方向至少有两个(取决于使用的遍历类型)。遍历以给定节点为根,不可能向上超出DOM 树的根节点。
<!DOCTYPE html> <html> <head> <title>Example</title> </head> <body> <p><b>Hello</b> world!</p> </body> </html>
任何节点都可以作为遍历的根节点。如果假设<body>元素为根节点,那么遍历的第一步就是访问<p>元素,然后再访问同为<body>元素后代的两个文本节点。不过,这次遍历永远不会到达<html>、<head>元素,也不会到达不属于<body>元素子树的任何节点。而以document 为根节点的遍历则可以访问到文档中的全部节点。
从document 开始依序向前,访问的第一个节点是document,访问的最后一个节点是包含"world!"的文本节点。从文档最后的文本节点开始,遍历可以反向移动到DOM 树的顶端。此时,访问的第一个节点是包含"Hello"的文本节点,访问的最后一个节点是document 节点。NodeIterator和TreeWalker 都以这种方式执行遍历。
NodeIterator
NodeIterator 类型是两者中比较简单的一个,可以使用document.createNodeIterator()方法创建它的新实例。这个方法接受下列4 个参数。
- root:想要作为搜索起点的树中的节点。
- whatToShow:表示要访问哪些节点的数字代码。
- filter:是一个NodeFilter 对象,或者一个表示应该接受还是拒绝某种特定节点的函数。
-
entityReferenceExpansion:布尔值,表示是否要扩展实体引用。这个参数在HTML 页面中没有用,因为其中的实体引用不能扩展。
whatToShow 参数是一个位掩码,通过应用一或多个过滤器(filter)来确定要访问哪些节点。这个参数的值以常量形式在NodeFilter 类型中定义。
- NodeFilter.SHOW_ALL:显示所有类型的节点。
- NodeFilter.SHOW_ELEMENT:显示元素节点。
- NodeFilter.SHOW_ATTRIBUTE:显示特性节点。由于DOM结构原因,实际上不能使用这个值。
- NodeFilter.SHOW_TEXT:显示文本节点。
- NodeFilter.SHOW_CDATA_SECTION:显示CDATA 节点。对HTML 页面没有用。
- NodeFilter.SHOW_ENTITY_REFERENCE:显示实体引用节点。对HTML 页面没有用。
- NodeFilter.SHOW_ENTITYE:显示实体节点。对HTML 页面没有用。
- NodeFilter.SHOW_PROCESSING_INSTRUCTION:显示处理指令节点。对HTML 页面没有用。
- NodeFilter.SHOW_COMMENT:显示注释节点。
- NodeFilter.SHOW_DOCUMENT:显示文档节点。
- NodeFilter.SHOW_DOCUMENT_TYPE:显示文档类型节点。
- NodeFilter.SHOW_DOCUMENT_FRAGMENT:显示文档片段节点。对HTML 页面没有用。
- NodeFilter.SHOW_NOTATION:显示符号节点。对HTML 页面没有用。
除了NodeFilter.SHOW_ALL 之外,可以使用按位或操作符来组合多个选项,如下面的例子所示:
var whatToShow = NodeFilter.SHOW_ELEMENT | NodeFilter.SHOW_TEXT;
可以通过createNodeIterator()方法的filter 参数来指定自定义的NodeFilter 对象,或者指定一个功能类似节点过滤器(node filter)的函数。每个NodeFilter 对象只有一个方法,即accept-Node();如果应该访问给定的节点,该方法返回NodeFilter.FILTER_ACCEPT,如果不应该访问给定的节点,该方法返回NodeFilter.FILTER_SKIP。由于NodeFilter 是一个抽象的类型,因此不能直接创建它的实例。在必要时,只要创建一个包含acceptNode()方法的对象,然后将这个对象传入createNodeIterator()中即可。例如,下列代码展示了如何创建一个只显示<p>元素的节点迭代器。
var filter = { acceptNode: function(node){ return node.tagName.toLowerCase() == "p" ? NodeFilter.FILTER_ACCEPT : NodeFilter.FILTER_SKIP; } }; var iterator = document.createNodeIterator(root, NodeFilter.SHOW_ELEMENT,filter, false);
第三个参数也可以是一个与acceptNode()方法类似的函数
var filter = function(node){ return node.tagName.toLowerCase() == "p" ? NodeFilter.FILTER_ACCEPT : NodeFilter.FILTER_SKIP; }; var iterator = document.createNodeIterator(root, NodeFilter.SHOW_ELEMENT, filter, false);
下面的代码创建了一个能够访问所有类型节点的简单的NodeIterator。
var iterator = document.createNodeIterator(document, NodeFilter.SHOW_ALL, null, false);
NodeIterator 类型的两个主要方法是nextNode()和previousNode()。顾名思义,在深度优先的DOM 子树遍历中,nextNode()方法用于向前前进一步,而previousNode()用于向后后退一步。在刚刚创建的NodeIterator 对象中,有一个内部指针指向根节点,因此第一次调用nextNode()会返回根节点。当遍历到DOM 子树的最后一个节点时,nextNode()返回null。previousNode()方法的工作机制类似。当遍历到DOM 子树的最后一个节点,且previousNode()返回根节点之后,再次调用它就会返回null。
<div id="div1"> <p><b>Hello</b> world!</p> <ul> <li>List item 1</li> <li>List item 2</li> <li>List item 3</li> </ul> </div> var div = document.getElementById("div1"); var iterator = document.createNodeIterator(div, NodeFilter.SHOW_ELEMENT, null, false); var node = iterator.nextNode(); while (node !== null) { alert(node.tagName); //输出标签名 node = iterator.nextNode(); }
由于nextNode()和previousNode()方法都基于NodeIterator 在DOM 结构中的内部指针工作,所以DOM 结构的变化会反映在遍历的结果中。
TreeWalker
TreeWalker 是NodeIterator 的一个更高级的版本。除了包括nextNode()和previousNode()在内的相同的功能之外,这个类型还提供了下列用于在不同方向上遍历DOM 结构的方法。
- parentNode():遍历到当前节点的父节点;
- firstChild():遍历到当前节点的第一个子节点;
- lastChild():遍历到当前节点的最后一个子节点;
- nextSibling():遍历到当前节点的下一个同辈节点;
- previousSibling():遍历到当前节点的上一个同辈节点。
创建TreeWalker 对象要使用document.createTreeWalker()方法,这个方法接受的4 个参数与document.createNodeIterator()方法相同:作为遍历起点的根节点、要显示的节点类型、过滤器和一个表示是否扩展实体引用的布尔值。由于这两个创建方法很相似,所以很容易用TreeWalker来代替NodeIterator。
var div = document.getElementById("div1"); var filter = function(node){ return node.tagName.toLowerCase() == "li"? NodeFilter.FILTER_ACCEPT : NodeFilter.FILTER_SKIP; }; var walker= document.createTreeWalker(div, NodeFilter.SHOW_ELEMENT, filter, false); var node = iterator.nextNode(); while (node !== null) { alert(node.tagName); //输出标签名 node = iterator.nextNode(); }
在这里,filter 可以返回的值有所不同。除了NodeFilter.FILTER_ACCEPT 和NodeFilter.FILTER_SKIP 之外,还可以使用NodeFilter.FILTER_REJECT。在使用NodeIterator 对象时,NodeFilter.FILTER_SKIP 与NodeFilter.FILTER_REJECT 的作用相同:跳过指定的节点。但在使用TreeWalker 对象时,NodeFilter.FILTER_SKIP 会跳过相应节点继续前进到子树中的下一个节点,而NodeFilter.FILTER_REJECT 则会跳过相应节点及该节点的整个子树。
TreeWalker 真正强大的地方在于能够在DOM结构中沿任何方向移动。使用TreeWalker遍历DOM 树,即使不定义过滤器,也可以取得所有<li>元素。
var div = document.getElementById("div1"); var walker = document.createTreeWalker(div, NodeFilter.SHOW_ELEMENT, null, false); walker.firstChild(); //转到<p> walker.nextSibling(); //转到<ul> var node = walker.firstChild(); //转到第一个<li> while (node !== null) { alert(node.tagName); node = walker.nextSibling(); }
TreeWalker 类型还有一个属性,名叫currentNode,表示任何遍历方法在上一次遍历中返回的节点。通过设置这个属性也可以修改遍历继续进行的起点
var node = walker.nextNode(); alert(node === walker.currentNode); //true walker.currentNode = document.body; //修改起点
与NodeIterator 相比,TreeWalker 类型在遍历DOM时拥有更大的灵活性。由于IE 中没有对应的类型和方法,所以使用遍历的跨浏览器解决方案非常少见。
范围
在常规的DOM 操作不能更有效地修改文档时,使用范围往往可以达到目的。Firefox、Opera、Safari 和Chrome 都支持DOM 范围。IE 以专有方式实现了自己的范围特性。
DOM中的范围
DOM2 级在Document 类型中定义了createRange()方法。在兼容DOM 的浏览器中,这个方法属于document 对象。使用hasFeature()或者直接检测该方法,都可以确定浏览器是否支持范围。
var supportsRange = document.implementation.hasFeature("Range", "2.0"); var alsoSupportsRange = (typeof document.createRange == "function");
使用createRange()来创建DOM范围
var range = document.createRange();
与节点类似,新创建的范围也直接与创建它的文档关联在一起,不能用于其他文档。创建了范围之后,接下来就可以使用它在后台选择文档中的特定部分。而创建范围并设置了其位置之后,还可以针对范围的内容执行很多种操作,从而实现对底层DOM 树的更精细的控制。
每个范围由一个Range 类型的实例表示,这个实例拥有很多属性和方法。下列属性提供了当前范围在文档中的位置信息。
- startContainer:包含范围起点的节点(即选区中第一个节点的父节点)。
-
startOffset:范围在startContainer 中起点的偏移量。如果startContainer 是文本节点、注释节点或CDATA 节点,那么startOffset 就是范围起点之前跳过的字符数量。否则,startOffset 就是范围中第一个子节点的索引。
- endContainer:包含范围终点的节点(即选区中最后一个节点的父节点)。
- endOffset:范围在endContainer 中终点的偏移量(与startOffset 遵循相同的取值规则)。
-
commonAncestorContainer:startContainer 和endContainer 共同的祖先节点在文档树中位置最深的那个。
在把范围放到文档中特定的位置时,这些属性都会被赋值。
1. 用DOM 范围实现简单选择
要使用范围来选择文档中的一部分,最简的方式就是使用selectNode()或selectNodeContents()。这两个方法都接受一个参数,即一个DOM 节点,然后使用该节点中的信息来填充范围。其中,selectNode()方法选择整个节点,包括其子节点;而selectNodeContents()方法则只选择节点的子节点。
<!DOCTYPE html> <html> <body> <p id="p1"><b>Hello</b> world!</p> </body> </html> var range1 = document.createRange(); range2 = document.createRange(); p1 = document.getElementById("p1"); range1.selectNode(p1); range2.selectNodeContents(p1);
在调用selectNode()时,startContainer、endContainer 和commonAncestorContainer都等于传入节点的父节点,也就是这个例子中的document.body。而startOffset 属性等于给定节点在其父节点的childNodes 集合中的索引(在这个例子中是1——因为兼容DOM的浏览器将空格算作一个文本节点),endOffset 等于startOffset 加1(因为只选择了一个节点)。
在调用selectNodeContents()时,startContainer、endContainer 和commonAncestorContainer等于传入的节点,即这个例子中的<p>元素。而startOffset 属性始终等于0,因为范围从给定节点的第一个子节点开始。最后,endOffset 等于子节点的数量(node.childNodes.length),在这个例子中是2。
为了更精细地控制将哪些节点包含在范围中,还可以使用下列方法。
-
setStartBefore(refNode):将范围的起点设置在refNode 之前,因此refNode 也就是范围选区中的第一个子节点。同时会将startContainer 属性设置为refNode.parentNode,将startOffset 属性设置为refNode 在其父节点的childNodes 集合中的索引。
-
setStartAfter(refNode):将范围的起点设置在refNode 之后,因此refNode 也就不在范围之内了,其下一个同辈节点才是范围选区中的第一个子节点。同时会将startContainer 属性设置为refNode.parentNode,将startOffset 属性设置为refNode 在其父节点的childNodes 集合中的索引加1。
-
setEndBefore(refNode):将范围的终点设置在refNode 之前,因此refNode 也就不在范围之内了,其上一个同辈节点才是范围选区中的最后一个子节点。同时会将endContainer 属性设置为refNode.parentNode,将endOffset 属性设置为refNode 在其父节点的childNodes集合中的索引。
-
setEndAfter(refNode):将范围的终点设置在refNode 之后,因此refNode 也就是范围选区中的最后一个子节点。同时会将endContainer 属性设置为refNode.parentNode,将endOffset 属性设置为refNode 在其父节点的childNodes 集合中的索引加1。
2. 用DOM 范围实现复杂选择
要创建复杂的范围就得使用setStart()和setEnd()方法。这两个方法都接受两个参数:一个参照节点和一个偏移量值。对setStart()来说,参照节点会变成startContainer,而偏移量值会变成startOffset。对于setEnd()来说,参照节点会变成endContainer,而偏移量值会变成endOffset。
可以使用这两个方法来模仿selectNode()和selectNodeContents()。
var range1 = document.createRange(); range2 = document.createRange(); p1 = document.getElementById("p1"); p1Index = -1; i, len; for (i=0, len=p1.parentNode.childNodes.length; i < len; i++) { if (p1.parentNode.childNodes[i] == p1) { p1Index = i; break; } } range1.setStart(p1.parentNode, p1Index); range1.setEnd(p1.parentNode, p1Index + 1); range2.setStart(p1, 0); range2.setEnd(p1, p1.childNodes.length);
模仿selectNode()和selectNodeContents()并不是setStart()和setEnd()的主要用途,它们更胜一筹的地方在于能够选择节点的一部分。
假设你只想选择前面HTML 示例代码中从"Hello"的"llo"到"world!"的"o"——很容易做到。第一步是取得所有节点的引用
var p1 = document.getElementById("p1"); helloNode = p1.firstChild.firstChild; worldNode = p1.lastChild;
var range = document.createRange();
range.setStart(helloNode, 2);
rang e.setEnd(worldNode, 3);
仅仅是选择了文档中的某一部分用处并不大。但重要的是,选择之后才可以对选区进行操作。
3. 操作DOM 范围中的内容
在创建范围时 ,内部会为这个范围创建一个文档片段,范围所属的全部节点都被添加到了这个文档片段中。为了创建这个文档片段,范围内容的格式必须正确有效。在前面的例子中,我们创建的选区分别开始和结束于两个文本节点的内部,因此不能算是格式良好的DOM结构,也就无法通过DOM来表示。但是,范围知道自身缺少哪些开标签和闭标签,它能够重新构建有效的DOM结构以便我们对其进行操作。
对于前面的例子而言,范围经过计算知道选区中缺少一个开始的<b>标签,因此就会在后台动态加入一个该标签,同时还会在前面加入一个表示结束的</b>标签以结束"He"。于是,修改后的DOM 就变成了如下所示。
<p><b>He</b><b>llo</b> world!</p>
另外,文本节点"world!"也被拆分为两个文本节点,一个包含"wo",另一个包含"rld!"。
像这样创建了范围之后,就可以使用各种方法对范围的内容进行操作了(注意,表示范围的内部文档片段中的所有节点,都只是指向文档中相应节点的指针)。
第一个方法,也是最容易理解的方法,就是deleteContents()。这个方法能够从文档中删除范围所包含的内容。
<!DOCTYPE html> <html> <body> <p id="p1"><b>Hello</b> world!</p> </body> </html>
var p1 = document.getElementById("p1"); helloNode = p1.firstChild.firstChild; worldNode = p1.lastChild; range = document.createRange(); range.setStart(helloNode, 2); range.setEnd(worldNode, 3); range.deleteContents();
执行以上代码后,页面中会显示如下HTML 代码:
<p><b>He</b>rld!</p>
由于范围选区在修改底层DOM 结构时能够保证格式良好,因此即使内容被删除了,最终的DOM结构依旧是格式良好的。
与deleteContents()方法相似,extractContents()也会从文档中移除范围选区。但这两个方法的区别在于,extractContents()会返回范围的文档片段。利用这个返回的值,可以将范围的内容插入到文档中的其他地方。
var p1 = document.getElementById("p1"); helloNode = p1.firstChild.firstChild; worldNode = p1.lastChild; range = document.createRange();
range.setStart(helloNode, 2); range.setEnd(worldNode, 3); var fragment = range.extractContents(); p1.parentNode.appendChild(fragment);
记住,在将文档片段传入appendChild()方法中时,extractContents()操作后添加到文档中的只是片段的子节点,而非片段本身。
<p><b>He</b>rld!</p> <b>llo</b> wo
还一种做法,即使用cloneContents()创建范围对象的一个副本,然后在文档的其他地方插入该副本。
var p1 = document.getElementById("p1"), helloNode = p1.firstChild.firstChild, worldNode = p1.lastChild, range = document.createRange(); range.setStart(helloNode, 2); range.setEnd(worldNode, 3); var fragment = range.cloneContents(); p1.parentNode.appendChild(fragment);
这个方法与extractContents()非常类似,因为它们都返回文档片段。它们的主要区别在于,cloneContents()返回的文档片段包含的是范围中节点的副本,而不是实际的节点,副本也是片段的子节点,而非片段本身。
有一点请读者注意,那就是在调用上面介绍的方法之前,拆分的节点并不会产生格式良好的文档片段。换句话说,原始的HTML 在DOM 被修改之前会始终保持不变。
4. 插入DOM 范围中的内容
使用insertNode()方法可以向范围选区的开始处插入一个节点。
var p1 = document.getElementById("p1"); helloNode = p1.firstChild.firstChild; worldNode = p1.lastChild; range = document.createRange();
range.setStart(helloNode, 2); range.setEnd(worldNode, 3);
var span = document.createElement("span"); span.style.color = "red"; span.appendChild(document.createTextNode("Inserted text")); range.insertNode(span);
运行以上JavaScript 代码,就会得到如下HTML 代码
<p id="p1"><b>He<span style="color: red">Inserted text</span>llo</b> world</p>
除了向范围内部插入内容之外,还可以环绕范围插入内容,此时就要使用surroundContents()方法。这个方法接受一个参数,即环绕范围内容的节点。在环绕范围插入内容时,后台会执行下列步骤。
- 提取出范围中的内容(类似执行extractContent())
- 将给定节点插入到文档中原来范围所在的位置上;
- 将文档片段的内容添加到给定节点中。
可以使用这种技术来突出显示网页中的某些词句
var p1 = document.getElementById("p1"); helloNode = p1.firstChild.firstChild; worldNode = p1.lastChild; range = document.createRange();
range.selectNode(helloNode);
var span = document.createElement("span"); span.style.backgroundColor = "yellow"; range.surroundContents(span);
会给范围选区加上一个黄色的背景。得到的HTML 代码如下所示:
<p><b><span style="background-color:yellow">Hello</span></b> world!</p>
5. 折叠DOM 范围
所谓折叠范围,就是指范围中未选择文档的任何部分。可以用文本框来描述折叠范围的过程。假设文本框中有一行文本,你用鼠标选择了其中一个完整的单词。然后,你单击鼠标左键,选区消失,而光标则落在了其中两个字母之间。同样,在折叠范围时,其位置会落在文档中的两个部分之间,可能是范围选区的开始位置,也可能是结束位置。
使用collapse()方法来折叠范围,这个方法接受一个参数,一个布尔值,表示要折叠到范围的哪一端。参数true 表示折叠到范围的起点,参数false 表示折叠到范围的终点。要确定范围已经折叠完毕,可以检查collapsed 属性。
range.collapse(true); //折叠到起点 alert(range.collapsed); //输出true
检测某个范围是否处于折叠状态,可以帮我们确定范围中的两个节点是否紧密相邻。
<p id="p1">Paragraph 1</p><p id="p2">Paragraph 2</p>
如果我们不知道其实际构成(比如说,这行代码是动态生成的),那么可以像下面这样创建一个范围。
var p1 = document.getElementById("p1"), p2 = document.getElementById("p2"), range = document.createRange(); range.setStartAfter(p1); range.setStartBefore(p2); alert(range.collapsed); //输出true
在这个例子中,新创建的范围是折叠的,因为p1 的后面和p2 的前面什么也没有。
6. 比较DOM 范围
在有多个范围的情况下,可以使用compareBoundaryPoints()方法来确定这些范围是否有公共的边界(起点或终点)。这个方法接受两个参数:表示比较方式的常量值和要比较的范围。表示比较方式的常量值如下所示。
- Range.START_TO_START(0):比较第一个范围和第二个范围的起点;
- Range.START_TO_END(1):比较第一个范围的起点和第二个范围的终点;
- Range.END_TO_END(2):比较第一个范围和第二个范围的终点;
- Range.END_TO_START(3):比较第一个范围的终点和第一个范围的起点。
compareBoundaryPoints()方法可能的返回值如下:如果第一个范围中的点位于第二个范围中的点之前,返回-1;如果两个点相等,返回0;如果第一个范围中的点位于第二个范围中的点之后,返回1。
var range1 = document.createRange(); var range2 = document.createRange(); var p1 = document.getElementById("p1");
range1.selectNodeContents(p1); range2.selectNodeContents(p1); range2.setEndBefore(p1.lastChild);
alert(range1.compareBoundaryPoints(Range.START_TO_START, range2)); //0 alert(range1.compareBoundaryPoints(Range.END_TO_END, range2)); //1
7. 复制DOM 范围
可以使用cloneRange()方法复制范围。这个方法会创建调用它的范围的一个副本。
var newRange = range.cloneRange();
新创建的范围与原来的范围包含相同的属性,而修改它的端点不会影响原来的范围。
8. 清理DOM 范围
在使用完范围之后,最好是调用detach()方法,以便从创建范围的文档中分离出该范围。调用detach()之后,就可以放心地解除对范围的引用,从而让垃圾回收机制回收其内存了。
range.detach(); //从文档中分离 range = null; //解除引用
在使用范围的最后再执行这两个步骤是我们推荐的方式。一旦分离范围,就不能再恢复使用了。
IE8 及更早版本中的范围
IE8 及之前版本不支持DOM范围。不过,IE8 及早期版本支持一种类似的概念,即文本范围(text range)。文本范围是IE 专有的特性,其他浏览器都不支持。顾名思义,文本范围处理的主要是文本(不一定是DOM 节点)。通过<body>、<button>、<input>和<textarea>等这几个元素,可以调用createTextRange()方法来创建文本范围。
var range = document.body.createTextRange();
像这样通过document 创建的范围可以在页面中的任何地方使用(通过其他元素创建的范围则只能在相应的元素中使用)。
1. 用IE 范围实现简单的选择
选择页面中某一区域的最简单方式,就是使用范围的findText()方法。这个方法会找到第一次出现的给定文本,并将范围移过来以环绕该文本。如果没有找到文本,这个方法返回false;否则返回true。
<p id="p1"><b>Hello</b> world!</p> var range = document.body.createTextRange(); var found = range.findText("Hello"); alert(found); //true alert(range.text); //"Hello"
还可以为findText()传入另一个参数,即一个表示向哪个方向继续搜索的数值。负值表示应该从当前位置向后搜索,而正值表示应该从当前位置向前搜索。
var found = range.findText("Hello"); var foundAgain = range.findText("Hello", 1);
IE 中与DOM 中的selectNode()方法最接近的方法是moveToElementText(),这个方法接受一个DOM 元素,并选择该元素的所有文本,包括HTML 标签。
var range = document.body.createTextRange(); var p1 = document.getElementById("p1"); range.moveToElementText(p1);
在文本范围中包含HTML 的情况下,可以使用htmlText 属性取得范围的全部内容
alert(range.htmlText);
IE 的范围没有任何属性可以随着范围选区的变化而动态更新。不过,其parentElement()方法倒是与DOM 的commonAncestorContainer 属性类似。这样得到的父元素始终都可以反映文本选区的父节点。
var ancestor = range.parentElement();
2. 使用IE 范围实现复杂的选择
在IE 中创建复杂范围的方法,就是以特定的增量向四周移动范围。为此,IE 提供了4 个方法:move()、moveStart()、moveEnd()和expand()。这些方法都接受两个参数:移动单位和移动单位的数量。其中,移动单位是下列一种字符串值。
- "character":逐个字符地移动。
- "word":逐个单词(一系列非空格字符)地移动。
- "sentence":逐个句子(一系列以句号、问号或叹号结尾的字符)地移动。
- "textedit":移动到当前范围选区的开始或结束位置。
通过moveStart()方法可以移动范围的起点,通过moveEnd()方法可以移动范围的终点,移动的幅度由单位数量指定
range.moveStart("word", 2); //起点移动2 个单词 range.moveEnd("character", 1); //终点移动1 个字符
使用expand()方法可以将范围规范化。换句话说,expand()方法的作用是将任何部分选择的文本全部选中。例如,当前选择的是一个单词中间的两个字符,调用expand("word")可以将整个单词都包含在范围之内。
而move()方法则首先会折叠当前范围(让起点和终点相等),然后再将范围移动指定的单位数量,如下面的例子所示。
range.move("character", 5); //移动5 个字符
调用move()之后,范围的起点和终点相同,因此必须再使用moveStart()或moveEnd()创建新的选区。
3. 操作IE 范围中的内容
在IE 中操作范围中的内容可以使用text 属性或pasteHTML()方法。如前所述,通过text 属性可以取得范围中的内容文本;但是,也可以通过这个属性设置范围中的内容文本。
var range = document.body.createTextRange(); range.findText("Hello"); range.text = "Howdy";
要向范围中插入HTML 代码,就得使用pasteHTML()方法
<p id="p1"><b>Hello</b> world!</p> var range = document.body.createTextRange(); range.findText("Hello"); range.pasteHTML("<em>Howdy</em>"); <p id="p1"><b><em>Howdy</em></b> world!</p>
在范围中包含HTML 代码时,不应该使用pasteHTML(),因为这样很容易导致不可预料的结果——很可能是格式不正确的HTML。
4. 折叠IE 范围
IE 为范围提供的collapse()方法与相应的DOM 方法用法一样:传入true 把范围折叠到起点,传入false 把范围折叠到终点。
range.collapse(true); //折叠到起点
可惜的是,没有对应的collapsed 属性让我们知道范围是否已经折叠完毕。为此,必须使用boundingWidth 属性,该属性返回范围的宽度(以像素为单位)。如果boundingWidth 属性等于0,就说明范围已经折叠了:
var isCollapsed = (range.boundingWidth == 0);
此外,还有boundingHeight、boundingLeft 和boundingTop 等属性,虽然它们都不像boundingWidth 那么有用,但也可以提供一些有关范围位置的信息。
5. 比较IE 范围
IE 中的compareEndPoints()方法与DOM范围的compareBoundaryPoints()方法类似。这个方法接受两个参数:比较的类型和要比较的范围。比较类型的取值范围是下列几个字符串值:"StartToStart"、"StartToEnd"、"EndToEnd"和"EndToStart"。这几种比较类型与比较DOM范围时使用的几个值是相同的。
同样与DOM类似的是,compareEndPoints()方法也会按照相同的规则返回值,即如果第一个范围的边界位于第二个范围的边界前面,返回-1;如果二者边界相同,返回0;如果第一个范围的边界位于第二个范围的边界后面,返回1。\
var range1 = document.body.createTextRange(); var range2 = document.body.createTextRange(); range1.findText("Hello world!"); range2.findText("Hello"); alert(range1.compareEndPoints("StartToStart", range2)); //0 alert(range1.compareEndPoints("EndToEnd", range2)); //1
IE 中还有两个方法,也是用于比较范围的:isEqual()用于确定两个范围是否相等,inRange()用于确定一个范围是否包含另一个范围。
var range1 = document.body.createTextRange(); var range2 = document.body.createTextRange(); range1.findText("Hello World"); range2.findText("Hello"); alert("range1.isEqual(range2): " + range1.isEqual(range2)); //false alert("range1.inRange(range2):" + range1.inRange(range2)); //true
6. 复制IE 范围
在IE 中使用duplicate()方法可以复制文本范围,结果会创建原范围的一个副本
var newRange = range.duplicate();
新创建的范围会带有与原范围完全相同的属性。