.. _gs3_images_scala_images:

Изображения ресурсов прикладного проекта
==========================================

:term:`Application Server` предоставляет API для работы с :term:`изображениями ресурсов прикладного проекта <Изображение ресурсов прикладного проекта>`.

.. seealso::

    .. dropdown:: Свойства в метаданных Postgres решения

        **Редакторы атрибута**

        - :xsd:attr:`Редактор-изображение (Icon) -> Свойство imageCollectionName <View.Representation.Attributes.Attribute.Editor.Icon.imageCollectionName>`
        - :xsd:attr:`Редактор-изображение (Icon) -> Свойство imageCollectionKind <View.Representation.Attributes.Attribute.Editor.Icon.imageCollectionKind>`

        - :xsd:attr:`Редактор-выпадающий список изображений (ImageCollection) -> Свойство imageCollectionName <View.Representation.Attributes.Attribute.Editor.ImageCollection.imageCollectionName>`
        - :xsd:attr:`Редактор-выпадающий список изображений (ImageCollection) -> Свойство imageCollectionKind <View.Representation.Attributes.Attribute.Editor.ImageCollection.imageCollectionKind>`

        **Фреймы**

        - :xsd:attr:`Закладки (Tab) -> Закладки (TabItems) -> Свойство imageUriAttr <View.Representation.Layout.Frame.Tab.TabItems.imageUriAttr>`

        **Компоновщики**

        - :xsd:attr:`Закладки (TabComposer) -> Закладки (TabItems) -> Свойство selection.imageUriAttr <View.Representation.Layout.TabComposer.TabItems.selection.imageUriAttr>`
        - :xsd:attr:`Закладки (TabComposer) -> Закладки (TabItems) -> Закладка (TabItem) -> Свойство imageUri <View.Representation.Layout.TabComposer.TabItems.TabItem.imageUri>`

        **Перечисления**

        - :xsd:attr:`Источник коллекции изображений (ImageCollectionKinds) <View.Representation.Attributes.Attribute.Editor.ImageCollectionKinds>`

    .. dropdown:: Свойства в GTK Core API

        - :java:type:`AnnotatedMetaOper -> Свойство imageUri <AnnotatedMetaOper.imageUri>`

        **Редакторы атрибута**

        - :java:type:`Редактор-изображение (Icon) -> Свойство imageCollectionName <Icon.imageCollectionName>`
        - :java:type:`Редактор-изображение (Icon) -> Свойство imageCollectionKind <Icon.imageCollectionKind>`
        - :java:type:`Редактор-выпадающий список изображений (ImageCollection) -> Свойство imageCollectionName <ImageCollection.imageCollectionName>`
        - :java:type:`Редактор-выпадающий список изображений (ImageCollection) -> Свойство imageCollectionKind <ImageCollection.imageCollectionKind>`

        **Фреймы**

        - :java:type:`Закладки (Tab) -> Закладки (TabItems) -> Свойство imageUriAttr <TabFrameItems.imageUriAttr>`

        **Компоновщики**

        - :java:type:`Закладки (TabComposer) -> Закладки (TabItems) -> Свойство imageUriAttr <TabItems.imageUriAttr>`
        - :java:type:`Закладки (TabComposer) -> Закладки (TabItems) -> Закладка (TabItem) -> Свойство imageUri <TabItem.imageUri>`

        **Перечисления**

        - :java:type:`Источник коллекции изображений (ImageCollectionKinds) <ImageCollectionKinds>`

Назначение
----------

:term:`Изображения ресурсов прикладного проекта <Изображение ресурсов прикладного проекта>` используются для хранения уникальных или редко применяемых изображений, которые нецелесообразно добавлять в :term:`коллекции изображений <Коллекция изображений>`,
так как они предназначены исключительно для конкретного прикладного проекта.

Хранение
--------

Изображения располагаются внутри каталога ``КореньПроекта/Модуль/src/main/resources`` прикладного проекта.

Поддерживаемые форматы
-----------------------

- ``.jpeg``
- ``.jpg``
- ``.png``
- ``.ico``
- ``.svg``

Получение изображений
----------------------

Доступ к изображениям ресурсов прикладного проекта осуществляется при помощи:

1. :ref:`EngineEndpoint.get_resource_image <uri_endpoint_reference_get_resource_image>`
2. :ref:`Сервис загрузки ресурсных файлов <gs3_rest_resources>`

Рекомендации
------------

- Используйте изображения ресурсов прикладного проекта для уникальных или редко используемых графических ресурсов, предназначенных исключительно для конкретного прикладного приложения.
- Не добавляйте такие изображения в :term:`коллекции изображений <Коллекция изображений>`, если они не повторяются в интерфейсе и не имеют общего размера или тематики.
- При значительном количестве изображений рекомендуется объединять их в :term:`коллекцию изображений <Коллекция изображений>` для уменьшения числа сетевых запросов и ускорения загрузки интерфейса.

.. _gs3_images_scala_images_using_in_applied_code:

Использование в прикладном коде
---------------------------------

В этом разделе описана спецификация работы с изображениями ресурсов прикладного проекта на уровне метаданных/API элементов интерфейса.

Краткое описание использования коллекций изображений в прикладном коде: Укажите путь до изображения относительно ресурсов прикладного проекта — см. :ref:`Путь до изображения в ресурсах прикладного проекта <gs3_images_scala_images_using_in_applied_code_image_uri>`.

.. _gs3_images_scala_images_using_in_applied_code_image_uri:

Путь до изображения относительно ресурсов прикладного проекта
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

.. attention::

    Если в метаданных/API одновременно указаны :ref:`Номер изображения в коллекции изображений <gs3_images_image_collections_using_in_applied_code_image_index>` и :ref:`Путь до изображения относительно ресурсов прикладного проекта <gs3_images_scala_images_using_in_applied_code_image_uri>`, то будет выбрано изображение, которое хранится в ресурсах прикладного проекта.

В метаданных/API наименование свойства должно содержать ``imageUri``.

Способы задания пути до изображения относительно ресурсов прикладного проекта:

1. **Прямое значение**. В свойство записывается путь до изображения относительно ресурсов прикладного проекта.
2. **Ссылка на атрибут**. В свойство записывается наименование атрибута, где хранится путь до изображения относительно ресурсов прикладного проекта.

Примеры значений: ``toolbarprimary/0.png``, ``imagecollections/somecollection/0.svg``.

.. dropdown:: Пример (Разметка закладки)

    .. code-block:: XML

        <tabItem id="0"
                 selection="someselection"
                 representation="somerepresentation"
                 caption="Закладка 1"
                 imageUri="toolbarprimary/0.png"/>