Visa källkod

Läsa in, konfigurera och öppna Source Viewer
- Konfigurera Source Viewer
- Öppna Source Viewer
Användargränssnitt i Source Viewer

Precis som en användare kan visa källkod för en HTLM-sida i en webbläsare kan han/hon visa källkoden för ett HTML-baserat AIR-program. I Adobe® AIR® SDK finns JavaScript-filen AIRSourceViewer.js som du kan använda i programmet för att visa källkoden för slutanvändarna.

Läsa in, konfigurera och öppna Source Viewer

Koden för Source Viewer finns i JavaScript-filen, AIRSourceViewer.js, som ingår i ramverkskatalogen för AIR SDK. Om du vill använda Source Viewer i ditt program ska du kopiera AIRSourceViewer.js till programmets projektkatalog och läsa in filen via en script-tagg i HTML-huvudfilen i programmet:

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

I AIRSourceViewer.js-filen definieras en klass, SourceViewer, som du kommer åt från JavaScript-koden genom att anropa air.SourceViewer .

SourceViewer-klassen definierar tre metoder: getDefault() , setup() och viewSource() .

Metod	Beskrivning
`getDefault()`	En statisk metod. Den returnerar en SourceViewer-instans som du kan använda för att anrop de andra metoderna.
`setup()`	Tillämpar konfigurationsinställningar för Source Viewer. Mer information finns i Konfigurera Source Viewer
`viewSource()`	Öppnar ett nytt fönster där användaren kan bläddra och öppna källfiler för värdprogrammet.

Obs! Kod där Source Viewer används måste finnas i programmets säkerhetssandlåda (i en fil i programkatalogen).

I följande JavaScript-kod instansieras ett Source Viewer-objeket och Source Viewer-fönstret öppnas med alla källfiler synliga:

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

Konfigurera Source Viewer

Metoden config() tilldelar givna inställningar till Source Viewer. Den här metoden har en parameter: configObject . Objekten configObject har egenskaper som definierar konfigurationsinställningar för Source Viewer. Egenskaperna är default , exclude , initialPosition , modal , typesToRemove och typesToAdd .

default

En sträng som definierar den relativa sökvägen till den första filen som ska visas i Source Viewer.

Med exempelvis följande JavaScript-kod öppnas Source Viewer-fönstret med filen index.html som den första filen:

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

exclude

En strängmatris som definierar filer eller kataloger som inte ska finnas med i listan i Source Viewer. Sökvägen är relativ till programkatalogen. Jokertecken får inte användas.

I exempelvis följande JavaScript-kod öppnas Source Viewer-fönstret med alla källfiler med undantag för filen AIRSourceViewer.js och filerna i underkatalogerna Images och Sounds:

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

initialPosition

En matris som innehåller två tal för de inledande x- och y-koordinaterna för Source Viewer-fönstret.

I följande JavaScript-exempel öppnas Source Viewer-fönstret vid koordinaterna [40, 60] (X = 40, Y = 60):

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

modal

Ett booleskt värde som anger om Source Viewer ska vara ett modalt ("true") eller ett icke-modalt ("false") fönster. Standard är att Source Viewer-fönstret är modalt.

I följande JavaScript-exempel öppnas Source Viewer-fönstret så att användaren kan använda både Source Viewer-fönstret och andra programfönster:

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

typesToAdd

En matris med strängar som används för att ange filtyper som ska ingå i Source Viewer-listan, förutom de standardtyper som ingår.

Standard är att följande filtyper finns i Source Viewer:

Textfiler – TXT, XML, MXML, HTM, HTML, JS, AS, CSS, INI, BAT, PROPERTIES och CONFIG
Bildfiler – JPG, JPEG, PNG och GIF

Om inget värde anges ingår alla standardtyper, förutom de som anges i egenskapen typesToExclude .

I exempelvis följande JavaScript-kod öppnas Source Viewer-fönstret med VCF- och VCARD-filer:
```
var viewer = air.SourceViewer.getDefault(); 
var configObj = {}; 
configObj.typesToAdd = ["text.vcf", "text.vcard"]; 
viewer.viewSource(configObj);
```
För varje filtyp som du anger måste du även ange "text" (för textfiler) eller "image" (för bildfiler).

typesToExclude

En matris med strängar som anger filtyperna som ska tas bort från Source Viewer.

Standard är att följande filtyper finns i Source Viewer:

Textfiler – TXT, XML, MXML, HTM, HTML, JS, AS, CSS, INI, BAT, PROPERTIES och CONFIG
Bildfiler – JPG, JPEG, PNG och GIF

I exempelvis följande JavaScript-kod ska Source Viewer-fönstret öppnas utan GIF- eller XML-filer:
```
var viewer = air.SourceViewer.getDefault(); 
var configObj = {}; 
configObj.typesToExclude = ["image.gif", "text.xml"]; 
viewer.viewSource(configObj);
```
För varje filtyp som du anger måste du även ange "text" (för textfiler) eller "image" (för bildfiler).

Öppna Source Viewer

Du ska även ta med element för användargränssnittet, exempelvis länkar, knappar eller menykommandon, som anropar Source Viewer-koden när användaren använder elementet. I följande exempel öppnas i Source Viewer ett enkelt program när användaren klickar på en länk:

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

Användargränssnitt i Source Viewer

När programmet anropar metoden viewSource() för ett SourceViewer-objekt, öppnas i AIR-programmet ett Source Viewer-fönster. I fönstret finns en lista med källfiler och kataloger (till vänster) och ett visningsområde där källkoden för den markerade filen visas (till höger):

Visa grafik i full storlek

Kataloger visas inom hakparenteser. Användaren kan klicka på en parentes för att expandera eller minimera kataloglistan.

I Source Viewer går det att visa källan för textfiler med godkända filtillägg (till exempel HTML, JS, TXT och XML) eller för bildfiler med godkända filtillägg (JPG, JPEG, PNG och GIF). Ett felmeddelande visas om användaren markerar en fil med ett otillåtet filtillägg ["Cannot retrieve text content from this filetype" ("Det går inte att hämta textinnehåll från filer med den här filtypen")].

De källfiler som exkluderades med metoden setup() visas inte (se Läsa in, konfigurera och öppna Source Viewer ).