public abstract class ServiceUIFactory extends Object
Although the Print Service API does not presently provide standardised support for administering a print service, monitoring of the print service is possible and a UI may provide for private update mechanisms.
The basic design intent is to allow applications to lazily locate and initialize services only when needed without any API dependencies except in an environment in which they are used.
Swing UIs are preferred as they provide a more consistent L&F and can support accessibility APIs.
Example usage:
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); } }
Modifier and Type | Field | Description |
---|---|---|
static final int |
ABOUT_UIROLE |
Denotes a UI which performs an informative "About" role. |
static final int |
ADMIN_UIROLE |
Denotes a UI which performs an administrative role. |
static final String |
DIALOG_UI |
Denotes a UI implemented as an AWT dialog. |
static final String |
JCOMPONENT_UI |
Denotes a UI implemented as a Swing component. |
static final String |
JDIALOG_UI |
Denotes a UI implemented as a Swing dialog. |
static final int |
MAIN_UIROLE |
Denotes a UI which performs the normal end user role. |
static final String |
PANEL_UI |
Denotes a UI implemented as an AWT panel. |
static final int |
RESERVED_UIROLE |
Not a valid role but role id's greater than this may be used for private roles supported by a service. |
Modifier | Constructor | Description |
---|---|---|
protected |
Constructor for subclasses to call. |
Modifier and Type | Method | Description |
---|---|---|
abstract Object |
getUI |
Get a UI object which may be cast to the requested UI type by the application and used in its user interface. |
abstract String[] |
getUIClassNamesForRole |
Given a UI role obtained from this factory obtain the UI types available from this factory which implement this role. |
public static final String JCOMPONENT_UI
public static final String PANEL_UI
public static final String DIALOG_UI
public static final String JDIALOG_UI
public static final int ABOUT_UIROLE
public static final int ADMIN_UIROLE
public static final int MAIN_UIROLE
public static final int RESERVED_UIROLE
protected ServiceUIFactory()
public abstract Object getUI(int role, String ui)
role
- requested. Must be one of the standard roles or a private role supported by this factory.ui
- type in which the role is requestednull
if the requested UI role is not available from this factoryIllegalArgumentException
- if the role or ui is neither one of the standard ones, nor a private one supported by the factorypublic abstract String[] getUIClassNamesForRole(int role)
Strings
should refer to the static variables defined in this class so that applications can use equality of reference ("==").role
- to be looked upnull
if no UIs are available for the roleIllegalArgumentException
- is the role is a non-standard role not supported by this factory
© 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