java.lang.Object
javax.print.ServiceUIFactory
Services may optionally provide UIs which allow different styles of
interaction in different roles. One role may be end-user browsing and setting
of print options. Another role may be administering the print service.
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); } }
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Denotes a UI which performs an informative "About" role.static final int
Denotes a UI which performs an administrative role.static final String
Denotes a UI implemented as an AWT dialog.static final String
Denotes a UI implemented as a Swing component.static final String
Denotes a UI implemented as a Swing dialog.static final int
Denotes a UI which performs the normal end user role.static final String
Denotes a UI implemented as an AWT panel.static final int
Not a valid role but role id's greater than this may be used for private roles supported by a service. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract Object
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
(int role) Given a UI role obtained from this factory obtain the UI types available from this factory which implement this role.
-
Field Details
-
JCOMPONENT_UI
Denotes a UI implemented as a Swing component. The value of the string is the fully qualified classname : "javax.swing.JComponent".- See Also:
-
PANEL_UI
Denotes a UI implemented as an AWT panel. The value of the string is the fully qualified classname : "java.awt.Panel"- See Also:
-
DIALOG_UI
Denotes a UI implemented as an AWT dialog. The value of the string is the fully qualified classname : "java.awt.Dialog"- See Also:
-
JDIALOG_UI
Denotes a UI implemented as a Swing dialog. The value of the string is the fully qualified classname : "javax.swing.JDialog"- See Also:
-
ABOUT_UIROLE
public static final int ABOUT_UIROLEDenotes a UI which performs an informative "About" role.- See Also:
-
ADMIN_UIROLE
public static final int ADMIN_UIROLEDenotes a UI which performs an administrative role.- See Also:
-
MAIN_UIROLE
public static final int MAIN_UIROLEDenotes a UI which performs the normal end user role.- See Also:
-
RESERVED_UIROLE
public static final int RESERVED_UIROLENot a valid role but role id's greater than this may be used for private roles supported by a service. Knowledge of the function performed by this role is required to make proper use of it.- See Also:
-
-
Constructor Details
-
ServiceUIFactory
protected ServiceUIFactory()Constructor for subclasses to call.
-
-
Method Details
-
getUI
Get a UI object which may be cast to the requested UI type by the application and used in its user interface.- Parameters:
role
- requested. Must be one of the standard roles or a private role supported by this factory.ui
- type in which the role is requested- Returns:
- the UI role or
null
if the requested UI role is not available from this factory - Throws:
IllegalArgumentException
- if the role or ui is neither one of the standard ones, nor a private one supported by the factory
-
getUIClassNamesForRole
Given a UI role obtained from this factory obtain the UI types available from this factory which implement this role. The returnedStrings
should refer to the static variables defined in this class so that applications can use equality of reference ("==").- Parameters:
role
- to be looked up- Returns:
- the UI types supported by this class for the specified role,
null
if no UIs are available for the role - Throws:
IllegalArgumentException
- is the role is a non-standard role not supported by this factory
-