编辑器开发之 Selection 对象的学习

时间:2022-05-07 09:00:56

上一篇,介绍了 range 对象的一些属性和方法,了解了一些基本操作,现在来介绍另外一个重要的对象:selection 对象;

MDN 的解释是:Selection 对象表示用户选择的文本范围或插入符号的当前位置。它代表页面中的文本选区,可能横跨多个元素。文本选区由用户拖拽鼠标经过文字而产生;

先来写一个基本的 HTML 结构:

 <div id="box" class="box" contenteditable="true">abcd<span>efghi</span>jk<p>mnop</p><span>qrstwvu</span>xyz</div>

选中:

编辑器开发之 Selection 对象的学习

看下 selection 对象的信息:

 function getSel() {
var sel = window.getSelection();
// 如果有 range
if (sel.rangeCount > 0) {
var range = sel.getRangeAt(0);
console.log(range.cloneContents());
}
console.log(sel);
}

编辑器开发之 Selection 对象的学习

这里主要关注的有这几个属性:

anchorNode:返回选区的开始位置所在的节点,这里是最外面的 div;

anchorOffset:返回选区开始位置在开始节点中的位置;

focusNode:返回选区的结束位置所在的节点,这里是 span 标签;

focusOffset:返回选区的结束位置在结束节点中的位置;

isCollapsed:返回选区的开始位置和结束位置是否相同,检测选区是否折叠;

rangeCount:返回 range 对象的数量;

注意:这个 rangeCount 总是存在的,无论页面有没有可变的区域,只要鼠标点击了任何位置,它都会变成 1;

baseNode,baseOffset属性和 ahchorNode,anchorOffset相同;

extentNode,extentOffset属性和 focusNode,focusOffset相同;

 

Selection 对象的一些重要方法:

getRangeAt(index):根据索引返回 range 对象,需要注意的一点是:其他浏览器都是只有一个选区,但是在 firefox下,可以有多个选区,操作是按住 shift 多选;

collapse(parentNode, offset):折叠选区到某个位置,光标会在此处闪烁;

现在把光标移动到 p 标签的第三个字符前面:

 function setCollapse() {
var sel = window.getSelection();
box.focus();
var p = box.querySelector('p').firstChild;
sel.collapse(p, 2); // 设置光标的位置在 p 标签的第三个字符前面 if (sel.rangeCount > 0) {
var range = sel.getRangeAt(0);
console.log(range);
}
}

编辑器开发之 Selection 对象的学习

可以看到光标在字符 o 的前面闪烁;

collapseToStart:将光标设置到选区的起点,这个没什么好说的;

collapseToStart:将光标设置到选区的结束位置,这个也没啥好说的;

selectAllChildren(node):将节点的所有子节点加入选区;

 function setSelectAllChildren() {
var sel = window.getSelection();
sel.selectAllChildren(box); // 把可编辑区的所有子节点纳入选区 if (sel.rangeCount > 0) {
var range = sel.getRangeAt(0);
console.log(range.cloneContents());
}
}

编辑器开发之 Selection 对象的学习

可以看到所有的内容都放到选区内了;

addRange(range):将选区加入到 selection:

 function addRange() {
var sel = window.getSelection();
sel.removeAllRanges();
box.focus(); // 将所有的子节点放到选区中
var children = box.children;
for(var i = 0; i < children.length; i++) {
var range = document.createRange(); console.log(children[i]);
range.selectNode(children[i]);
sel.addRange(range);
} console.log(sel); // 打印 range 的数量
}

编辑器开发之 Selection 对象的学习

这里是把所有的子节点放到选区中,但是好像只有 firefox 支持,其他的浏览器不支持多个 range;

removeRange(range):删除指定的选区,只有 firefox 支持;

removeAllRanges:删除所有的选区;

deleteFromDocument:从页面中删除选区中的内容;

selectionLanguageChange:当键盘的朝向发生改变后修改指针的Bidi优先级;

toString:返回当前选区的纯文本内容;

containsNode:判断某一个node是否为当前选区的一部分;