gui_BrowserFrame.adoc

BrowserFrame

API DOCS

Компонент BrowserFrame предназначен для включения веб-страницы на страницу приложения. Это аналог HTML-элемента iframe.

XML-имя компонента: browserFrame

Компонент реализован для блока Web Client.

Пример использования компонента browserFrame в XML-дескрипторе экрана:

link:../../../../../../source/gui_vcl/gui_browserFrame.xml[role=include]

Подобно компоненту Image, BrowserFrame также можно использовать для отображения графического содержимого из различных источников. Тип ресурса можно указать декларативно с помощью элементов browserFrame, перечисленных ниже:

• classpath - ресурс, расположенный в classpath.

  link:../../../../../../source/gui_vcl/gui_browserFrame_1.xml[role=include]

• file - файл с изображением.

  link:../../../../../../source/gui_vcl/gui_browserFrame_2.xml[role=include]

• relativePath - относительный путь к файлу в каталоге приложения.

  link:../../../../../../source/gui_vcl/gui_browserFrame_3.xml[role=include]

• theme - ресурс из темы приложения, например:

  link:../../../../../../source/gui_vcl/gui_browserFrame_4.xml[role=include]

• url - ресурс, загружаемый по URL.

  link:../../../../../../source/gui_vcl/gui_browserFrame_5.xml[role=include]

Атрибуты browserFrame:

• alternateText - устанавливает альтернативный текст на случай, если ресурс недоступен или не задан.

Параметры ресурсов browserFrame:

• bufferSize - размер буфера, используемого для загрузки этого ресурса, в байтах.

  link:../../../../../../source/gui_vcl/gui_browserFrame_6.xml[role=include]

• cacheTime - время хранения объекта в кэше в миллисекундах.

  link:../../../../../../source/gui_vcl/gui_browserFrame_7.xml[role=include]

• mimeType - MIME-тип ресурса.

  link:../../../../../../source/gui_vcl/gui_browserFrame_8.xml[role=include]

Методы интерфейса BrowserFrame:

• addSourceChangeListener() - добавляет слушатель для отслеживания изменений источника содержимого.

  link:../../../../../../source/gui_vcl/gui_browserFrame_11.java[role=include]

• setSource() - устанавливает источник содержимого фрейма. Метод принимает тип ресурса и возвращает объект ресурса, который может быть сконфигурирован далее. Для каждого типа ресурсов есть свои методы, например, setPath() для ThemeResource или setStreamSupplier() для StreamResource:

  link:../../../../../../source/gui_vcl/gui_browserFrame_9.java[role=include]

  Вы можете использовать те же типы ресурсов, что и для компонента Image.

• createResource() - создаёт ресурс фрейма указанного типа. Созданный объект может быть позже передан в метод setSource():

  link:../../../../../../source/gui_vcl/gui_browserFrame_10.java[role=include]

Отображение HTML в BrowserFrame:

Компонент BrowserFrame можно использовать для встраивания HTML-разметки в приложение. К примеру, вы можете генерировать HTML на лету, используя пользовательский ввод в качестве ресурса:

link:../../../../../../source/gui_vcl/gui_browserFrame_12.xml[role=include]

link:../../../../../../source/gui_vcl/gui_browserFrame_13.java[role=include]

Отображение PDF в BrowserFrame:

Кроме HTML, BrowserFrame также может отображать содержимое PDF-файлов. Задайте путь к файлу в качестве ресурса для компонента и укажите для него соответствующий MIME-тип:

link:../../../../../../source/gui_vcl/gui_browserFrame_14.java[role=include]

---

Атрибуты browserFrame

align - alternateText - caption - colspan - description - enable - height - icon - id - responsive - rowspan - stylename - visible - width

Атрибуты ресурсов browserFrame

bufferSize - cacheTime - mimeType

Элементы browserFrame

classpath - file - relativePath - theme - url

API

addSourceChangeListener - createResource - setSource

---