開發中經常會用到複製功能。在 IE 下實作相對簡單,但要做到跨瀏覽器就困難得多。本文介紹一個跨瀏覽器的函式庫 Zero Clipboard,它利用 Flash 進行複製,只要瀏覽器裝有 Flash 就能運行,而且比 IE 的 document.execCommand("Copy") 更靈活。
Zero Clipboard 利用 Flash 進行複製。早期的 Clipboard Copy 方案使用一個隱藏的 Flash,但最新的 Flash Player 10 只允許在 Flash 上進行操作才能啟動剪貼簿。因此 Zero Clipboard 改用一個透明的 Flash,讓它漂浮在按鈕之上——這樣使用者點擊的其實是 Flash,而非按鈕,於是就能使用 Flash 的複製功能了。
首先下載 Zero Clipboard 並解壓縮,其中需要兩個檔案:ZeroClipboard.js 與 ZeroClipboard.swf,將它們放入你的專案。
下載與展示位址可參考官方開源頁面與線上範例。
第一步,導入 ZeroClipboard.js:
<script type="text/javascript" src="ZeroClipboard.js"></script>
再設定 ZeroClipboard.swf 的路徑:
ZeroClipboard.setMoviePath("ZeroClipboard.swf");
注意:以上兩個檔案的路徑都需替換為你專案中對應檔案的路徑,也可以使用絕對路徑。
接著就能使用了:
var clip = new ZeroClipboard.Client(); // 建立一個物件
clip.setHandCursor(true); // 設定滑鼠為手型
clip.setText("哈哈"); // 設定要複製的文字
// 註冊一個 button,參數為 id。點擊這個 button 就會複製。
// 這個 button 不一定是 input 按鈕,也可以是其他 DOM 元素。
clip.glue("copy-botton"); // 和上一句位置不可調換
如此一來基本功能就實現了,點擊按鈕即可複製設定好的文字。你可能注意到待複製的文字是固定的,若想動態改變(例如複製輸入框中的內容),可以參考後面的事件處理。
reposition() 方法:由於按鈕上漂浮著一個 Flash 按鈕,當頁面大小改變時 Flash 按鈕可能錯位,導致點擊不到。Zero Clipboard 提供了 reposition() 方法重新計算位置,可綁定到 resize 事件上:
bind(window, "resize", function() {
clip.reposition();
});
其中 bind 是一個跨瀏覽器的事件綁定函數。IE 的事件綁定函數是 attachEvent;Firefox、Safari 是 addEventListener;Opera 兩者皆支援。封裝如下:
/************************************
* 添加事件綁定
* @param obj : 要綁定事件的元素
* @param type : 事件名稱。不加 "on",如 "click" 而非 "onclick"
* @param fn : 事件處理函數
************************************/
function bind(obj, type, fn) {
if (obj.attachEvent) {
obj['e' + type + fn] = fn;
obj[type + fn] = function() { obj['e' + type + fn](window.event); };
obj.attachEvent('on' + type, obj[type + fn]);
} else
obj.addEventListener(type, fn, false);
}
例如添加一個頁面點擊事件:
bind(document, "click", function() {
alert("Hello, World!!");
});
hide() 與 show() 方法:這兩個方法可隱藏和顯示 Flash 按鈕,其中 show() 會呼叫 reposition()。
setCSSEffects() 方法:由於滑鼠移到按鈕上或點擊時有 Flash 按鈕遮擋,像 css ":hover"、":active" 等偽類可能失效。此方法用來解決這個問題。首先將偽類改成類,例如:
#copy-botton:hover {
border-color:#FF6633;
}
// 可改成下面的 ":hover" 改為 ".hover"
#copy-botton.hover {
border-color:#FF6633;
}
呼叫 clip.setCSSEffects(true); 後,Zero Clipboard 會自動把類 .hover 當成偽類 :hover 處理。
getHTML() 方法:如果你想自行建立 Flash 而不使用 Zero Clipboard 的附著方法,這個方法能幫上忙。它接受 Flash 的寬與高兩個參數,回傳對應的 HTML 代碼:
var html = clip.getHTML(150, 20);
你可以用 innerHTML 或直接 document.write() 輸出。以下為輸出的 HTML 範例:
<embed id="ZeroClipboardMovie_1" src="zeroclipboard/ZeroClipboard.swf" loop="false" menu="false" quality="best" bgcolor="#ffffff" width="150" height="20" name="ZeroClipboardMovie_1" align="middle" allowScriptAccess="always" allowFullScreen="false" type="application/x-shockwave-flash" pluginspage="https://www.macromedia.com/go/getflashplayer" flashvars="id=1&width=150&height=20" wmode="transparent" />
IE 的 Flash JavaScript 通信介面上有一個 bug:必須插入一個 object 標籤到已存在的 DOM 元素中,並在寫入 innerHTML 之前確保該元素已用 appendChild 插入到 DOM 中。
Zero Clipboard 提供一些事件,可用 addEventListener() 自訂處理函數。例如 Flash 完全載入後會觸發 "load" 事件:
clip.addEventListener("load", function(client) {
alert("Flash 加載完畢!");
});
Zero Clipboard 會把 clip 物件作為參數傳入,即上例中的 "client"。"load" 也可寫成 "onLoad",其他事件同理。
其他事件還包括:
mouseOver(滑鼠移上)、mouseOut(滑鼠移出)、mouseDown(滑鼠按下)、mouseUp(滑鼠放開)、complete(複製成功)。其中 mouseOver 與 complete 較常用。
若需動態改變待複製的內容,可在 mouseOver 時重新設定值。例如動態複製 id 為 test 的輸入框內容:
clip.addEventListener("mouseOver", function(client) {
var test = document.getElementById("test");
client.setText(test.value); // 重新設定要複製的值
});
複製成功時:
clip.addEventListener("complete", function() {
alert("複製成功!");
});
以上就是 Zero Clipboard 的主要用法,動手試試看吧。