javax.print

クラス ServiceUIFactory

java.lang.Object

javax.print.ServiceUIFactory

public abstract class ServiceUIFactory
extends Object

サービスは、オプションで UI を提供することができます。UI を使用すると、ロールごとに異なるスタイルの対話処理を実行できます。あるロールではエンドユーザーによるブラウズおよび印刷オプションの設定を行い、別のロールでは印刷サービスの管理を行うことができます。

現在のところ、Print Service API は印刷サービス管理の標準化されたサポートを提供していませんが、印刷サービスの監視、および UI を利用した非公開の更新メカニズムを提供可能です。

基本的な設計目的は、必要な場合にだけ、API に依存しない方法で (使用環境を除く)、アプリケーションからのサービスの遅延検出および初期化を実行可能にすることです。

Swing UI はより一貫した L&F を提供し、Accessibility API をサポート可能であるため、Swing UI の使用をお勧めします。

使用例:

  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 int	ABOUT_UIROLE 有用な "About" ロールを実行する UI であることを示します。
static int	ADMIN_UIROLE 管理ロールを実行する UI であることを示します。
static String	DIALOG_UI UI が AWT ダイアログとして実装されていることを示します。
static String	JCOMPONENT_UI UI が Swing コンポーネントとして実装されていることを示します。
static String	JDIALOG_UI UI が Swing ダイアログとして実装されていることを示します。
static int	MAIN_UIROLE 通常のエンドユーザーロールを実行する UI であることを示します。
static String	PANEL_UI UI が AWT パネルとして実装されていることを示します。
static int	RESERVED_UIROLE 有効なロールではなく、これよりも値の大きなロール ID を、サービスのサポートする非公開ロールで使用できます。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ServiceUIFactory()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract Object	getUI(int role, String ui) アプリケーションにより要求される UI タイプにキャスト可能で、そのユーザーインタフェースで使用可能な UI オブジェクトを取得します。
abstract String[]	getUIClassNamesForRole(int role) このファクトリから取得した UI ロールを指定すると、このロールを実装するこのファクトリから利用可能な UI タイプが取得されます。

クラス java.lang.Object から継承されたメソッド

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

フィールドの詳細

JCOMPONENT_UI

public static final String JCOMPONENT_UI

UI が Swing コンポーネントとして実装されていることを示します。String の値は、完全指定されたクラス名 "javax.swing.JComponent" になります。

関連項目:

定数フィールド値

PANEL_UI

public static final String PANEL_UI

UI が AWT パネルとして実装されていることを示します。String の値は、完全指定されたクラス名 "java.awt.Panel" になります。

関連項目:

定数フィールド値

DIALOG_UI

public static final String DIALOG_UI

UI が AWT ダイアログとして実装されていることを示します。String の値は、完全指定されたクラス名 "java.awt.Dialog" になります。

関連項目:

定数フィールド値

JDIALOG_UI

public static final String JDIALOG_UI

UI が Swing ダイアログとして実装されていることを示します。String の値は、完全指定されたクラス名 "javax.swing.JDialog" になります。

関連項目:

定数フィールド値

ABOUT_UIROLE

public static final int ABOUT_UIROLE

有用な "About" ロールを実行する UI であることを示します。

関連項目:

定数フィールド値

ADMIN_UIROLE

public static final int ADMIN_UIROLE

管理ロールを実行する UI であることを示します。

関連項目:

定数フィールド値

MAIN_UIROLE

public static final int MAIN_UIROLE

通常のエンドユーザーロールを実行する UI であることを示します。

関連項目:

定数フィールド値

RESERVED_UIROLE

public static final int RESERVED_UIROLE

有効なロールではなく、これよりも値の大きなロール ID を、サービスのサポートする非公開ロールで使用できます。このロールを適切に使用するには、ロールが実行する関数に関する知識が必要です。

関連項目:

定数フィールド値

コンストラクタの詳細

ServiceUIFactory

public ServiceUIFactory()

メソッドの詳細

getUI

public abstract Object getUI(int role,
           String ui)

アプリケーションにより要求される UI タイプにキャスト可能で、そのユーザーインタフェースで使用可能な UI オブジェクトを取得します。

パラメータ:

role - 要求されたロール。どれかの標準ロール、またはこのファクトリがサポートする非公開ロールでなければならない。

ui - ロールが要求されるタイプ。

戻り値:

UI ロール。または、要求された UI ロールがこのファクトリで使用できない場合は null

例外:

IllegalArgumentException - ロールまたは UI が、標準ロールのどれでもなく、ファクトリがサポートする非公開ロールでもない場合。

getUIClassNamesForRole

public abstract String[] getUIClassNamesForRole(int role)

このファクトリから取得した UI ロールを指定すると、このロールを実装するこのファクトリから利用可能な UI タイプが取得されます。返される String は、アプリケーションが "==" (参照が等しい) を使用できるようにするため、このクラス内で定義される static 変数を参照しなければいけません。

パラメータ:

role - ルックアップ対象のロール。

戻り値:

指定されたロールで、このクラスがサポートする UI タイプ。 ロールで使用可能な UI が存在しない場合は null。

例外:

IllegalArgumentException - ロールが、このファクトリでサポートされていない非標準ロールの場合。