001/* JCheckBox.java -- 002 Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package javax.swing; 040 041import javax.accessibility.Accessible; 042import javax.accessibility.AccessibleContext; 043import javax.accessibility.AccessibleRole; 044 045/** 046 * A small box that displays a check or not, depending on it's 047 * <code>selected</code> state. This works very similar to 048 * {@link JToggleButton} and {@link JRadioButton}, but in UI design it 049 * has different semantics. <code>JCheckBox</code>es are usually 050 * used in multiple-choice scenarios, where a user can select 0..n 051 * of n different options. (This is in contrast to the general RadioButton 052 * semantics where the user can select exactly one of n options). 053 * 054 * Note however that this semantics is in no way enforced by the 055 * <code>JCheckBox</code>. 056 * 057 * @author Ronald Veldema (rveldema@cs.vu.nl) 058 */ 059public class JCheckBox extends JToggleButton implements Accessible 060{ 061 062 /** 063 * Provides accessibility support for <code>JCheckBox</code>. 064 */ 065 protected class AccessibleJCheckBox extends AccessibleJToggleButton 066 { 067 /** 068 * Creates a new instance of <code>AccessibleJCheckBox</code>. 069 */ 070 protected AccessibleJCheckBox() 071 { 072 // Nothing to do here. 073 } 074 075 /** 076 * Returns the accessble role of <code>JCheckBox</code>, 077 * {@link AccessibleRole#CHECK_BOX}. 078 */ 079 public AccessibleRole getAccessibleRole() 080 { 081 return AccessibleRole.CHECK_BOX; 082 } 083 } 084 085 private static final long serialVersionUID = -5246739313864538930L; 086 087 public static final String BORDER_PAINTED_FLAT_CHANGED_PROPERTY = 088 "borderPaintedFlat"; 089 090 private boolean borderPaintedFlat; 091 092 private void init() 093 { 094 borderPainted = false; 095 contentAreaFilled = false; 096 } 097 098 public JCheckBox() 099 { 100 this(null, null, false); 101 } 102 103 public JCheckBox(Action action) 104 { 105 super(action); 106 } 107 108 public JCheckBox(Icon icon) 109 { 110 this(null, icon, false); 111 } 112 113 public JCheckBox(Icon icon, boolean selected) 114 { 115 this(null, icon, selected); 116 } 117 118 public JCheckBox(String text) 119 { 120 this(text, null, false); 121 } 122 123 public JCheckBox(String text, boolean selected) 124 { 125 this(text, null, selected); 126 } 127 128 public JCheckBox(String text, Icon icon) 129 { 130 this(text, icon, false); 131 } 132 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 */ 144 public String getUIClassID() 145 { 146 return "CheckBoxUI"; 147 } 148 149 protected String paramString() 150 { 151 return super.paramString() + ",borderPaintedFlat=" + borderPaintedFlat; 152 } 153 154 public boolean isBorderPaintedFlat() 155 { 156 return borderPaintedFlat; 157 } 158 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 */ 170 public AccessibleContext getAccessibleContext() 171 { 172 if (accessibleContext == null) 173 accessibleContext = new AccessibleJCheckBox(); 174 return accessibleContext; 175 } 176}