< prev index next >

src/java.desktop/share/classes/javax/swing/ButtonModel.java

Print this page

        

@@ -36,11 +36,11 @@
  * and radio buttons, which are special kinds of buttons. In practice,
  * a button's UI takes the responsibility of calling methods on its
  * model to manage the state, as detailed below:
  * <p>
  * In simple terms, pressing and releasing the mouse over a regular
- * button triggers the button and causes and <code>ActionEvent</code>
+ * button triggers the button and causes and {@code ActionEvent}
  * to be fired. The same behavior can be produced via a keyboard key
  * defined by the look and feel of the button (typically the SPACE BAR).
  * Pressing and releasing this key while the button has
  * focus will give the same results. For check boxes and radio buttons, the
  * mouse or keyboard equivalent sequence just described causes the button

@@ -54,11 +54,11 @@
  * the model remains pressed, even if the mouse moves
  * outside the button. On the contrary, the model is only
  * armed while the mouse remains pressed within the bounds of
  * the button (it can move in or out of the button, but the model
  * is only armed during the portion of time spent within the button).
- * A button is triggered, and an <code>ActionEvent</code> is fired,
+ * A button is triggered, and an {@code ActionEvent} is fired,
  * when the mouse is released while the model is armed
  * - meaning when it is released over top of the button after the mouse
  * has previously been pressed on that button (and not already released).
  * Upon mouse release, the model becomes unarmed and unpressed.
  * <p>

@@ -67,54 +67,54 @@
  * <br>
  * Pressing the look and feel defined keyboard key while the button
  * has focus makes the model both armed and pressed. As long as this key
  * remains down, the model remains in this state. Releasing the key sets
  * the model to unarmed and unpressed, triggers the button, and causes an
- * <code>ActionEvent</code> to be fired.
+ * {@code ActionEvent} to be fired.
  *
  * @author Jeff Dinkins
  * @since 1.2
  */
 public interface ButtonModel extends ItemSelectable {
 
     /**
      * Indicates partial commitment towards triggering the
      * button.
      *
-     * @return <code>true</code> if the button is armed,
+     * @return {@code true} if the button is armed,
      *         and ready to be triggered
      * @see #setArmed
      */
     boolean isArmed();
 
     /**
      * Indicates if the button has been selected. Only needed for
      * certain types of buttons - such as radio buttons and check boxes.
      *
-     * @return <code>true</code> if the button is selected
+     * @return {@code true} if the button is selected
      */
     boolean isSelected();
 
     /**
      * Indicates if the button can be selected or triggered by
      * an input device, such as a mouse pointer.
      *
-     * @return <code>true</code> if the button is enabled
+     * @return {@code true} if the button is enabled
      */
     boolean isEnabled();
 
     /**
      * Indicates if the button is pressed.
      *
-     * @return <code>true</code> if the button is pressed
+     * @return {@code true} if the button is pressed
      */
     boolean isPressed();
 
     /**
      * Indicates that the mouse is over the button.
      *
-     * @return <code>true</code> if the mouse is over the button
+     * @return {@code true} if the mouse is over the button
      */
     boolean isRollover();
 
     /**
      * Marks the button as armed or unarmed.

@@ -124,12 +124,12 @@
     public void setArmed(boolean b);
 
     /**
      * Selects or deselects the button.
      *
-     * @param b <code>true</code> selects the button,
-     *          <code>false</code> deselects the button
+     * @param b {@code true} selects the button,
+     *          {@code false} deselects the button
      */
     public void setSelected(boolean b);
 
     /**
      * Enables or disables the button.

@@ -171,72 +171,72 @@
      */
     public int  getMnemonic();
 
     /**
      * Sets the action command string that gets sent as part of the
-     * <code>ActionEvent</code> when the button is triggered.
+     * {@code ActionEvent} when the button is triggered.
      *
-     * @param s the <code>String</code> that identifies the generated event
+     * @param s the {@code String} that identifies the generated event
      * @see #getActionCommand
      * @see java.awt.event.ActionEvent#getActionCommand
      */
     public void setActionCommand(String s);
 
     /**
      * Returns the action command string for the button.
      *
-     * @return the <code>String</code> that identifies the generated event
+     * @return the {@code String} that identifies the generated event
      * @see #setActionCommand
      */
     public String getActionCommand();
 
     /**
      * Identifies the group the button belongs to --
      * needed for radio buttons, which are mutually
      * exclusive within their group.
      *
-     * @param group the <code>ButtonGroup</code> the button belongs to
+     * @param group the {@code ButtonGroup} the button belongs to
      */
     public void setGroup(ButtonGroup group);
 
     /**
-     * Adds an <code>ActionListener</code> to the model.
+     * Adds an {@code ActionListener} to the model.
      *
      * @param l the listener to add
      */
     void addActionListener(ActionListener l);
 
     /**
-     * Removes an <code>ActionListener</code> from the model.
+     * Removes an {@code ActionListener} from the model.
      *
      * @param l the listener to remove
      */
     void removeActionListener(ActionListener l);
 
     /**
-     * Adds an <code>ItemListener</code> to the model.
+     * Adds an {@code ItemListener} to the model.
      *
      * @param l the listener to add
      */
     void addItemListener(ItemListener l);
 
     /**
-     * Removes an <code>ItemListener</code> from the model.
+     * Removes an {@code ItemListener} from the model.
      *
      * @param l the listener to remove
      */
     void removeItemListener(ItemListener l);
 
     /**
-     * Adds a <code>ChangeListener</code> to the model.
+     * Adds a {@code ChangeListener} to the model.
      *
      * @param l the listener to add
      */
     void addChangeListener(ChangeListener l);
 
     /**
-     * Removes a <code>ChangeListener</code> from the model.
+     * Removes a {@code ChangeListener} from the model.
      *
      * @param l the listener to remove
      */
     void removeChangeListener(ChangeListener l);
 
< prev index next >