1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
/* * @(#)JSeparator.java 1.52 06/08/08 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.swing; import javax.swing.plaf.*; import javax.accessibility.*; import java.io.ObjectOutputStream; import java.io.ObjectInputStream; import java.io.IOException; /** * <code>JSeparator</code> provides a general purpose component for * implementing divider lines - most commonly used as a divider * between menu items that breaks them up into logical groupings. * Instead of using <code>JSeparator</code> directly, * you can use the <code>JMenu</code> or <code>JPopupMenu</code> * <code>addSeparator</code> method to create and add a separator. * <code>JSeparator</code>s may also be used elsewhere in a GUI * wherever a visual divider is useful. * * <p> * * For more information and examples see * <a href="http://java.sun.com/docs/books/tutorial/uiswing/components/menu.html">How to Use Menus</a>, * a section in <em>The Java Tutorial.</em> * <p> * <strong>Warning:</strong> Swing is not thread safe. For more * information see <a * href="package-summary.html#threading">Swing's Threading * Policy</a>. * <p> * <strong>Warning:</strong> * Serialized objects of this class will not be compatible with * future Swing releases. The current serialization support is * appropriate for short term storage or RMI between applications running * the same version of Swing. As of 1.4, support for long term storage * of all JavaBeans<sup><font size="-2">TM</font></sup> * has been added to the <code>java.beans</code> package. * Please see {@link java.beans.XMLEncoder}. * * @beaninfo * attribute: isContainer false * description: A divider between menu items. * * @version 1.52 08/08/06 * @author Georges Saab * @author Jeff Shapiro */ public class JSeparator extends JComponent implements SwingConstants, Accessible { /** * @see #getUIClassID * @see #readObject */ private static final String uiClassID = "SeparatorUI"; private int orientation = HORIZONTAL; /** Creates a new horizontal separator. */ public JSeparator() { this( HORIZONTAL ); } /** * Creates a new separator with the specified horizontal or * vertical orientation. * * @param orientation an integer specifying * <code>SwingConstants.HORIZONTAL</code> or * <code>SwingConstants.VERTICAL</code> * @exception IllegalArgumentException if <code>orientation</code> * is neither <code>SwingConstants.HORIZONTAL</code> nor * <code>SwingConstants.VERTICAL</code> */ public JSeparator( int orientation ) { checkOrientation( orientation ); this.orientation = orientation; setFocusable(false); updateUI(); } /** * Returns the L&F object that renders this component. * * @return the SeparatorUI object that renders this component */ public SeparatorUI getUI() { return (SeparatorUI)ui; } /** * Sets the L&F object that renders this component. * * @param ui the SeparatorUI L&F object * @see UIDefaults#getUI * @beaninfo * bound: true * hidden: true * attribute: visualUpdate true * description: The UI object that implements the Component's LookAndFeel. */ public void setUI(SeparatorUI ui) { super.setUI(ui); } /** * Resets the UI property to a value from the current look and feel. * * @see JComponent#updateUI */ public void updateUI() { setUI((SeparatorUI)UIManager.getUI(this)); } /** * Returns the name of the L&F class that renders this component. * * @return the string "SeparatorUI" * @see JComponent#getUIClassID * @see UIDefaults#getUI */ public String getUIClassID() { return uiClassID; } /** * See <code>readObject</code> and <code>writeObject</code> in * <code>JComponent</code> for more * information about serialization in Swing. */ private void writeObject(ObjectOutputStream s) throws IOException { s.defaultWriteObject(); if (getUIClassID().equals(uiClassID)) { byte count = JComponent.getWriteObjCounter(this); JComponent.setWriteObjCounter(this, --count); if (count == 0 && ui != null) { ui.installUI(this); } } } /** * Returns the orientation of this separator. * * @return The value of the orientation property, one of the * following constants defined in <code>SwingConstants</code>: * <code>VERTICAL</code>, or * <code>HORIZONTAL</code>. * * @see SwingConstants * @see #setOrientation */ public int getOrientation() { return this.orientation; } /** * Sets the orientation of the separator. * The default value of this property is HORIZONTAL. * @param orientation either <code>SwingConstants.HORIZONTAL</code> * or <code>SwingConstants.VERTICAL</code> * @exception IllegalArgumentException if <code>orientation</code> * is neither <code>SwingConstants.HORIZONTAL</code> * nor <code>SwingConstants.VERTICAL</code> * * @see SwingConstants * @see #getOrientation * @beaninfo * bound: true * preferred: true * enum: HORIZONTAL SwingConstants.HORIZONTAL * VERTICAL SwingConstants.VERTICAL * attribute: visualUpdate true * description: The orientation of the separator. */ public void setOrientation( int orientation ) { if (this.orientation == orientation) { return; } int oldValue = this.orientation; checkOrientation( orientation ); this.orientation = orientation; firePropertyChange("orientation", oldValue, orientation); revalidate(); repaint(); } private void checkOrientation( int orientation ) { switch ( orientation ) { case VERTICAL: case HORIZONTAL: break; default: throw new IllegalArgumentException( "orientation must be one of: VERTICAL, HORIZONTAL" ); } } /** * Returns a string representation of this <code>JSeparator</code>. * This method * is intended to be used only for debugging purposes, and the * content and format of the returned string may vary between * implementations. The returned string may be empty but may not * be <code>null</code>. * * @return a string representation of this <code>JSeparator</code> */ protected String paramString() { String orientationString = (orientation == HORIZONTAL ? "HORIZONTAL" : "VERTICAL"); return super.paramString() + ",orientation=" + orientationString; } ///////////////// // Accessibility support //////////////// /** * Gets the AccessibleContext associated with this JSeparator. * For separators, the AccessibleContext takes the form of an * AccessibleJSeparator. * A new AccessibleJSeparator instance is created if necessary. * * @return an AccessibleJSeparator that serves as the * AccessibleContext of this JSeparator */ public AccessibleContext getAccessibleContext() { if (accessibleContext == null) { accessibleContext = new AccessibleJSeparator(); } return accessibleContext; } /** * This class implements accessibility support for the * <code>JSeparator</code> class. It provides an implementation of the * Java Accessibility API appropriate to separator user-interface elements. * <p> * <strong>Warning:</strong> * Serialized objects of this class will not be compatible with * future Swing releases. The current serialization support is * appropriate for short term storage or RMI between applications running * the same version of Swing. As of 1.4, support for long term storage * of all JavaBeans<sup><font size="-2">TM</font></sup> * has been added to the <code>java.beans</code> package. * Please see {@link java.beans.XMLEncoder}. */ protected class AccessibleJSeparator extends AccessibleJComponent { /** * Get the role of this object. * * @return an instance of AccessibleRole describing the role of the * object */ public AccessibleRole getAccessibleRole() { return AccessibleRole.SEPARATOR; } } }