檢視原始碼

就像使用者可以檢視在網頁瀏覽器顯示 HTML 頁面的原始碼,使用者也可以檢視 HTML 類型 AIR 應用程式的原始碼。Adobe® AIR® SDK 包含一個 AIRSourceViewer.js JavaScript 檔案,可加至應用程式中以方便使用者檢視原始碼。

載入、設定和開啟來源檢視器

「來源檢視器」程式碼包含在 JavaScript 檔案 AIRSourceViewer.js 中,該檔案位於 AIR SDK 架構目錄內。若要在應用程式中使用「來源檢視器」,請將 AIRSourceViewer.js 複製至應用程式專案目錄,然後在應用程式的主要 HTML 檔案中使用 script 標籤載入該檔案:

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

AIRSourceViewer.js 檔案定義一個名為 SourceViewer 的類別,您可以從 JavaScript 程式碼中呼叫 air.SourceViewer 來存取該類別。

SourceViewer 類別定義 3 個方法: getDefault() setup() viewSource()

方法

說明

getDefault()

靜態方法。可傳回 SourceViewer 實體,供您呼叫其他方法。

setup()

可將組態設定套用至「來源檢視器」。如需詳細資訊,請參閱 設定來源檢視器

viewSource()

可開啟新視窗,供使用者瀏覽和開啟管理應用程式的原始檔案。

備註: 使用「來源檢視器」的程式碼必須位於應用程式安全執行程序中 (在應用程式目錄內的一個檔案中)。

例如,下列 JavaScript 程式碼可實體化「來源檢視器」物件,並開啟「來源檢視器」視窗,其中列出所有原始檔案。

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

設定來源檢視器

config() 方法可將指定的設定套用至「來源檢視器」。這個方法有一個參數: 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 座標。

例如,下列 JavaScript 程式碼會在螢幕座標 [40, 60] (X = 40, Y = 60) 的位置開啟「來源檢視器」視窗。

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

modal

這個 Boolean 值指定「來源檢視器」是否開啟為強制回應 (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 應用程式會開啟「來源檢視器」視窗。該視窗包含一個原始檔案和目錄的清單 (在左邊),和一個顯示所選檔案之原始碼的區域 (在右邊):

目錄列出在括號內。使用者可以按一下括號來展開或收合目錄的清單。

「來源檢視器」可以顯示具有可辨識之副檔名的文字檔案 (例如,HTM、JS、TXT、XML 和其他格式),或具有可辨識之影像副檔名的影像檔案 (JPG、JPEG、PNG 和 GIF) 的原始碼。如果使用者選取沒有可辨識副檔名的檔案,將會顯示錯誤訊息(「無法從這個檔案類型擷取文字內容」)。

任何透過 setup() 方法排除的原始檔案將不會列示出來 (請參閱 載入、設定和開啟來源檢視器 )。