jQuery.wrapAll() 函數詳解

wrapAll()函數用於在所有匹配元素中用單一元素包裹起來。

該函數屬於jQuery物件(實例)。

語法

jQuery 1.2 新增此函數。

jQueryObject.wrapAll( wrapper )

參數

參數 描述

wrapper String/Element/jQuery/Function類型用於包裹匹配元素的節點。

如果參數wrapper為字串，則將其視為jQuery選擇器或html字串，jQuery會自行判斷。

如果wrapper不是函數類型，wrapAll()會將所有匹配元素移動到第一個匹配元素的位置，然後用指定的單一元素將它們全部包裹起來。

jQuery 1.4 新增支援：參數wrapper可以為函數。 wrapAll()將根據匹配的所有元素遍歷執行該函數，函數中的this將指向對應的DOM元素。

wrapAll()也會為函數傳入一個參數，也就是目前元素在符合元素中的索引。 函數的回傳值就是用於包裹的節點內容(可以是html字串、DOM元素或jQuery物件)。

注意：如果wrapper符合多個元素，則只將第一個元素作為包裹元素。

注意：如果wrapper是多層嵌套的元素(例如"

")，wrapAll()將從外往內檢查每層嵌套的第一個節點。如果該節點沒有子節點或第一個子節點不是Element節點(例如文字節點、註解節點等)，就停止向內查找，直接在目前節點內部的末尾位置追加(append())目前符合元素。

傳回值

wrapAll()函數的傳回值為jQuery類型，傳回目前jQuery物件本身(以便於進行鍊式風格的程式設計)。

注意：即使wrapper元素是目前頁面中的元素，該元素也不會從原位置上消失。因為wrapAll()使用的是該元素的副本(克隆)來充當包裹元素。

範例&說明

wrapAll()函數用來將所有符合元素用單一元素包起來：

<p>段落文本1<span></span></p>
<p>段落文本2<span></span></p>
<script type="text/javascript">
$("p").wrapAll( &#39;<div></div>&#39; ); 
</script>
<!--以下是jQuery代码执行后的html内容-->
<div><p>段落文本1<span></span></p><p>段落文本2<span></span></p></div>

以下面這段HTML程式碼為例：

<p id="n1">
    <span id="n2">[span#n2]</span>    
</p>
<p id="n3">
    <label id="n4">[label#n4]</label>
</p>
<span id="n5">[span#n5]</span>
<span id="n6">[span#n6]</span>

以下jQuery範例程式碼用於示範wrapAll()函數的具體用法：

// 在n4元素外包裹del元素：<del>{#n4}</del>
$("#n4").wrapAll(&#39;<del/>&#39;);
// 在所有span元素外包裹单个em元素：<em class="all-span">{#n2}{#n5}{#n6}</em>
// 所有span元素会先移动到第一个span元素的位置，然后全部被em元素包裹起来
$("span").wrapAll(&#39;<em class="all-span"></em>&#39;);
运行代码(其他代码请自行复制到演示页面运行)
wrapAll()会将包裹元素的开始标记和结束标记分别置于所有匹配元素的两侧，不会额外添加任何空白字符，上述代码执行后的完整html代码如下(格式未作任何调整)：
<p id="n1">
    <em class="all-span"><span id="n2">[span#n2]</span><span id="n5">[span#n5]</span><span id="n6">[span#n6]</span></em>    
</p>
<p id="n3">
    <del><label id="n4">[label#n4]</label></del>
</p>

下面是參數wrapper為函數的jQuery範例程式碼，：

<p id="n1">
    <span id="n2">[span#n2]</span>    
</p>
<p id="n3">
    <label id="n4">[label#n4]</label>
</p>
<span id="n5">[span#n5]</span>
<span id="n6">[span#n6]</span>




    [span#n2]    


    [label#n4]

[span#n5]
[span#n6]

以下是wrapper參數為多層嵌套元素的jQuery範例程式碼：

<span id="n1">[span#n1]</span>
<label id="n2">[label#n2]</label>
<span id="n3">[span#n3]</span>
<!--以上是执行jQuery代码前的html内容-->
<script type="text/javascript">
// 在所有span元素外包裹嵌套的div元素：<div><p><em>{#n1}{#n3}</em></p></div>
// 所有span元素都会移动到第一个span元素的位置
$("span").wrapAll( &#39;<div><p><em></em></p></div>&#39; );
/*
如果参数为&#39;<div><p> <em></em></p></div>&#39;，由于&#39;<p>&#39;的第一个子节点是空格(文本节点)，因此停止向内层查找，直接在p元素内部的末尾位置插入所有的span元素：<div><p> <em></em>{#n1}{#n3}</p></div>
 */
</script>
<!--以上是执行jQuery代码后的html内容-->
<div><p><em><span id="n1">[span#n1]</span><span id="n3">[span#n3]</span></em></p></div>
<label id="n2">[label#n2]</label>

以上是jQuery.wrapAll() 函數詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章！