ButtonModel.java 8.56 KB
Newer Older
Tom Tromey committed
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
/* ButtonModel.java --
   Copyright (C) 2002, 2004 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package javax.swing;

import java.awt.ItemSelectable;
import java.awt.event.ActionListener;
import java.awt.event.ItemListener;

import javax.swing.event.ChangeListener;

/**
 * The data model that is used in all kinds of buttons.
 */
public interface ButtonModel extends ItemSelectable
51
{
Tom Tromey committed
52

53 54 55 56 57 58
  /**
   * Returns <code>true</code> if the button is armed, <code>false</code>
   * otherwise.
   *
   * A button is armed, when the user has pressed the mouse over it, but has
   * not yet released the mouse.
59
   *
60 61 62 63 64 65
   * @return <code>true</code> if the button is armed, <code>false</code>
   *         otherwise
   *
   * @see #setArmed(boolean)
   */
  boolean isArmed();
Tom Tromey committed
66

67 68 69 70 71 72 73 74 75 76 77 78
  /**
   * Sets the armed flag of the button.
   *
   * A button is armed, when the user has pressed the mouse over it, but has
   * not yet released the mouse.
   *
   * @param b <code>true</code> if the button is armed, <code>false</code>
   *        otherwise
   *
   * @see #isArmed()
   */
  void setArmed(boolean b);
Tom Tromey committed
79

80 81 82 83 84 85 86 87 88 89 90 91 92
  /**
   * Returns <code>true</code> if the button is enabled, <code>false</code>
   * otherwise.
   *
   * When a button is disabled, it is usually grayed out and the user cannot
   * change its state.
   *
   * @return <code>true</code> if the button is enabled, <code>false</code>
   *         otherwise
   *
   * @see #setEnabled(boolean)
   */
  boolean isEnabled();
Tom Tromey committed
93

94 95 96 97 98 99 100 101 102 103 104 105
  /**
   * Sets the enabled flag of the button.
   *
   * When a button is disabled, it is usually grayed out and the user cannot
   * change its state.
   *
   * @param b <code>true</code> if the button is enabled, <code>false</code>
   *        otherwise
   *
   * @see #isEnabled()
   */
  void setEnabled(boolean b);
Tom Tromey committed
106

107 108 109 110 111 112 113 114 115 116 117 118
  /**
   * Sets the pressed flag of the button.
   *
   * The button usually gets pressed when the user clicks on a button, it will
   * be un-pressed when the user releases the mouse.
   *
   * @param b <code>true</code> if the button is pressed, <code>false</code>
   *        otherwise
   *
   * @see #isPressed()
   */
  void setPressed(boolean b);
Tom Tromey committed
119

120 121 122 123 124 125 126 127 128 129 130 131 132
  /**
   * Returns <code>true</code> if the button is pressed, <code>false</code>
   * otherwise.
   *
   * The button usually gets pressed when the user clicks on a button, it will
   * be un-pressed when the user releases the mouse.
   *
   * @return <code>true</code> if the button is pressed, <code>false</code>
   *         otherwise
   *
   * @see #setPressed(boolean)
   */
  boolean isPressed();
Tom Tromey committed
133

134 135 136 137 138 139 140 141
  /**
   * Removes an {@link ActionListener} from the list of registered listeners.
   *
   * @param l the action listener to remove
   *
   * @see #addActionListener(ActionListener)
   */
  void removeActionListener(ActionListener l);
Tom Tromey committed
142

143 144 145 146 147
  /**
   * Adds an {@link ActionListener} to the list of registered listeners.
   *
   * An <code>ActionEvent</code> is usually fired when the user clicks on a
   * button.
148
   *
149 150 151 152 153
   * @param l the action listener to add
   *
   * @see #removeActionListener(ActionListener)
   */
  void addActionListener(ActionListener l);
Tom Tromey committed
154

155 156 157 158 159 160 161 162 163 164 165 166
  /**
   * Adds an {@link ItemListener} to the list of registered listeners.
   *
   * An <code>ItemEvent</code> is usually fired when a button's selected
   * state changes. This applies only to buttons that support the selected
   * flag.
   *
   * @param l the item listener to add
   *
   * @see #removeItemListener(ItemListener)
   */
  void addItemListener(ItemListener l);
Tom Tromey committed
167

168 169 170 171 172 173 174 175
  /**
   * Adds an {@link ItemListener} to the list of registered listeners.
   *
   * @param l the item listener to add
   *
   * @see #removeItemListener(ItemListener)
   */
  void removeItemListener(ItemListener l);
Tom Tromey committed
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
  /**
   * Adds an {@link ChangeListener} to the list of registered listeners.
   *
   * A <code>ChangeEvent</code> is fired when any one of the button's flags
   * changes.
   *
   * @param l the change listener to add
   *
   * @see #removeChangeListener(ChangeListener)
   */
  void addChangeListener(ChangeListener l);

  /**
   * Adds an {@link ChangeListener} to the list of registered listeners.
   *
   * @param l the change listener to add
   *
   * @see #removeChangeListener(ChangeListener)
   */
  void removeChangeListener(ChangeListener l);

  /**
   * Sets the rollover flag of the button.
   *
   * A button is rollover-ed, when the user has moved the mouse over it, but has
   * not yet pressed the mouse.
   *
   * @param b <code>true</code> if the button is rollover, <code>false</code>
   *        otherwise
   *
   * @see #isRollover()
   */
  void setRollover(boolean b);

  /**
   * Returns <code>true</code> if the button is rollover-ed, <code>false</code>
   * otherwise.
   *
   * A button is rollover-ed, when the user has moved the mouse over it, but has
   * not yet pressed the mouse.
   *
   * @return <code>true</code> if the button is rollover, <code>false</code>
   *         otherwise
   *
   * @see #setRollover(boolean)
   */
  boolean isRollover();

  /**
   * Returns the keyboard mnemonic for the button. This specifies a shortcut
   * or accelerator key that can be used to activate the button.
228
   *
229 230 231 232 233 234 235 236 237
   * @return the keyboard mnemonic for the button
   *
   * @see #setMnemonic(int)
   */
  int  getMnemonic();

  /**
   * Sets the keyboard mnemonic for the button. This specifies a shortcut
   * or accelerator key that can be used to activate the button.
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 278
   * @param key the keyboard mnemonic for the button
   *
   * @see #getMnemonic()
   */
  void setMnemonic(int key);

  /**
   * Sets the action command for the button. This will be used in
   * <code>ActionEvents</code> fired by the button.
   *
   * @param s the action command to set
   *
   * @see #getActionCommand()
   */
  void setActionCommand(String s);

  /**
   * Returns the action command of the button.
   *
   * @return the action command of the button
   *
   * @see #setActionCommand(String)
   */
  String getActionCommand();

  /**
   * Sets the button group for the button. Some kinds of button (e.g. radio
   * buttons) allow only one button within a button group selected at any one
   * time.
   *
   * @param group the button group to set
   */
  void setGroup(ButtonGroup group);

  /**
   * Sets the selected flag of the button.
   *
   * Some kinds of buttons (e.g. toggle buttons, check boxes, radio buttons)
   * can be in one of two states: selected or unselected. The selected state
   * is usually toggled by clicking on the button.
279
   *
280 281 282 283 284 285 286 287 288 289 290 291 292 293
   * @param b <code>true</code> if the button is selected, <code>false</code>
   *        otherwise
   *
   * @see #isSelected()
   */
  void setSelected(boolean b);

  /**
   * Returns <code>true</code> if the button is selected, <code>false</code>
   * otherwise.
   *
   * Some kinds of buttons (e.g. toggle buttons, check boxes, radio buttons)
   * can be in one of two states: selected or unselected. The selected state
   * is usually toggled by clicking on the button.
294
   *
295 296 297 298 299 300
   * @return <code>true</code> if the button is selected, <code>false</code>
   *         otherwise
   *
   * @see #setSelected(boolean)
   */
  boolean isSelected();
Tom Tromey committed
301
}