Range.surroundContents() - コンテンツをノードで囲む

2017/10/16

surroundContents()は、Rangeのメソッドです。範囲のコンテンツの周りをノードで囲みます。

概要

名前

surroundContents

所属

IDL

[CEReactions] void surroundContents(Node newParent);

仕様書

https://dom.spec.whatwg.org/#dom-range-surroundcontents

説明

引数(newParent)には、新しく親となるノードを指定します。メソッドを実行すると、このノードが範囲を取り囲むように配置されます。親ノードに元々あった中身は失われます。

チュートリアル

始点と終点の位置により内容が違うのでご注意下さい。例えば、下記のようにp要素の直前、直後に始点と終点がある場合、メソッドを実行すると、p要素ごと取り囲みます。

|始点|<p>SYNCER</p>|終点|

下記のようにp要素の先頭、末尾(テキストノードの直前、直後)に始点と終点がある場合、メソッドを実行すると、p要素の中身を取り囲みます。

<p>|始点|SYNCER|終点|</p>

デモ

Range.surroundContents()のデモです。選択範囲をRangeで表現したオブジェクトにメソッドを実行します。テキストを選択すると3秒後にメソッドが実行されて、その範囲のコンテンツをb要素で囲みます。メソッドの実行は1回限りです。再度試したい場合は再読み込みして下さい。

<!-- このコードは編集できます。 -->

<!DOCTYPE html>
<head>
<style>
body { word-break: break-all ; tab-size: 2 ; }
div#result { white-space: pre-wrap ; }
</style>
</head>
<body>
<div>
<p>12345678901234567890</p>
</div>
<hr>
<div id="result"></div>
<script>
var timeoutId ;
var did ;
var surroundElement = document.createElement( "b" ) ;
var selection = getSelection() ;

document.onselectionchange = function () {
	getRangeInfo() ;

	clearTimeout( timeoutId ) ;
	if ( did ) return false ;

	timeoutId = setTimeout( function() {
		var range = selection.getRangeAt(0) ;
		range.surroundContents( surroundElement ) ;
		getRangeInfo() ;
		did = true ;
	}, 3000 ) ;
}

function getRangeInfo() {
	document.getElementById( "result" ).textContent = "" ;

	var range = selection.getRangeAt(0) ;
	console.log( range ) ;
	appendText( range + "\n\n" ) ;

	appendText( "startContainer: " + range.startContainer + "\n" ) ;
	appendText( "startContainer.data: " + range.startContainer.data + "\n" ) ;
	appendText( "startOffset: " + range.startOffset + "\n" ) ;
	appendText( "endContainer: " + range.endContainer + "\n" ) ;
	appendText( "endContainer.data: " + range.endContainer.data + "\n" ) ;
	appendText( "endOffset: " + range.endOffset + "\n" ) ;
	appendText( "collapsed: " + range.collapsed + "\n" ) ;
	appendText( "commonAncestorContainer: " + range.commonAncestorContainer + "\n" ) ;
	appendText( "commonAncestorContainer.data: " + range.commonAncestorContainer.data + "\n\n" ) ;
}

function appendText ( text ) {
	document.getElementById( "result" ).appendChild( document.createTextNode( text ) ) ;
}
</script>
</body>
</html>