Базовый модуль JDialog

Базовый модуль base-jdialog, выполненный по технологии OSGi, существенно облегчает и ускоряет формирование графического интерфейса всплывающего окна типа JDialog библиотеки Swing. Модуль base-jdialog следует использовать в качестве родительского для создания интерфейсного бандла приложения JaBricks. Основные функциональные свойства модуля обеспечивают :

• формирования структуры бандла;
• чтение ресурсных файлов бандла;
• сохранение и восстановление регулируемых настроек интерфейса;
• логирование сообщений;
• подписку на сообщения подключения к серверу БД;
• подписку на сообщения локализации интерфейса.

Структура модуля, представленная на скриншоте, включает следующие классы :

Классы модуля

JBDialogActivator

Класс JBDialogActivator наследует (extends) свойства активатора BundleActivator и включает следующие методы :

Примечание :
1. Механизм «подписки» реализуется в классе активатора. То есть, все «публикуемые» сообщения, на которые «подписался» бандл, поступают в активатор бандла.
2. Метод сохранения настроек интерфейса saveComponentParams вызывается в методе stop при останове бандла. Если необходимо сохранять настройки интерфейсной формы бандла метод необходимо переопределить (см. пример templ-jdialog).

Класс JBDialog

Класс JBDialog включает поля и методы для создания интерфейса окна типа JDialog.

Конструктор класса

Класс JBDialog имеет 1 конструктор, которому в качестве параметров передается контекст бандла :

public JBDialog (final BundleContext context);

Поля класса JBDialog

В листинге представлены доступные поля класса. Общие модификаторы полей вынесены в отдельную строку комментария; закоментированные модификаторы относятся ко всем нижеследующим полям до следующего комментария.

Листинг

// protected

BundleContext  context       = null;
Locale         locale        = null;
JPanel         desk          = null;
JSplitPane     splitDesk     = null;
JPanel         pnlButtons    = null;
	
List<ComponentParams> cparams;
Dimension      form_dim     = null;
	
int            HGAP          =  5;
int            BUTTON_width  = 90;
int            BUTTON_height = 24;
    
// protected static final

String BUTTON_OK             = "OK";

String OptionPane_yes_btn    = "OptionPane.yesButtonText"   ;
String OptionPane_no_btn     = "OptionPane.noButtonText"    ;
String OptionPane_cancel_btn = "OptionPane.cancelButtonText";
String OptionPane_ok_btn     = "OptionPane.okButtonText"    ;

context
контекст бандла.

locale
объект текущей локализации интерфейса приложения, определяемый либо конструктором класса, либо устанавливаемый методом changeLocale (Locale).

pnlDesk
панель размещения визуальных компонентов интерфейса, занимаемая основную часть формы.

splitDesk
разделяемая на две горизонтальные части панель типа JSplitPane для размещения визуальных компонентов интерфейса; занимает основную часть формы.

pnlButtons
панель кнопок управления, размещаемая в нижней части формы.

cparams
список объектов описания изменяемых настроек объектов интерфейса, формируемый при чтении параметров интерфейса.

form_dim
объект описания размера формы, получаемый при чтении параметров интерфейса.

HGAP
параметр, определяющий интервал между кнопками управления.

BUTTON_width
параметр, определяющий размер кнопки управления по ширине.

BUTTON_height
параметр, определяющий размер кнопки управления по высоте.

BUTTON_OK
текстовая константа, используемая в качестве заголовок кнопки «ОК».

OptionPane_yes_btn
текстовая константа, используемая для локализации надписи кнопки Yes в диалоговом окне OptionPane.

OptionPane_no_btn
текстовая константа, используемая для локализации надписи кнопки No в диалоговом окне OptionPane.

OptionPane_cancel_btn
текстовая константа, используемая для локализации надписи кнопки Cancel в диалоговом окне OptionPane.

OptionPane_ok_btn
текстовая константа, используемая для локализации надписи кнопки Ok в диалоговом окне OptionPane.

Методы класса JBDialog

В следующей таблице приведены protected-методы класса JBDialog :

Получение текущего объекта локализации

В методе чтения ресурсных свойств бандла используется объект локализации. Ниже представлен пример получения текущего объекта локализации с использованием утилиты ресурсов util-resources :

IResources resources = new ResourcesImpl();
Locale     locale    = resources.getLocale();

Литинг метода createDesk

Метод createDesk создает панель типа JPanel и определяет рабочую область, устанавливая Border с отступами в 12 пикселей.

/**
 * Метод создания панели pnlDesk
 */
protected void createDesk()
{
    // Панель для размещение компонентов
    pnlDesk = new JPanel();
    /*
     * Определение отступов
     */
    pnlDesk.setBorder (BorderFactory
                      .createEmptyBorder(2, 2, 2, 2));
}

Литинг метода createSplitDesk

Метод createSplitDesk создает splitDesk, определяет размер (DIVIDER_SIZE) и положение (divider_loc) сепаратора. Значение DIVIDER_SIZE определено в интерфейсных константах IWidgetsConstants модуля gui-widgets.

/**
 * Метод создания панели JSplitPane
 */
protected void createSplitDesk(final int divider_loc)
{
    splitDesk = new JSplitPane(
                         JSplitPane.HORIZONTAL_SPLIT,true);
//  splitDesk.setOneTouchExpandable(true);
    splitDesk.setEnabled(false);
    // Размер разделяемого сепаратора
    splitDesk.setDividerSize(DIVIDER_SIZE);
    // Положение разделяемой панели
    splitDesk.setDividerLocation(divider_loc); 
}

Класс подписки LocaleSubscriber

Класс LocaleSubscriber предназначен для обработки сообщения локализации интерфейса приложения. Экземпляр этого класса включается в механизм «подписки» на сообщения «jabricks/LocaleEvent». При поступлении данного типа сообщения вызывается метод активатора changeLocale(Locale) с параметром нового объекта локализации.

Класс подписки ConnectSubscriber

Класс ConnectSubscriber предназначен для обработки сообщения соединения с сервером БД. Экземпляр этого класса включается в механизм «подписки» на сообщения «jabricks/DBConnect». При поступлении данного типа сообщения вызывается метод активатора changeConnect().

Класс ComponentParams

ComponentParams используется для описания изменяемых параметров (размер, положение) объектов типа JSplitPane, JTable. В листинге класса методы get/set не представлены.

public class ComponentParams
{
    private  String  clazz   ;
    private  String  name    ;
    private  int     location;
    private  String  columns ;

    public ComponentParams() {}

    public ComponentParams(String clazz, String name)
    {
        this.clazz = clazz;
        this.name = name;
    }

    // Методы get/set
    ...
}

Пример создания интерфейсного модуля

Как было отмечено выше, базовый модуль base-jdialog следует использовать в качестве родительского для создания интерфейсного модуля приложения JaBricks. Пример создания интерфейсного модуля представлен здесь.

Зависимости

Базовый модуль base-jdialog функционирует вместе со следующими бандлами приложения JaBricks :

Подключение модуля к приложению

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

• разместить модуль в поддиректории «configuration/bundles/»
• внести в файл инициализации бандлов «configuration/bundles.ini» запись : base-jdialog-1.0.0.jar

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

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

Скачать base-jdialog

Рассмотренный на странице базовый модуль создания диалогового окна base-jdialog упакован в архивный файл base-jdialog-1.0.0.zip (15.7 Кб).