APIdia Launch Partner
Top Description Fields Constructors Methods
javax.print

public abstract Class ServiceUIFactory

extends Object
Class Inheritance
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 TypeField and Description
public static final int
ABOUT_UIROLE

Denotes a UI which performs an informative "About" role.

public static final int
ADMIN_UIROLE

Denotes a UI which performs an administrative role.

public static final String
DIALOG_UI

Denotes a UI implemented as an AWT dialog.

public static final String
JCOMPONENT_UI

Denotes a UI implemented as a Swing component.

public static final String
JDIALOG_UI

Denotes a UI implemented as a Swing dialog.

public static final int
MAIN_UIROLE

Denotes a UI which performs the normal end user role.

public static final String
PANEL_UI

Denotes a UI implemented as an AWT panel.

public 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.

Constructor Summary

AccessConstructor and Description
protected
ServiceUIFactory()

Constructor for subclasses to call.

Method Summary

Modifier and TypeMethod and Description
public abstract Object

Returns:

the UI role or null if the requested UI role is not available from this factory
getUI(int
requested. Must be one of the standard roles or a private role supported by this factory.
role, String
type in which the role is requested
ui)

Get a UI object which may be cast to the requested UI type by the application and used in its user interface.

public abstract String[]

Returns:

the UI types supported by this class for the specified role, null if no UIs are available for the role
getUIClassNamesForRole(int
to be looked up
role)

Given a UI role obtained from this factory obtain the UI types available from this factory which implement this role.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ABOUT_UIROLEback to summary
public static final int ABOUT_UIROLE

Denotes a UI which performs an informative "About" role.

ADMIN_UIROLEback to summary
public static final int ADMIN_UIROLE

Denotes a UI which performs an administrative role.

DIALOG_UIback to summary
public static final String DIALOG_UI

Denotes a UI implemented as an AWT dialog. The value of the string is the fully qualified classname : "java.awt.Dialog"

JCOMPONENT_UIback to summary
public static final String JCOMPONENT_UI

Denotes a UI implemented as a Swing component. The value of the string is the fully qualified classname : "javax.swing.JComponent".

JDIALOG_UIback to summary
public static final String JDIALOG_UI

Denotes a UI implemented as a Swing dialog. The value of the string is the fully qualified classname : "javax.swing.JDialog"

MAIN_UIROLEback to summary
public static final int MAIN_UIROLE

Denotes a UI which performs the normal end user role.

PANEL_UIback to summary
public static final String PANEL_UI

Denotes a UI implemented as an AWT panel. The value of the string is the fully qualified classname : "java.awt.Panel"

RESERVED_UIROLEback to summary
public 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. Knowledge of the function performed by this role is required to make proper use of it.

Constructor Detail

ServiceUIFactoryback to summary
protected ServiceUIFactory()

Constructor for subclasses to call.

Method Detail

getUIback to summary
public abstract Object getUI(int role, String ui)

Get a UI object which may be cast to the requested UI type by the application and used in its user interface.

Parameters
role:int

requested. Must be one of the standard roles or a private role supported by this factory.

ui:String

type in which the role is requested

Returns:Object

the UI role or null if the requested UI role is not available from this factory

Exceptions
IllegalArgumentException:
if the role or ui is neither one of the standard ones, nor a private one supported by the factory
getUIClassNamesForRoleback to summary
public 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. The returned Strings should refer to the static variables defined in this class so that applications can use equality of reference ("==").

Parameters
role:int

to be looked up

Returns:String[]

the UI types supported by this class for the specified role, null if no UIs are available for the role

Exceptions
IllegalArgumentException:
is the role is a non-standard role not supported by this factory