Adobe AIRで作るデスクトップアプリケーション

第11回 コピー&ペーストとドラッグ&ドロップ

この記事を読むのに必要な時間:およそ 6.5 分

基本はClipboardクラス

デスクトップアプリケーションの多くは,コピー&ペーストやドラッグ&ドロップによるデータの受け渡しに対応しています。もちろんAdobe AIRにもそういったインターフェースを実装するためAPIが用意されていますので,今回はそれついて解説したいと思います。

コピー&ペーストにしてもドラッグ&ドロップにしても,受け渡しを行うデータを一時的に格納しておく場所が必要です。AIR APIでその役割を担うのがClipboardクラス(flash.desktopパッケージ)です。Clipboardオブジェクトには以下の形式のデータを格納できます。

形式ActionScriptのデータ型
ビットマップBitmapData
ファイルリストFileオブジェクトのArray
テキストString
URLString
シリアライズされたオブジェクト
オブジェクトの参照

ビットマップ/ファイルリスト/テキスト/URLの4つ(以下,標準フォーマット)は,AIRアプリケーションとその他のアプリケーション間でやりとりが可能です。ActionScriptのデータ型とOSのクリップボード形式は自動で相互変換されます。シリアライズされたオブジェクトはAIRアプリケーション間でのみ有効で,例えばActionScriptの基本オブジェクトをやりとりしたい場合などに使います。シリアライズ/デシリアライズはAIR側で自動的に行われますが,正しく処理できないデータは無効になります。オブジェクトの参照は,同一AIRアプリケーション内でのみ利用できます。

Clipboardオブジェクトには,複数の形式のデータを一度に設定することができます。これは別のアプリケーションから少しでもデータを利用しやすくするためです。例えばビットマップを渡したい場合でも,それを受け取ったアプリケーションが直接ビットマップを扱えるとは限りません。そういった場合に備えて,代替テキストやビットマップの元になったファイル等を一緒に渡しておくことができるわけです。

コピー&ペースト

では,具体的にコピー&ペーストの手順を見ていきましょう。通常,OSのクリップボードは一つしかないため,それに対応するClipboardオブジェクトも一つで十分です。Clipboardクラスにはそのためのシングルトンオブジェクトが用意されており,generalClipboardという静的プロパティでアクセスできる仕組みになっています。

var clipboard:Clipboard = Clipboard.generalClipboard;

このClipboardオブジェクトにデータを設定すれば,OSのクリップボードにデータをコピーしたことになります。データの設定にはsetData()メソッドを使います。次のサンプルは,ボタンをクリックするとクリップボードにテキストをコピーします。

<?xml version="1.0" encoding="utf-8"?>
<mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" layout="absolute">
  <mx:Script>
     <![CDATA[
      private function copyToClipboard():void {
        var clipboard:Clipboard = Clipboard.generalClipboard;
        clipboard.clear();
        var ok:Boolean = clipboard.setData(ClipboardFormats.TEXT_FORMAT, "AIRでコピー&ペースト");
      }
    ]]>
  </mx:Script>
  <mx:Button x="10" y="10" label="Copy" click="copyToClipboard()"/>
</mx:WindowedApplication>

このように,第1パラメータにデータ形式,第2パラメータに実際のデータを指定します。データが正しく設定されるとtrueが返ります。データ形式はClipboardFormatsクラス(flash.desktopパッケージ)の定数として定義されています。

ClipboardFormats.BITMAP_FORMATビットマップ
ClipboardFormats.FILE_LIST_FORMATファイルリスト
ClipboardFormats.TEXT_FORMATテキスト
ClipboardFormats.URL_FORMATURL

setData()を実行すると,同じ形式の古いデータは上書きされます。ただし違う形式のデータはそのまま残ってしまうため,あらかじめclear()メソッドで消去しています。

今度はクリップボードからのペーストです。Clipboardオブジェクトからデータを取得するにはgetData()メソッドを使います。また,hasFormat()メソッドで取得したいデータ形式が含まれているか調べられます。どちらのメソッドもパラメータにデータ形式を指定します。次のサンプルは,ボタンをクリックするとクリップボードのテキストをテキストエリアに表示します。

<?xml version="1.0" encoding="utf-8"?>
<mx:WindowedApplication xmlns:mx="http://www.adobe.com/2006/mxml" layout="absolute">
  <mx:Script>
    <![CDATA[
      private function pasteFromClipboard():void {
        var clipboard:Clipboard = Clipboard.generalClipboard;
        if (clipboard.hasFormat(ClipboardFormats.TEXT_FORMAT)) {
          output.text = clipboard.getData(ClipboardFormats.TEXT_FORMAT) as String;
        }
      }
    ]]>
  </mx:Script>
  <mx:Button x="10" y="10" label="Paste" click="pasteFromClipboard()"/>
  <mx:TextArea x="10" y="40" id="output"/>
</mx:WindowedApplication>

カスタムフォーマット

標準フォーマット以外の形式でやりとりしたい場合は,カスタムフォーマットを指定します。カスタムフォーマットの名前は任意に付けられますが,他のAIRアプリケーションと重複しないユニークなものが推奨されています("air:"または"flash:"で始まる名前は使えません)。以下のコードではカスタムフォーマットでDateオブジェクトの受け渡しを行っています。

//コピーする側
var clipboard:Clipboard = Clipboard.generalClipboard;
clipboard.clear();
clipboard.setData("jp.gihyo.example", new Date(), true);

//ペーストする側
var clipboard:Clipboard = Clipboard.generalClipboard;
if (clipboard.hasFormat("jp.gihyo.example")) {
  var date:Date = clipboard.getData("jp.gihyo.example", ClipboardTransferMode.CLONE_ONLY) as Date;
  trace(date.getFullYear() + "/" + (date.getMonth() + 1) + "/" + date.getDate());
}

ここでは,カスタムフォーマットとして"jp.gihyo.example"を指定しているのが分かると思います。また,コピーする側ではsetData()メソッドの第3パラメータ(以下,serializableパラメータ)にtrueを指定しています。serializableパラメータをtrueにすると,クリップボードには指定オブジェクトの参照とシリアライズされたデータの両方が格納されます(trueの指定は省略可能)。falseの場合は参照しか格納されず,他のAIRアプリケーションからはアクセスできません。

ペーストする側では,getData()を行う際に第2パラメータ(以下,transferModeパラメータ)を指定しています。これは,オブジェクトの参照とシリアライズされたデータのどちらを取得するかを指定するパラメータです。transferModeパラメータに指定する値は,ClipboardTransferModeクラス(flash.desktopパッケージ)の定数として定義されています。

ClipboardTransferMode.CLONE_ONLYシリアライズされたデータのみを取得
ClipboardTransferMode.CLONE_PREFERREDシリアライズされたデータを優先して取得,なければ参照を取得
ClipboardTransferMode.ORIGINAL_ONLY参照のみを取得
ClipboardTransferMode.ORIGINAL_PREFERRED参照を優先して取得,なければシリアライズされたデータを取得

なお,標準フォーマット対するtransferModeパラメータの指定は無視されます。

著者プロフィール

タナカヤスヒロ

早稲田大学卒業後,DTP業務を経てマルチメディア系制作会社へ。Macromedia Directorにのめり込む。フリーランスとなりFlashにシフトしてからもデスクトップ絡みの仕事が絶えず,Apolloにも勝手に縁を感じている。現在株式会社antsに所属。ants Lab.にも記事を上げている。

URLhttp://labs.anthill.jp/

著書

コメント

コメントの記入