Source for javax.swing.JSeparator

   1: /* JSeparator.java --
   2:    Copyright (C) 2002, 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: package javax.swing;
  39: 
  40: import javax.accessibility.Accessible;
  41: import javax.accessibility.AccessibleContext;
  42: import javax.accessibility.AccessibleRole;
  43: import javax.swing.plaf.SeparatorUI;
  44: 
  45: 
  46: /**
  47:  * The JSeparator. It is mostly used to divide/space out
  48:  * components.
  49:  */
  50: public class JSeparator extends JComponent implements SwingConstants,
  51:                                                       Accessible
  52: {
  53:   /**
  54:    * AccessibleJSeparator
  55:    */
  56:   protected class AccessibleJSeparator extends AccessibleJComponent
  57:   {
  58:     private static final long serialVersionUID = 916332890553201095L;
  59:   
  60:     /**
  61:      * Constructor AccessibleJSeparator
  62:      */
  63:     protected AccessibleJSeparator()
  64:     {
  65:     }
  66: 
  67:     /**
  68:      * getAccessibleRole
  69:      *
  70:      * @return AccessibleRole
  71:      */
  72:     public AccessibleRole getAccessibleRole()
  73:     {
  74:       return AccessibleRole.SEPARATOR;
  75:     }
  76:   }
  77: 
  78:   private static final long serialVersionUID = 125301223445282357L;
  79:   
  80:   /** The orientation of the JSeparator. */
  81:   private transient int orientation = HORIZONTAL;
  82: 
  83:   /**
  84:    * Creates a new horizontal JSeparator object.
  85:    */
  86:   public JSeparator()
  87:   {
  88:     this(HORIZONTAL);
  89:   }
  90: 
  91:   /**
  92:    * Creates a new JSeparator object with the given orientation.
  93:    *
  94:    * @param orientation The orientation of the JSeparator.
  95:    */
  96:   public JSeparator(int orientation)
  97:   {
  98:     if (orientation != HORIZONTAL && orientation != VERTICAL)
  99:       throw new IllegalArgumentException(orientation
 100:                                          + " is not a valid orientation.");
 101:     this.orientation = orientation;
 102:     updateUI();
 103:   }
 104: 
 105:   /**
 106:    * This method returns the UI delegate being
 107:    * used with the JSeparator.
 108:    *
 109:    * @return SeparatorUI The JSeparator's UI delegate.
 110:    */
 111:   public SeparatorUI getUI()
 112:   {
 113:     return (SeparatorUI) ui;
 114:   }
 115: 
 116:   /**
 117:    * This method sets the UI delegate to use
 118:    * with the JSeparator.
 119:    *
 120:    * @param ui The UI delegate to use.
 121:    */
 122:   public void setUI(SeparatorUI ui)
 123:   {
 124:     super.setUI(ui);
 125:   }
 126: 
 127:   /**
 128:    * This method resets the UI delegate to the 
 129:    * default for the current look and feel.
 130:    */
 131:   public void updateUI()
 132:   {
 133:     setUI((SeparatorUI) UIManager.getUI(this));
 134:     invalidate();
 135:   }
 136: 
 137:   /**
 138:    * This method returns the identifier string
 139:    * that is used to determine the UI delegate
 140:    * from the current look and feel.
 141:    *
 142:    * @return String The identifier string for the UI.
 143:    */
 144:   public String getUIClassID()
 145:   {
 146:     return "SeparatorUI";
 147:   }
 148: 
 149:   /**
 150:    * This method returns the JSeparator's orientation.
 151:    *
 152:    * @return int The JSeparator's orientation.
 153:    */
 154:   public int getOrientation()
 155:   {
 156:     return orientation;
 157:   }
 158: 
 159:   /**
 160:    * This method changes the JSeparator's orientation.
 161:    *
 162:    * @param orientation The JSeparator's orientation.
 163:    */
 164:   public void setOrientation(int orientation)
 165:   {
 166:     if (orientation != HORIZONTAL && orientation != VERTICAL)
 167:       throw new IllegalArgumentException(orientation
 168:                                          + " is not a valid orientation.");
 169:     this.orientation = orientation;
 170:   }
 171: 
 172:   /**
 173:    * This method returns a string desribing the JSeparator.
 174:    * Normally only used in debugging.
 175:    *
 176:    * @return String A string describing the JSeparator.
 177:    */
 178:   protected String paramString()
 179:   {
 180:     return "JSeparator";
 181:   }
 182: 
 183:   /**
 184:    * getAccessibleContext
 185:    *
 186:    * @return AccessibleContext
 187:    */
 188:   public AccessibleContext getAccessibleContext()
 189:   {
 190:     if (accessibleContext == null)
 191:       accessibleContext = new AccessibleJSeparator();
 192:     
 193:     return accessibleContext;
 194:   }
 195: }