Справочник стран

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

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

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

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

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

Бандл list-countries-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
grid.row.height=22
 

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

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

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

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

Поля записи

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

ISO_alpha3, ISO_alpha2, ISO_num, Валюта номер, Валюта код
являются не обязательными для заполнения.

Флаг
Флаги стран в виде изображениий/файлов с расширением ".png", подгружаемые модулем при старте, располагаются в поддиректории «images/flag». Наименование флага/файла должно завершаться значением "_" + ISO_alpha3 + "_" + ISO_num + ".png". К примеру, модуль подгружает флаг "images/flag/Cuba_cub_192.png" для выделенной на скриншоте страны/записи «Куба» с кодами ISO_alpha3="CUB" и ISO_num=192. Значение символьного поля ISO_alpha3 «приводится» к нижнему регистру.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Зависимости

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

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

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

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

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

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

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

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

Рассмотренный на странице модуль упакован в архивный файл list-countries.zip, имеющий размер 186 Кб. В архив модуля включен файл с инициализационными справочными записями «data.init/list_countries.txt» и поддиректория с флагами стран «images/flags/».