ソースコードの表示

Web ブラウザーで HTML ページのソースコードを表示できるのと同じように、ユーザーは HTML ベースの AIR アプリケーションのソースコードを表示できます。Adobe® AIR® SDK には、AIRSourceViewer.js という JavaScript ファイルが含まれています。このファイルをアプリケーションで使用すると、ソースコードをエンドユーザーに簡単に表示できます。

ソースビューアの読み込み、設定、および開始

ソースビューアのコードは、AIR SDK の frameworks ディレクトリにある AIRSourceViewer.js という JavaScript ファイルに含まれています。アプリケーションでソースビューアを使用するには、AIRSourceViewer.js をアプリケーションのプロジェクトディレクトリにコピーし、アプリケーションのメインの HTML ファイルでスクリプトタグを使用してファイルを読み込みます。 

<script type="text/javascript" src="AIRSourceViewer.js"></script>

AIRSourceViewer.js ファイルは SourceViewer クラスを定義します。このクラスに JavaScript コードからアクセスするには、 air.SourceViewer を呼び出します。

SourceViewer クラスは、 getDefault() 、 setup() 、および viewSource() の 3 つのメソッドを定義します。

メソッド

説明

getDefault()

静的メソッド。他のメソッドの呼び出しに使用できる SourceViewer インスタンスを返します。

setup()

設定をソースビューアに適用します。詳しくは、 ソースビューアの設定 を参照してください。

viewSource()

ユーザーがホストアプリケーションのソースファイルを参照して開くことができる新しいウィンドウを開きます。

注意： ソースビューアを使用するコードは、アプリケーションセキュリティサンドボックス内（アプリケーションディレクトリ内のファイル）に含まれている必要があります。

例えば、次の JavaScript コードでは、Source Viewer オブジェクトをインスタンス化して、すべてのソースファイルをリスト表示するソースビューアウィンドウを開きます。 

var viewer = air.SourceViewer.getDefault(); 
viewer.viewSource();

ソースビューアの設定

config() メソッドは特定の設定をソースビューアに適用します。このメソッドは 1 つのパラメーター、 configObject を取得します。 configObject オブジェクトには、ソースビューアの設定を定義するプロパティがあります。このプロパティは、 default 、 exclude 、 initialPosition 、 modal 、 typesToRemove 、 typesToAdd です。

default

ソースビューアに表示される初期ファイルの相対パスを指定するストリング。

例えば、次の JavaScript コードでは、初期ファイルとして index.html ファイルが表示されるソースビューアウィンドウが開きます。 

var viewer = air.SourceViewer.getDefault(); 
var configObj = {}; 
configObj.default = "index.html"; 
viewer.viewSource(configObj);

exclude

ソースビューアのリストから除外されるファイルまたはディレクトリを指定するストリングの配列。このパスはアプリケーションディレクトリに対する相対パスです。ワイルドカード文字はサポートされません。

例えば、次の JavaScript コードでは AIRSourceViewer.js ファイルと、Images および Sounds サブディレクトリ内のファイルを除くすべてのソースファイルをリスト表示するソースビューアウィンドウが開きます。 

var viewer = air.SourceViewer.getDefault(); 
var configObj = {}; 
configObj.exclude = ["AIRSourceViewer.js", "Images" "Sounds"]; 
viewer.viewSource(configObj);

initialPosition

ソースビューアウィンドウの初期 x 座標と初期 y 座標を指定する 2 つの数値を含む配列。

例えば、次の JavaScript コードはスクリーン座標 [40, 60] (X = 40, Y = 60) にソースビューアウィンドウを開きます。 

var viewer = air.SourceViewer.getDefault(); 
var configObj = {}; 
configObj.initialPosition = [40, 60]; 
viewer.viewSource(configObj);

modal

ソースビューアをモーダル（true）ウィンドウと非モーダル（false）ウィンドウのどちらにするかを指定するブール値。デフォルトではソースビューアはモーダルです。

例えば、次の JavaScript コードは、ソースビューアウィンドウを開き、ソースビューアウィンドウおよび他のアプリケーションウィンドウの両方で操作できるようにします。 

var viewer = air.SourceViewer.getDefault(); 
var configObj = {}; 
configObj.modal = false; 
viewer.viewSource(configObj);

typesToAdd

デフォルトで含まれる種類に加えてソースビューアのリストに含めるファイルの種類を指定するストリングの配列。

デフォルトでは、ソースビューアで次のファイルの種類がリスト表示されます。

  • テキストファイル — TXT、XML、MXML、HTM、HTML、JS、AS、CSS、INI、BAT、PROPERTIES、CONFIG

  • 画像ファイル — JPG、JPEG、PNG、GIF

    値を指定しない場合、デフォルトの種類がすべて含まれます（ typesToExclude プロパティで指定されたファイルの種類は除外されます）。

    例えば、次の JavaScript コードでは VCF ファイルと VCARD ファイルを含むソースビューアウィンドウが開きます。 

    var viewer = air.SourceViewer.getDefault(); 
var configObj = {}; 
configObj.typesToAdd = ["text.vcf", "text.vcard"]; 
viewer.viewSource(configObj);

    リスト表示するファイルの種類ごとに、「text」（テキストファイルの場合）または「image」（画像ファイルの場合）を指定する必要があります。

typesToExclude

ソースビューアから除外するファイルの種類を指定するストリングの配列。

デフォルトでは、ソースビューアで次のファイルの種類がリスト表示されます。

  • テキストファイル — TXT、XML、MXML、HTM、HTML、JS、AS、CSS、INI、BAT、PROPERTIES、CONFIG

  • 画像ファイル — JPG、JPEG、PNG、GIF

    例えば、次の JavaScript コードでは、GIF ファイルまたは XML ファイルがリスト表示されずにソースビューアウィンドウが開きます。 

    var viewer = air.SourceViewer.getDefault(); 
var configObj = {}; 
configObj.typesToExclude = ["image.gif", "text.xml"]; 
viewer.viewSource(configObj);

    リスト表示するファイルの種類ごとに、「 text 」（テキストファイルの場合）または「 image 」（画像ファイルの場合）を指定する必要があります。

ソースビューアの開始

リンク、ボタン、メニューコマンドなどのユーザーインターフェイスエレメントを含めて、ユーザーがそのインターフェイスを選択するとソースビューアコードが呼び出されるようにする必要があります。例えば、次の簡単なアプリケーションでは、ユーザーがリンクをクリックするとソースビューアが開きます。 

<html> 
    <head> 
        <title>Source Viewer Sample</title> 
        <script type="text/javascript" src="AIRSourceViewer.js"></script> 
        <script type="text/javascript"> 
            function showSources(){ 
                var viewer = air.SourceViewer.getDefault(); 
                viewer.viewSource() 
            } 
        </script> 
    </head> 
    <body> 
        <p>Click to view the source files.</p> 
        <input type="button"  
            onclick="showSources()"  
            value="View Source" /> 
    </body> 
</html>

ソースビューアのユーザーインターフェイス

アプリケーションが SourceViewer オブジェクトの viewSource() メソッドを呼び出すと、AIR アプリケーションでソースビューアウィンドウが開きます。このウィンドウには、ソースファイルとディレクトリのリスト（左側）、および選択したファイルのソースコードを示す表示領域（右側）があります。

フルサイズのグラフィックを表示

ディレクトリは、括弧内に示されます。ユーザーは括弧をクリックしてディレクトリのリストを展開または折りたたむことができます。

ソースビューアでは、認識される拡張子（HTML、JS、TXT、XML など）の付いたテキストファイルのソース、および認識される画像拡張子（JPG、JPEG、PNG、および GIF）の付いた画像ファイルのソースを表示できます。認識されない種類の拡張子が付いたファイルをユーザーが選択した場合、エラーメッセージが表示されます（「Cannot retrieve text content from this filetype」）。

setup() メソッドを使用して除外されたソースファイルはリスト表示されません（ ソースビューアの読み込み、設定、および開始 を参照）。