Class ServiceUIFactory

java.lang.Object

javax.print.ServiceUIFactory

public abstract class ServiceUIFactory
extends Object

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

Fields

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.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServiceUIFactory()	Constructor for subclasses to call.

Method Summary

Modifier and Type	Method	Description
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.
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.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Field Details

JCOMPONENT_UI

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

See Also:

• Constant Field Values

PANEL_UI

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"

See Also:

• Constant Field Values

DIALOG_UI

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"

See Also:

• Constant Field Values

JDIALOG_UI

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"

See Also:

• Constant Field Values

ABOUT_UIROLE

public static final int ABOUT_UIROLE

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

See Also:

• Constant Field Values

ADMIN_UIROLE

public static final int ADMIN_UIROLE

Denotes a UI which performs an administrative role.

See Also:

• Constant Field Values

MAIN_UIROLE

public static final int MAIN_UIROLE

Denotes a UI which performs the normal end user role.

See Also:

• Constant Field Values

RESERVED_UIROLE

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.

See Also:

• Constant Field Values

Constructor Details

ServiceUIFactory

protected ServiceUIFactory()

Constructor for subclasses to call.

Method Details

getUI

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

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