1 /* JCheckBox.java -- 2 Copyright (C) 2002, 2004, 2005 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.swing; 40 41 import javax.accessibility.Accessible; 42 import javax.accessibility.AccessibleContext; 43 import javax.accessibility.AccessibleRole; 44 45 /** 46 * A small box that displays a check or not, depending on it's 47 * <code>selected</code> state. This works very similar to 48 * {@link JToggleButton} and {@link JRadioButton}, but in UI design it 49 * has different semantics. <code>JCheckBox</code>es are usually 50 * used in multiple-choice scenarios, where a user can select 0..n 51 * of n different options. (This is in contrast to the general RadioButton 52 * semantics where the user can select exactly one of n options). 53 * 54 * Note however that this semantics is in no way enforced by the 55 * <code>JCheckBox</code>. 56 * 57 * @author Ronald Veldema (rveldema@cs.vu.nl) 58 */ 59 public class JCheckBox extends JToggleButton implements Accessible 60 { 61 62 /** 63 * Provides accessibility support for <code>JCheckBox</code>. 64 */ 65 protected class AccessibleJCheckBox extends AccessibleJToggleButton 66 { 67 /** 68 * Creates a new instance of <code>AccessibleJCheckBox</code>. 69 */ AccessibleJCheckBox()70 protected AccessibleJCheckBox() 71 { 72 // Nothing to do here. 73 } 74 75 /** 76 * Returns the accessble role of <code>JCheckBox</code>, 77 * {@link AccessibleRole#CHECK_BOX}. 78 */ getAccessibleRole()79 public AccessibleRole getAccessibleRole() 80 { 81 return AccessibleRole.CHECK_BOX; 82 } 83 } 84 85 private static final long serialVersionUID = -5246739313864538930L; 86 87 public static final String BORDER_PAINTED_FLAT_CHANGED_PROPERTY = 88 "borderPaintedFlat"; 89 90 private boolean borderPaintedFlat; 91 init()92 private void init() 93 { 94 borderPainted = false; 95 contentAreaFilled = false; 96 } 97 JCheckBox()98 public JCheckBox() 99 { 100 this(null, null, false); 101 } 102 JCheckBox(Action action)103 public JCheckBox(Action action) 104 { 105 super(action); 106 } 107 JCheckBox(Icon icon)108 public JCheckBox(Icon icon) 109 { 110 this(null, icon, false); 111 } 112 JCheckBox(Icon icon, boolean selected)113 public JCheckBox(Icon icon, boolean selected) 114 { 115 this(null, icon, selected); 116 } 117 JCheckBox(String text)118 public JCheckBox(String text) 119 { 120 this(text, null, false); 121 } 122 JCheckBox(String text, boolean selected)123 public JCheckBox(String text, boolean selected) 124 { 125 this(text, null, selected); 126 } 127 JCheckBox(String text, Icon icon)128 public JCheckBox(String text, Icon icon) 129 { 130 this(text, icon, false); 131 } 132 JCheckBox(String text, Icon icon, boolean selected)133 public JCheckBox(String text, Icon icon, boolean selected) 134 { 135 super(text, icon, selected); 136 setHorizontalAlignment(LEADING); 137 setBorderPainted(false); 138 } 139 140 /** 141 * Returns a string that specifies the name of the Look and Feel class 142 * that renders this component. 143 */ getUIClassID()144 public String getUIClassID() 145 { 146 return "CheckBoxUI"; 147 } 148 paramString()149 protected String paramString() 150 { 151 return super.paramString() + ",borderPaintedFlat=" + borderPaintedFlat; 152 } 153 isBorderPaintedFlat()154 public boolean isBorderPaintedFlat() 155 { 156 return borderPaintedFlat; 157 } 158 setBorderPaintedFlat(boolean newValue)159 public void setBorderPaintedFlat(boolean newValue) 160 { 161 firePropertyChange("borderPaintedFlat", borderPaintedFlat, newValue); 162 borderPaintedFlat = newValue; 163 } 164 165 /** 166 * Returns the accessible context for this <code>JCheckBox</code>. 167 * 168 * @return the accessible context for this <code>JCheckBox</code> 169 */ getAccessibleContext()170 public AccessibleContext getAccessibleContext() 171 { 172 if (accessibleContext == null) 173 accessibleContext = new AccessibleJCheckBox(); 174 return accessibleContext; 175 } 176 } 177