Spec-Zone.ru › OpenJDK 21

Класс ServiceUIFactory

java.lang.Object
javax.print.ServiceUIFactory
public abstract class ServiceUIFactory extends Object
Сервисы могут по желанию предоставлять пользовательские интерфейсы (UI), которые позволяют использовать различные стили взаимодействия в разных ролях. Одна роль может быть просмотром конечного пользователя и настройкой параметров печати. Другая роль может быть администрированием службы печати.

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

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

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

Пример использования:

  ServiceUIFactory factory = printService.getServiceUIFactory();
  if (factory != null) {
      JComponent swingui = (JComponent)factory.getUI(
                                         ServiceUIFactory.MAIN_UIROLE,
                                         ServiceUIFactory.JCOMPONENT_UI);
      if (swingui != null) {
          tabbedpane.add("Custom UI", swingui);
      }
  }
 

Краткое описание полей

Модификатор и тип Поле Описание
static final int ABOUT_UIROLE
Обозначает пользовательский интерфейс, выполняющий информационную роль "О программе".
static final int ADMIN_UIROLE
Обозначает пользовательский интерфейс, выполняющий административную роль.
static final String DIALOG_UI
Обозначает пользовательский интерфейс, реализованный как диалоговое окно AWT.
static final String JCOMPONENT_UI
Обозначает пользовательский интерфейс, реализованный как компонент Swing.
static final String JDIALOG_UI
Обозначает пользовательский интерфейс, реализованный как диалоговое окно Swing.
static final int MAIN_UIROLE
Обозначает пользовательский интерфейс, выполняющий обычную роль конечного пользователя.
static final String PANEL_UI
Обозначает пользовательский интерфейс, реализованный как панель AWT.
static final int RESERVED_UIROLE
Не является допустимой ролью, но идентификаторы ролей, большие чем этот, могут использоваться для частных ролей, поддерживаемых сервисом.

Краткое описание конструкторов

ServiceUIFactory()
Модификатор Конструктор Описание
protected
Конструктор для вызова подклассами.

Краткое описание методов

Модификатор и тип Метод Описание
abstract Object getUI(int role, String ui)
Получить объект пользовательского интерфейса, который может быть преобразован к запрошенному типу пользовательского интерфейса приложением и использован в его пользовательском интерфейсе.
abstract String[] getUIClassNamesForRole(int role)
На основе роли пользовательского интерфейса, полученной из этого фабричного класса, получить типы пользовательских интерфейсов, доступных от этого фабричного класса, которые реализуют данную роль.

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание полей

JCOMPONENT_UI

public static final String JCOMPONENT_UI
Обозначает пользовательский интерфейс, реализованный как компонент Swing. Значение строки - полное имя класса: "javax.swing.JComponent".
См. также:
  • Значения константных полей

PANEL_UI

public static final String PANEL_UI
Обозначает пользовательский интерфейс, реализованный как панель AWT. Значение строки - полное имя класса: "java.awt.Panel"
См. также:
  • Значения константных полей

DIALOG_UI

public static final String DIALOG_UI
Обозначает пользовательский интерфейс, реализованный как диалоговое окно AWT. Значение строки - полное имя класса: "java.awt.Dialog"
См. также:
  • Значения константных полей

JDIALOG_UI

public static final String JDIALOG_UI
Обозначает пользовательский интерфейс, реализованный как диалоговое окно Swing. Значение строки - полное имя класса: "javax.swing.JDialog"
См. также:
  • Значения константных полей

ABOUT_UIROLE

public static final int ABOUT_UIROLE
Обозначает пользовательский интерфейс, выполняющий информационную роль "О программе".
См. также:
  • Значения константных полей

ADMIN_UIROLE

public static final int ADMIN_UIROLE
Обозначает пользовательский интерфейс, выполняющий административную роль.
См. также:
  • Значения константных полей

MAIN_UIROLE

public static final int MAIN_UIROLE
Обозначает пользовательский интерфейс, выполняющий обычную роль конечного пользователя.
См. также:
  • Значения константных полей

RESERVED_UIROLE

public static final int RESERVED_UIROLE
Не является допустимой ролью, но идентификаторы ролей, большие чем этот, могут использоваться для частных ролей, поддерживаемых сервисом. Для правильного использования требуется знание функции, выполняемой этой ролью.
См. также:
  • Значения константных полей

Подробное описание конструкторов

ServiceUIFactory

protected ServiceUIFactory()
Конструктор для вызова подклассами.

Подробное описание методов

getUI

public abstract Object getUI(int role, String ui)
Получить объект пользовательского интерфейса, который может быть преобразован к запрошенному типу пользовательского интерфейса приложением и использован в его пользовательском интерфейсе.
Параметры:
role - запрошенная. Должна быть одной из стандартных ролей или частной ролью, поддерживаемой этим фабричным классом.
ui - тип, в котором запрашивается роль
Возвращает:
роль UI или null если запрошенная роль UI недоступна от этого фабричного класса
Исключения:
IllegalArgumentException - если роль или UI не являются ни одной из стандартных, ни одной из частных, поддерживаемых фабрикой

getUIClassNamesForRole

public abstract String[] getUIClassNamesForRole(int role)
На основе роли пользовательского интерфейса, полученной из этого фабричного класса, получить типы пользовательских интерфейсов, доступных от этого фабричного класса, которые реализуют данную роль. Возвращаемые Strings должны ссылаться на статические переменные, определенные в этом классе, чтобы приложения могли использовать равенство ссылок ("==").
Параметры:
role - для поиска
Возвращает:
типы UI, поддерживаемые этим классом для указанной роли, null если для роли нет доступных UI
Исключения:
IllegalArgumentException - если роль - нестандартная, не поддерживаемая данным фабричным классом

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/print/ServiceUIFactory.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API