Справочник регионов

Модуль list-regions версии 1.0.0 предназначен для управления cправочником регионов приложения на платформе JaBricks. Интерфейс формы справочника локализован для нескольких языков и позволяет просматривать добавлять, изменять и удалять записи. Справочник регионов может функционировать в виде диалогового окна JDialog или в виде панели JPanel, которую можно встраивать в контейнер главного фрейма, либо в контейнер другого бандла.

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

При выделении в таблице одной из записей её параметры отображаются в полях формы. Параметры записи можно изменить и сохранить, либо изменить и добавить как новую запись, либо удалить.

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

Настройка титульной панели

Бандл list-regions-1.0.0.jar содержит файл properties/settings.properties, контент которого представлен ниже :

title.panel.draw=true
title.panel.height=28
title.panel.background=216,216,216
title.panel.button.close=true
 

Настройки в файле settings.properties представлены в формате ключ=значение :

• title.panel.draw — флаг представления в интерфейсе титульной панели; при значении false, титульная панель не отображается.
• title.panel.height — высота титульной панели в пикселях.
• title.panel.background — цвет фона титульной панели в формате RGB.
• title.panel.button.close — флаг представления расположенной справа иконки закрытия панели.

Интерфейсные настройки

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

Поля записи

Код и наименование
Поля «Код» и «Наименование» являются обязательными для заполнения. Дублирование значений полей не допускается.

ОКАТО, ОКТМО, ISO-3166.E2
Не обязательные для заполнения поля «ОКАТО ОКТМО», «ISO-3166.E2».

Активность
Запись региона можно активировать/деактивировать. Флаг активности позволяет показать/скрыть справочные записи регионов в связанных формах.

Локализация интерфейса и данных

Интерфейсная форма, предупреждающие сообщения и данные справочника регионов локализованы. Модуль list-regions подписан на рассылку сообщения по смене текущего языка локализации jabricks/LocaleEvent. Изменение в приложении JaBricks текущего объекта локализации Locale автоматически переведет интерфейс справочника и данные на новый язык локализации без перезагрузки. Локализованные ресурсы интерфейса модуля включены в бандл. Значение текущего языка локализации модуль получает в утилите управления внешними ресурсами util-resources. Модуль включает три языка локализации : русский, английский, немецкий.

Справочная таблица БД

Записи справочника хранятся в базе данных (БД) в таблице jbt_regions. Для установления связи с сервером БД list-regions использует модуль util-db, позволяющего взаимодействовать с несколькими разнотипными SQL-серверами.

Модуль list-regions включает методы создания таблицы и инициализации справочных записей. При первом (после инсталляции в приложение) старте модуля в БД создается таблица jbt_regions, в таблицу записываются инсталляционные справочные данные. При последующем использовании справочника регионов выполняется только проверка наличия таблицы jbt_regions в соответствующей структуре БД. Инсталляционные справочные записи регионов модуль загружает в БД из внешнего файла data.init/list_regions.txt.

Примечание :
1. Справочник регионов следует использовать совместно с другими рабочими таблицами.
2. Чтобы случайным образом не удалить связанную запись региона необходимо использовать ключи Foreign Key во внешних таблицах.

Выполнение транзакций

Перед добавлением или обновлением записи выполняется проверка заполнения обязательных полей и дублирования записей. Если одно из обязательных полей не будет заполнено, либо будут найдены дублирующие записи, то выполнение операции будет прервано выводом соответствующего сообщения в дополнительном диалоговом окне. Не допускается дублирование записей полей «Код» и «Наименование».

Добавление записи

Чтобы добавить новую запись необходимо заполнить поля формы и нажать кнопку «Добавить».

Обновление записи

Чтобы обновить какой-либо регион необходимо выделить в таблице запись, внести изменения в поля формы и нажать кнопку «Сохранить».

Удаление записи

Удаление можно выполнить только после получения подтверждения. Т.е. после выделения записи и нажатии на кнопку «Удалить» модуль откроет окно подтверждения выполнения указанной транзакции.

Зависимости

Модуль list-regions версии 1.0.0 связан со следующими бандлами платформы JaBricks :

• util-resources; модуль предоставляет текущую Locale для локализации интерфейса, данных и сообщений при выполнении транзакций;
• util-db; модуль используется для установления соединения с сервером БД, проверки наличия справочной таблицы jbt_regions, выполнения операций чтения, записи, обновления и удаления.
• gui-widgets; модуль с компонентами определения интерфейса формы.
• base-universal; базовый модуль формирования интерфейса формы.

Справочник регионов версии 1.0.0, связанный с базовым модулем base-universal, требует при старте определение параметра guimode для определения формы интерфейса (JDialog, JPanel). Параметр guimode определяется в XML-структуре описания главного меню приложения или панели инструментов. Подробнее об этом представлено в описании использования модуля base-universal на странице Урок 14 и на странице примера templ-universal с комментариями к исходным кодам.

Подключение модуля list-regions

Для подключения модуля list-regions в приложение JaBricks необходимо :

• разместить модуль в поддиректории «configuration/bundles»;
• внести в файл инициализации бандлов «bundles.ini» запись «list-regions-1.0.0.jar»
• определить пункт меню и/или кнопку панели инструментов, параметрами подключения которых указать GAV значения бандла list-regions.

GAV параметры модуля list-regions имеют следующие значения :

Подробнее о включении модуля в приложение Jabricks представлено здесь.

Рассмотренный на странице модуль упакован в архивный файл list-regions.zip, имеющий размер 36 Кб. В архив модуля включен файл с инициализационными справочными записями data.init/list_regions.txt.