Просмотр исходного кода

Загрузка, настройка и открытие объекта просмотра исходного кода
- Настройка объекта просмотра исходного кода
- Открытие объекта просмотра исходного кода
Интерфейс пользователя для объекта просмотра исходного кода

Подобно тому как пользователь может просматривать исходный код для HTML-страницы в веб-обозревателе, пользователи могут просматривать исходный код HTML-приложений AIR. Adobe® AIR® SDK включает файл AIRSourceViewer.js на языке JavaScript, который можно использовать в приложении для удобной демонстрации исходного кода конечным пользователям.

Загрузка, настройка и открытие объекта просмотра исходного кода

Код объекта просмотра исходного кода содержится в файле JavaScript (AIRSourceViewer.js), который находится в каталоге frameworks пакета AIR SDK. Чтобы использовать объект просмотра исходного кода в своем приложении, скопируйте файл AIRSourceViewer.js в каталог проекта приложения и загрузите файл с помощью тега скрипта в основной HTML-файл приложения.

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

Файл AIRSourceViewer.js определяет класс SourceViewer, к которому можно обращаться из кода JavaScript путем вызова air.SourceViewer .

Класс SourceViewer определяет три метода: getDefault() , setup() и viewSource() .

Метод	Описание
`getDefault()`	Статический метод. Запускает экземпляр SourceViewer, который можно использовать для вызова других методов.
`setup()`	Применяет настройки конфигурации к объекту просмотра исходного кода. Дополнительные сведения см. в разделе « Настройка объекта просмотра исходного кода »
`viewSource()`	Открывает новое окно, в котором пользователь может выполнить поиск и открыть файлы источника приложения.

Примечание. Код, использующий класс SourceViewer, должен находиться в изолированной программной среде приложения (в файле, находящемся в каталоге приложения).

Например, следующий код JavaScript создает экземпляр объекта SourceViewer и открывает окно просмотра кода источника, в котором перечислены все файлы источников:

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

Настройка объекта просмотра исходного кода

Применение метода config() передает настройки объекту просмотра исходного кода. Этот метод использует один параметр: configObject . Объект configObject содержит свойства, определяющие настройки конфигурации для объекта просмотра исходного кода. К этим свойствам относятся default , exclude , initialPosition , modal , typesToRemove и typesToAdd .

default

Строка, указывающая относительный путь к исходному файлу, который будет отображаться в объекте просмотра исходного кода.

Например, следующий код JavaScript открывает окно Source Viewer с файлом 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

Логическое значение, указывающее, должно ли окно объекта просмотра исходного кода быть модальным (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>

Интерфейс пользователя для объекта просмотра исходного кода

Когда приложение вызывает метод viewSource() объекта SourceViewer, приложение AIR открывает окно просмотра исходного кода. В окне отображаются список файлов источников и каталогов (слева), а также область просмотра исходного кода для выбранного файла (справа).

Полноразмерное изображение

Каталоги в списке выделяются скобками. Пользователь может щелкнуть фигурную скобку, чтобы развернуть или свернуть список данного каталога.

Объект просмотра исходного кода может отображать источники для текстовых файлов с известными расширениями (такими как HTML, JS, TXT, XML и т.д.) или для файлов изображений с известными расширениями (JPG, JPEG, PNG и GIF). Если пользователь выбирает файл, расширение которого не известно, отображается сообщение об ошибке («Не удается извлечь текстовое содержимое из файла данного типа»).

Любые файлы источников, которые исключены при помощи метода setup() , не указываются в списке (см. раздел « Загрузка, настройка и открытие объекта просмотра исходного кода »).