Wyświetlanie kodu źródłowego

Kod źródłowy aplikacji AIR z kodem HTML można wyświetlać, podobnie jak kod źródłowy strony HTML w przeglądarce internetowej. Program Adobe® AIR® SDK zawiera plik JavaScript AIRSourceViewer.js, który może być używany w aplikacji, aby ułatwić wyświetlanie kodu źródłowego użytkownikom końcowym.

    Ładowanie, konfigurowanie i otwieranie przeglądarki źródła

    Kod przeglądarki źródła jest zawarty w pliku JavaScript AIRSourceViewer.js, który znajduje się w katalogu infrastruktury pakietu AIR SDK. W celu korzystania z przeglądarki źródła w aplikacji należy skopiować plik AIRSourceViewer.js do katalogu projektu aplikacji i załadować go za pośrednictwem znacznika script w głównym pliku HTML aplikacji:

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

    Plik AIRSourceViewer.js definiuje klasę SourceViewer, do której dostęp można uzyskać z kodu JavaScript poprzez wywołanie air.SourceViewer.

    Klasa SourceViewer definiuje trzy metody: getDefault(), setup() i viewSource().

    Metoda

    Opis

    getDefault()

    Metoda statyczna. Zwraca instancję klasy SourceViewer, której można użyć w celu wywołania innych metod.

    setup()

    Powoduje stosowanie ustawień konfiguracji do przeglądarki źródła. Szczegółowe informacje zawiera sekcja Konfigurowanie przeglądarki źródła

    viewSource()

    Otwiera nowe okno, w którym można przeglądać i otwierać pliki źródłowe aplikacji głównej.
    Uwaga: Kod korzystający z przeglądarki źródła musi znajdować się w bezpiecznym obszarze izolowanym aplikacji (w pliku w katalogu aplikacji).

    Przykład: poniższy kod JavaScript tworzy instancję klasy SourceViewer i otwiera okno przeglądarki źródła zawierające wszystkie pliki źródłowe:

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

      Konfigurowanie przeglądarki źródła

      Metoda config() powoduje stosowanie określonych ustawień do przeglądarki źródła. Ta metoda przyjmuje jeden parametr: configObject. Obiekt configObject zawiera właściwości, które definiują ustawienia konfiguracji dla przeglądarki źródła. Właściwości są następujące: default, exclude, initialPosition, modal, typesToRemove i typesToAdd.

      default

      Ciąg znaków określający ścieżkę względną do pliku początkowego, który ma być wyświetlany w przeglądarce źródła.

      Na przykład: poniższy kod JavaScript powoduje otwarcie okna przeglądarki źródła z plikiem index.html wyświetlonym jako plik początkowy:

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

      exclude

      Tablica ciągów znaków określająca pliki lub katalogi, które mają zostać wykluczone z listingu w przeglądarce źródła. Ścieżki są określone względem katalogu aplikacji. Znaki wieloznaczne nie są obsługiwane.

      Na przykład: poniższy kod JavaScript powoduje otwarcie okna przeglądarki źródła z wszystkimi plikami źródłowymi oprócz pliku AIRSourceViewer.js oraz plików w podkatalogach Images i Sounds:

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

      initialPosition

      Tablica, która zawiera dwie liczby określające początkowe współrzędne x i y okna przeglądarki źródła.

      Na przykład: poniższy kod JavaScript powoduje otwarcie okna przeglądarki źródła na współrzędnych [40, 60] (X = 40, Y = 60):

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

      modal

      Wartość logiczna, która określa, czy przeglądarka źródła powinna być oknem modalnym (true), czy niemodalnym (false). Domyślnie okno przeglądarki źródła jest modalne.

      Na przykład: poniższy kod JavaScript powoduje otwarcie okna przeglądarki źródła w taki sposób, który umożliwia użytkownikowi pracę z oknem przeglądarki źródła i dowolnymi innymi oknami aplikacji:

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

      typesToAdd

      Tablica ciągów znaków określających typy plików, jakie będą uwzględniane w listingu przeglądarki źródła (oprócz typów domyślnych).

      Domyślnie w przeglądarce źródła wyświetlane są pliki następujących typów:

      • Pliki tekstowe — TXT, XML, MXML, HTM, HTML, JS, AS, CSS, INI, BAT, PROPERTIES, CONFIG

      • Pliki graficzne — JPG, JPEG, PNG, GIF

        Jeśli nie określono żadnej wartości, wyświetlane będą wszystkie typy domyślne (z wyjątkiem określonych we właściwości typesToExclude).

        Na przykład: poniższy kod JavaScript powoduje otwarcie okna przeglądarki źródła z plikami VCF i VCARD:

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

        Dla każdego typu pliku należy określić "text" (w przypadku plików tekstowych) lub "image" (dla plików graficznych).

      typesToExclude

      Tablica ciągów znaków, która określa typy plików, które nie będą wyświetlane w przeglądarce źródła.

      Domyślnie w przeglądarce źródła wyświetlane są pliki następujących typów:

      • Pliki tekstowe — TXT, XML, MXML, HTM, HTML, JS, AS, CSS, INI, BAT, PROPERTIES, CONFIG

      • Pliki graficzne — JPG, JPEG, PNG, GIF

        Na przykład poniższy kod JavaScript powoduje otwarcie okna przeglądarki źródła bez plików GIF i XML:

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

        Dla każdego typu pliku należy określić "text" (w przypadku plików tekstowych) lub "image" (dla plików graficznych).

      Otwieranie przeglądarki źródła

      W aplikacji należy udostępnić element interfejsu użytkownika, taki jak odsyłacz, przycisk lub polecenie menu, którego kliknięcie będzie powodowało wywołanie kodu przeglądarki źródła. Przykład: poniższa prosta aplikacja otwiera przeglądarkę źródła, gdy użytkownik kliknie odsyłacz:

      <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>

      Interfejs użytkownika przeglądarki źródła

      Gdy aplikacja wywoła metodę viewSource() obiektu SourceViewer, aplikacja AIR otwiera okno przeglądarki źródła. Okno zawiera listę plików źródłowych i katalogów (po lewej stronie) oraz obszar, w którym wyświetlany jest kod źródłowy wybranego pliku (po prawej stronie):

      Powiększ obraz

      Nazwy katalogów są podawane w nawiasach kwadratowych. W celu rozwinięcia lub zwinięcia listingu katalogu wystarczy kliknąć nawias.

      W przeglądarce można wyświetlać źródła plików tekstowych o znanych rozszerzeniach (takich jak HTML, JS, TXT i XML) oraz plików graficznych o znanych rozszerzeniach (JPG, JPEG, PNG i GIF). Jeśli użytkownik wybierze plik, którego rozszerzenie nie jest znane, pojawi się komunikat o błędzie („Nie można uzyskać treści tekstu z pliku tego typu”).

      Pliki wykluczone za pomocą metody setup() nie są wyświetlane (informacje zawiera sekcja Ładowanie, konfigurowanie i otwieranie przeglądarki źródła).