javax.print
Class ServiceUIFactory

java.lang.Object
  extended by javax.print.ServiceUIFactory

public abstract class ServiceUIFactory
extends Object

ServiceUIFactory enables print services to provide additional user interface dialogs.

A print service may provide a ServiceUIFactory implementation if its getServiceUIFactory() method is called. If a factory object is returned it can be queried for provided user interface dialogs. Different roles are defined to denote dialogs providing informations about the print service, dialogs for administration of a print service and for end-user browsing dialogs.

The factory can support providing these UI roles in different dialog types (AWT, Swing, JComponent, Panel). The support and use of Swing interfaces is however preferred.


Field Summary
static int ABOUT_UIROLE
          A user interface providing informations about the print service.
static int ADMIN_UIROLE
          A user interface to administer the print service.
static String DIALOG_UI
          Identifies a UI provided as an AWT dialog.
static String JCOMPONENT_UI
          Identifies a UI provided as a Swing JComponent.
static String JDIALOG_UI
          Identifies a UI provided as a Swing JDialog.
static int MAIN_UIROLE
          A user interface for end-user browsing of the print service.
static String PANEL_UI
          Identifies a UI provided as an AWT Panel.
static int RESERVED_UIROLE
          Role IDs greater than this may be used for other private roles.
 
Constructor Summary
ServiceUIFactory()
          Constructs a ServiceUIFactory object.
 
Method Summary
abstract  Object getUI(int role, String ui)
          Returns an UI object which may be cast to the requested UI type.
abstract  String[] getUIClassNamesForRole(int role)
          Returns the UI types supported by this factory for an UI role.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ABOUT_UIROLE

public static final int ABOUT_UIROLE
A user interface providing informations about the print service.

See Also:
Constant Field Values

ADMIN_UIROLE

public static final int ADMIN_UIROLE
A user interface to administer the print service.

See Also:
Constant Field Values

MAIN_UIROLE

public static final int MAIN_UIROLE
A user interface for end-user browsing of the print service.

See Also:
Constant Field Values

RESERVED_UIROLE

public static final int RESERVED_UIROLE
Role IDs greater than this may be used for other private roles.

See Also:
Constant Field Values

DIALOG_UI

public static final String DIALOG_UI
Identifies a UI provided as an AWT dialog.

See Also:
Constant Field Values

JCOMPONENT_UI

public static final String JCOMPONENT_UI
Identifies a UI provided as a Swing JComponent.

See Also:
Constant Field Values

JDIALOG_UI

public static final String JDIALOG_UI
Identifies a UI provided as a Swing JDialog.

See Also:
Constant Field Values

PANEL_UI

public static final String PANEL_UI
Identifies a UI provided as an AWT Panel.

See Also:
Constant Field Values
Constructor Detail

ServiceUIFactory

public ServiceUIFactory()
Constructs a ServiceUIFactory object.

Method Detail

getUI

public abstract Object getUI(int role,
                             String ui)
Returns an UI object which may be cast to the requested UI type.

Parameters:
role - the 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 of this role is not supported by this factory
Throws:
IllegalArgumentException - if role is neither one of the standard ones nor a private one supported by this factory

getUIClassNamesForRole

public abstract String[] getUIClassNamesForRole(int role)
Returns the UI types supported by this factory for an UI role.

Parameters:
role - the role to be looked up
Returns:
an array of UI types
Throws:
IllegalArgumentException - if role is neither one of the standard ones nor a private one supported by this factory