Source for javax.print.ServiceUIFactory

   1: /* ServiceUIFactory.java --
   2:    Copyright (C) 2004 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.print;
  40: 
  41: /**
  42:  * @author Michael Koch
  43:  */
  44: public abstract class ServiceUIFactory
  45: {
  46:   public static final int ABOUT_UIROLE = 1;
  47:   public static final int ADMIN_UIROLE = 2;
  48:   public static final int MAIN_UIROLE = 3;
  49:   public static final int RESERVED_UIROLE = 99;
  50: 
  51:   public static final String DIALOG_UI = "java.awt.Dialog";
  52:   public static final String JCOMPONENT_UI = "javax.swing.JComponent";
  53:   public static final String JDIALOG_UI = "javax.swing.JDialog";
  54:   public static final String PANEL_UI = "java.awt.Panel";
  55: 
  56:   /**
  57:    * Constructs a <code>ServiceUIFactory</code> object.
  58:    */
  59:   public ServiceUIFactory()
  60:   {
  61:       // Do nothing here.
  62:   }
  63: 
  64:   /**
  65:    * Returns an UI object which may be cast to the requested UI type.
  66:    * 
  67:    * @param role the role requested. Must be one of the standard roles
  68:    * or a private role supported by this factory
  69:    * @param ui type in which the role is requested
  70:    * 
  71:    * @return the UI role or null of this role is not supported by this factory
  72:    * 
  73:    * @throws IllegalArgumentException if <code>role</code> is neither one of
  74:    * the standard ones nor a private one supported by this factory
  75:    */
  76:   public abstract Object getUI(int role, String ui);
  77: 
  78:   /**
  79:    * Returns the UI types supported by this factory for an UI role.
  80:    * 
  81:    * @param role the role to be looked up
  82:    * 
  83:    * @return an array of UI types
  84:    * 
  85:    * @throws IllegalArgumentException if <code>role</code> is neither one of
  86:    * the standard ones nor a private one supported by this factory
  87:    */
  88:   public abstract String[] getUIClassNamesForRole(int role);