9803e3d888
2004-02-20 Michael Koch <konqueror@gmx.de> * javax/swing/AbstractButton.java: Made several constants final. (getRolloverSelectedIcon): Made public. (getSelectedIcon): Made public. From-SVN: r78169
1810 lines
55 KiB
Java
1810 lines
55 KiB
Java
/* AbstractButton.java -- Provides basic button functionality.
|
|
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., 59 Temple Place, Suite 330, Boston, MA
|
|
02111-1307 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.AWTEvent;
|
|
import java.awt.AWTEventMulticaster;
|
|
import java.awt.Graphics;
|
|
import java.awt.Image;
|
|
import java.awt.Insets;
|
|
import java.awt.ItemSelectable;
|
|
import java.awt.Point;
|
|
import java.awt.Rectangle;
|
|
import java.awt.event.ActionEvent;
|
|
import java.awt.event.ActionListener;
|
|
import java.awt.event.FocusEvent;
|
|
import java.awt.event.FocusListener;
|
|
import java.awt.event.ItemEvent;
|
|
import java.awt.event.ItemListener;
|
|
import java.awt.event.MouseEvent;
|
|
import java.beans.PropertyChangeEvent;
|
|
import java.beans.PropertyChangeListener;
|
|
import java.io.Serializable;
|
|
import java.util.Vector;
|
|
import java.util.EventListener;
|
|
import javax.accessibility.AccessibleAction;
|
|
import javax.accessibility.AccessibleIcon;
|
|
import javax.accessibility.AccessibleRelationSet;
|
|
import javax.accessibility.AccessibleStateSet;
|
|
import javax.accessibility.AccessibleText;
|
|
import javax.accessibility.AccessibleValue;
|
|
import javax.swing.event.ChangeEvent;
|
|
import javax.swing.event.ChangeListener;
|
|
import javax.swing.plaf.ButtonUI;
|
|
import javax.swing.text.AttributeSet;
|
|
|
|
|
|
/**
|
|
* <p>The purpose of this class is to serve as a facade over a number of
|
|
* classes which collectively represent the semantics of a button: the
|
|
* button's model, its listeners, its action, and its look and feel. Some
|
|
* parts of a button's state are stored explicitly in this class, other
|
|
* parts are delegates to the model. Some methods related to buttons are
|
|
* implemented in this class, other methods pass through to the current
|
|
* model or look and feel.</p>
|
|
*
|
|
* <p>Furthermore this class is supposed to serve as a base class for
|
|
* several kinds of buttons with similar but non-identical semantics:
|
|
* toggle buttons (radio buttons and checkboxes), simple "push" buttons,
|
|
* menu items.</p>
|
|
*
|
|
* <p>Buttons have many properties, some of which are stored in this class
|
|
* while others are delegated to the button's model. The following properties
|
|
* are available:</p>
|
|
*
|
|
* <table>
|
|
* <tr><th>Property </th><th>Stored in</th><th>Bound?</th></tr>
|
|
*
|
|
* <tr><td>action </td><td>button</td> <td>no</td></tr>
|
|
* <tr><td>actionCommand </td><td>model</td> <td>no</td></tr>
|
|
* <tr><td>borderPainted </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>contentAreaFilled </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>disabledIcon </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>disabledSelectedIcon </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>displayedMnemonicIndex </td><td>button</td> <td>no</td></tr>
|
|
* <tr><td>enabled </td><td>model</td> <td>no</td></tr>
|
|
* <tr><td>focusPainted </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>horizontalAlignment </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>horizontalTextPosition </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>icon </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>iconTextGap </td><td>button</td> <td>no</td></tr>
|
|
* <tr><td>label (same as text) </td><td>model</td> <td>yes</td></tr>
|
|
* <tr><td>margin </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>multiClickThreshold </td><td>button</td> <td>no</td></tr>
|
|
* <tr><td>pressedIcon </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>rolloverEnabled </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>rolloverIcon </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>rolloverSelectedIcon </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>selected </td><td>model</td> <td>no</td></tr>
|
|
* <tr><td>selectedIcon </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>selectedObjects </td><td>button</td> <td>no</td></tr>
|
|
* <tr><td>text </td><td>model</td> <td>yes</td></tr>
|
|
* <tr><td>UI </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>verticalAlignment </td><td>button</td> <td>yes</td></tr>
|
|
* <tr><td>verticalTextPosition </td><td>button</td> <td>yes</td></tr>
|
|
*
|
|
* </table>
|
|
*
|
|
* <p>The various behavioral aspects of these properties follows:</p>
|
|
*
|
|
* <ul>
|
|
*
|
|
* <li>When non-bound properties stored in the button change, the button
|
|
* fires ChangeEvents to its ChangeListeners.</li>
|
|
*
|
|
* <li>When bound properties stored in the button change, the button fires
|
|
* PropertyChangeEvents to its PropertyChangeListeners</li>
|
|
*
|
|
* <li>If any of the model's properties change, it fires a ChangeEvent to
|
|
* its ChangeListeners, which include the button.</li>
|
|
*
|
|
* <li>If the button receives a ChangeEvent from its model, it will
|
|
* propagate the ChangeEvent to its ChangeListeners, with the ChangeEvent's
|
|
* "source" property set to refer to the button, rather than the model. The
|
|
* the button will request a repaint, to paint its updated state.</li>
|
|
*
|
|
* <li>If the model's "selected" property changes, the model will fire an
|
|
* ItemEvent to its ItemListeners, which include the button, in addition to
|
|
* the ChangeEvent which models the property change. The button propagates
|
|
* ItemEvents directly to its ItemListeners.</li>
|
|
*
|
|
* <li>If the model's armed and pressed properties are simultaneously
|
|
* <code>true</code>, the model will fire an ActionEvent to its
|
|
* ActionListeners, which include the button. The button will propagate
|
|
* this ActionEvent to its ActionListeners, with the ActionEvent's "source"
|
|
* property set to refer to the button, rather than the model.</li>
|
|
*
|
|
* </ul>
|
|
*
|
|
* @author Ronald Veldema (rveldema&064;cs.vu.nl)
|
|
* @author Graydon Hoare (graydon&064;redhat.com)
|
|
*/
|
|
|
|
public abstract class AbstractButton extends JComponent
|
|
implements ItemSelectable, SwingConstants
|
|
{
|
|
/** The icon displayed by default. */
|
|
Icon default_icon;
|
|
|
|
/** The icon displayed when the button is pressed. */
|
|
Icon pressed_icon;
|
|
|
|
/** The icon displayed when the button is disabled. */
|
|
Icon disabled_icon;
|
|
|
|
/** The icon displayed when the button is selected. */
|
|
Icon selected_icon;
|
|
|
|
/** The icon displayed when the button is selected but disabled. */
|
|
Icon disabled_selected_icon;
|
|
|
|
/** The icon displayed when the button is rolled over. */
|
|
Icon rollover_icon;
|
|
|
|
/** The icon displayed when the button is selected and rolled over. */
|
|
Icon rollover_selected_icon;
|
|
|
|
/** The icon currently displayed. */
|
|
Icon current_icon;
|
|
|
|
/** The text displayed in the button. */
|
|
String text;
|
|
|
|
/** The vertical alignment of the button's text and icon. */
|
|
int vert_align;
|
|
|
|
/** The horizontal alignment of the button's text and icon. */
|
|
int hori_align;
|
|
|
|
/** The horizontal position of the button's text relative to its icon. */
|
|
int hori_text_pos;
|
|
|
|
/** The vertical position of the button's text relative to its icon. */
|
|
int vert_text_pos;
|
|
|
|
/** Whether or not the button paints its border. */
|
|
boolean paint_border;
|
|
|
|
/** Whether or not the button paints its focus state. */
|
|
boolean paint_focus;
|
|
|
|
/** Whether or not the button fills its content area. */
|
|
boolean content_area_filled;
|
|
|
|
/** The action taken when the button is clicked. */
|
|
Action action;
|
|
|
|
/** The button's current state. */
|
|
ButtonModel model;
|
|
|
|
/** The margin between the button's border and its label. */
|
|
Insets margin;
|
|
|
|
/** a hint to the look and feel class, suggesting which character in the
|
|
* button's label should be underlined when drawing the label. */
|
|
int mnemonicIndex;
|
|
|
|
/** Listener the button uses to receive ActionEvents from its model. */
|
|
ActionListener actionListener;
|
|
|
|
/** Listener the button uses to receive ItemEvents from its model. */
|
|
ItemListener itemListener;
|
|
|
|
/** Listener the button uses to receive ChangeEvents from its model. */
|
|
ChangeListener changeListener;
|
|
|
|
/** Listener the button uses to receive PropertyChangeEvents from its
|
|
Action. */
|
|
PropertyChangeListener actionPropertyChangeListener;
|
|
|
|
/** Fired in a PropertyChangeEvent when the "borderPainted" property changes. */
|
|
public static final String BORDER_PAINTED_CHANGED_PROPERTY = "borderPainted";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "contentAreaFilled" property changes. */
|
|
public static final String CONTENT_AREA_FILLED_CHANGED_PROPERTY = "contentAreaFilled";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "disabledIcon" property changes. */
|
|
public static final String DISABLED_ICON_CHANGED_PROPERTY = "disabledIcon";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "disabledSelectedIcon" property changes. */
|
|
public static final String DISABLED_SELECTED_ICON_CHANGED_PROPERTY = "disabledSelectedIcon";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "focusPainted" property changes. */
|
|
public static final String FOCUS_PAINTED_CHANGED_PROPERTY = "focusPainted";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "horizontalAlignment" property changes. */
|
|
public static final String HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY = "horizontalAlignment";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "horizontalTextPosition" property changes. */
|
|
public static final String HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY = "horizontalTextPosition";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "icon" property changes. */
|
|
public static final String ICON_CHANGED_PROPERTY = "icon";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "margin" property changes. */
|
|
public static final String MARGIN_CHANGED_PROPERTY = "margin";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "mnemonic" property changes. */
|
|
public static final String MNEMONIC_CHANGED_PROPERTY = "mnemonic";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "model" property changes. */
|
|
public static final String MODEL_CHANGED_PROPERTY = "model";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "pressedIcon" property changes. */
|
|
public static final String PRESSED_ICON_CHANGED_PROPERTY = "pressedIcon";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "rolloverEnabled" property changes. */
|
|
public static final String ROLLOVER_ENABLED_CHANGED_PROPERTY = "rolloverEnabled";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "rolloverIcon" property changes. */
|
|
public static final String ROLLOVER_ICON_CHANGED_PROPERTY = "rolloverIcon";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "rolloverSelectedIcon" property changes. */
|
|
public static final String ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY = "rolloverSelectedIcon";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "selectedIcon" property changes. */
|
|
public static final String SELECTED_ICON_CHANGED_PROPERTY = "selectedIcon";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "text" property changes. */
|
|
public static final String TEXT_CHANGED_PROPERTY = "text";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "verticalAlignment" property changes. */
|
|
public static final String VERTICAL_ALIGNMENT_CHANGED_PROPERTY = "verticalAlignment";
|
|
|
|
/** Fired in a PropertyChangeEvent when the "verticalTextPosition" property changes. */
|
|
public static final String VERTICAL_TEXT_POSITION_CHANGED_PROPERTY = "verticalTextPosition";
|
|
|
|
/**
|
|
* A Java Accessibility extension of the AbstractButton.
|
|
*/
|
|
protected abstract class AccessibleAbstractButton
|
|
extends AccessibleJComponent implements AccessibleAction, AccessibleValue,
|
|
AccessibleText
|
|
{
|
|
protected AccessibleAbstractButton(JComponent c)
|
|
{
|
|
super(c);
|
|
}
|
|
|
|
public AccessibleStateSet getAccessibleStateSet()
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public String getAccessibleName()
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public AccessibleIcon[] getAccessibleIcon()
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public AccessibleRelationSet getAccessibleRelationSet()
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public AccessibleAction getAccessibleAction()
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public AccessibleValue getAccessibleValue()
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public int getAccessibleActionCount()
|
|
{
|
|
return 0; // TODO
|
|
}
|
|
|
|
public String getAccessibleActionDescription(int value0)
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public boolean doAccessibleAction(int value0)
|
|
{
|
|
return false; // TODO
|
|
}
|
|
|
|
public Number getCurrentAccessibleValue()
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public boolean setCurrentAccessibleValue(Number value0)
|
|
{
|
|
return false; // TODO
|
|
}
|
|
|
|
public Number getMinimumAccessibleValue()
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public Number getMaximumAccessibleValue()
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public AccessibleText getAccessibleText()
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public int getIndexAtPoint(Point value0)
|
|
{
|
|
return 0; // TODO
|
|
}
|
|
|
|
public Rectangle getCharacterBounds(int value0)
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public int getCharCount()
|
|
{
|
|
return 0; // TODO
|
|
}
|
|
|
|
public int getCaretPosition()
|
|
{
|
|
return 0; // TODO
|
|
}
|
|
|
|
public String getAtIndex(int value0, int value1)
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public String getAfterIndex(int value0, int value1)
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public String getBeforeIndex(int value0, int value1)
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public AttributeSet getCharacterAttribute(int value0)
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
public int getSelectionStart()
|
|
{
|
|
return 0; // TODO
|
|
}
|
|
|
|
public int getSelectionEnd()
|
|
{
|
|
return 0; // TODO
|
|
}
|
|
|
|
public String getSelectedText()
|
|
{
|
|
return null; // TODO
|
|
}
|
|
|
|
private Rectangle getTextRectangle()
|
|
{
|
|
return null; // TODO
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper class used to subscribe to FocusEvents received by the button.
|
|
*/
|
|
private class ButtonFocusListener implements FocusListener
|
|
{
|
|
/**
|
|
* Possibly repaint the model in response to loss of focus.
|
|
*
|
|
* @param event The loss-of-focus event
|
|
*/
|
|
public void focusLost(FocusEvent event)
|
|
{
|
|
if (AbstractButton.this.isFocusPainted())
|
|
AbstractButton.this.repaint();
|
|
}
|
|
|
|
/**
|
|
* Possibly repaint the button in response to acquisition of focus.
|
|
*
|
|
* @param event The gained-focus event
|
|
*/
|
|
public void focusGained(FocusEvent event)
|
|
{
|
|
if (AbstractButton.this.isFocusPainted())
|
|
AbstractButton.this.repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Creates a new AbstractButton object.
|
|
*/
|
|
AbstractButton()
|
|
{
|
|
this("",null);
|
|
}
|
|
|
|
/**
|
|
* Creates a new AbstractButton object.
|
|
*
|
|
* @param txt Value to use for the button's "text" property
|
|
* @param icon Value to use for the button's "defaultIcon" property
|
|
*/
|
|
AbstractButton(String txt, Icon icon)
|
|
{
|
|
text = txt;
|
|
default_icon = icon;
|
|
model = new DefaultButtonModel();
|
|
actionListener = createActionListener();
|
|
changeListener = createChangeListener();
|
|
itemListener = createItemListener();
|
|
|
|
model.addActionListener(actionListener);
|
|
model.addChangeListener(changeListener);
|
|
model.addItemListener(itemListener);
|
|
|
|
hori_align = CENTER;
|
|
hori_text_pos = TRAILING;
|
|
vert_align = CENTER;
|
|
vert_text_pos = CENTER;
|
|
paint_border = true;
|
|
content_area_filled = true;
|
|
|
|
setAlignmentX(LEFT_ALIGNMENT);
|
|
setAlignmentY(CENTER_ALIGNMENT);
|
|
|
|
addFocusListener(new ButtonFocusListener());
|
|
updateUI();
|
|
}
|
|
|
|
/**
|
|
* Get the model the button is currently using.
|
|
*
|
|
* @return The current model
|
|
*/
|
|
public ButtonModel getModel()
|
|
{
|
|
return model;
|
|
}
|
|
|
|
/**
|
|
* Set the model the button is currently using. This un-registers all
|
|
* listeners associated with the current model, and re-registers them
|
|
* with the new model.
|
|
*
|
|
* @param newModel The new model
|
|
*/
|
|
public void setModel(ButtonModel newModel)
|
|
{
|
|
if (newModel == model)
|
|
return;
|
|
|
|
if (model != null)
|
|
{
|
|
model.removeActionListener(actionListener);
|
|
model.removeChangeListener(changeListener);
|
|
model.removeItemListener(itemListener);
|
|
}
|
|
ButtonModel old = model;
|
|
model = newModel;
|
|
if (model != null)
|
|
{
|
|
model.addActionListener(actionListener);
|
|
model.addChangeListener(changeListener);
|
|
model.addItemListener(itemListener);
|
|
}
|
|
firePropertyChange(MODEL_CHANGED_PROPERTY, old, model);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
|
|
/**
|
|
* Get the action command string for this button's model.
|
|
*
|
|
* @return The current action command string from the button's model
|
|
*/
|
|
public String getActionCommand()
|
|
{
|
|
return getModel().getActionCommand();
|
|
}
|
|
|
|
/**
|
|
* Set the action command string for this button's model.
|
|
*
|
|
* @param aCommand The new action command string to set in the button's
|
|
* model.
|
|
*/
|
|
public void setActionCommand(String aCommand)
|
|
{
|
|
getModel().setActionCommand(aCommand);
|
|
}
|
|
|
|
/**
|
|
* Adds an ActionListener to the button's listener list. When the
|
|
* button's model is clicked it fires an ActionEvent, and these
|
|
* listeners will be called.
|
|
*
|
|
* @param l The new listener to add
|
|
*/
|
|
public void addActionListener(ActionListener l)
|
|
{
|
|
listenerList.add(ActionListener.class, l);
|
|
}
|
|
|
|
/**
|
|
* Removes an ActionListener from the button's listener list.
|
|
*
|
|
* @param l The listener to remove
|
|
*/
|
|
public void removeActionListener(ActionListener l)
|
|
{
|
|
listenerList.remove(ActionListener.class, l);
|
|
}
|
|
|
|
/**
|
|
* Adds an ItemListener to the button's listener list. When the button's
|
|
* model changes state (between any of ARMED, ENABLED, PRESSED, ROLLOVER
|
|
* or SELECTED) it fires an ItemEvent, and these listeners will be
|
|
* called.
|
|
*
|
|
* @param l The new listener to add
|
|
*/
|
|
public void addItemListener(ItemListener l)
|
|
{
|
|
listenerList.add(ItemListener.class, l);
|
|
}
|
|
|
|
/**
|
|
* Removes an ItemListener from the button's listener list.
|
|
*
|
|
* @param l The listener to remove
|
|
*/
|
|
public void removeItemListener(ItemListener l)
|
|
{
|
|
listenerList.remove(ItemListener.class, l);
|
|
}
|
|
|
|
/**
|
|
* Adds a ChangeListener to the button's listener list. When the button's
|
|
* model changes any of its (non-bound) properties, these listeners will be
|
|
* called.
|
|
*
|
|
* @param l The new listener to add
|
|
*/
|
|
public void addChangeListener(ChangeListener l)
|
|
{
|
|
listenerList.add(ChangeListener.class, l);
|
|
}
|
|
|
|
/**
|
|
* Removes a ChangeListener from the button's listener list.
|
|
*
|
|
* @param l The listener to remove
|
|
*/
|
|
public void removeChangeListener(ChangeListener l)
|
|
{
|
|
listenerList.remove(ChangeListener.class, l);
|
|
}
|
|
|
|
/**
|
|
* Calls {@link ItemListener.itemStateChanged} on each ItemListener in
|
|
* the button's listener list.
|
|
*
|
|
* @param e The event signifying that the button's model changed state
|
|
*/
|
|
public void fireItemStateChanged(ItemEvent e)
|
|
{
|
|
EventListener[] ll = listenerList.getListeners(ItemListener.class);
|
|
for (int i = 0; i < ll.length; i++)
|
|
((ItemListener)ll[i]).itemStateChanged(e);
|
|
}
|
|
|
|
/**
|
|
* Calls {@link ActionListener.actionPerformed} on each {@link
|
|
* ActionListener} in the button's listener list.
|
|
*
|
|
* @param e The event signifying that the button's model was clicked
|
|
*/
|
|
public void fireActionPerformed(ActionEvent e)
|
|
{
|
|
EventListener[] ll = listenerList.getListeners(ActionListener.class);
|
|
for (int i = 0; i < ll.length; i++)
|
|
((ActionListener)ll[i]).actionPerformed(e);
|
|
}
|
|
|
|
/**
|
|
* Calls {@link ChangeEvent.stateChanged} on each {@link ChangeListener}
|
|
* in the button's listener list.
|
|
*
|
|
* @param e The event signifying a change in one of the (non-bound)
|
|
* properties of the button's model.
|
|
*/
|
|
public void fireStateChanged(ChangeEvent e)
|
|
{
|
|
EventListener[] ll = listenerList.getListeners(ChangeListener.class);
|
|
for (int i = 0; i < ll.length; i++)
|
|
((ChangeListener)ll[i]).stateChanged(e);
|
|
}
|
|
|
|
/**
|
|
* Get the current keyboard mnemonic value. This value corresponds to a
|
|
* single key code (one of the {@link java.awt.event.KeyEvent} VK_*
|
|
* codes) and is used to activate the button when pressed in conjunction
|
|
* with the "mouseless modifier" of the button's look and feel class, and
|
|
* when focus is in one of the button's ancestors.
|
|
*
|
|
* @return The button's current keyboard mnemonic
|
|
*/
|
|
public int getMnemonic()
|
|
{
|
|
return getModel().getMnemonic();
|
|
}
|
|
|
|
/**
|
|
* Set the current keyboard mnemonic value. This value corresponds to a
|
|
* single key code (one of the {@link java.awt.event.KeyEvent} VK_*
|
|
* codes) and is used to activate the button when pressed in conjunction
|
|
* with the "mouseless modifier" of the button's look and feel class, and
|
|
* when focus is in one of the button's ancestors.
|
|
*
|
|
* @param mne A new mnemonic to use for the button
|
|
*/
|
|
public void setMnemonic(char mne)
|
|
{
|
|
int old = getModel().getMnemonic();
|
|
getModel().setMnemonic(mne);
|
|
if (old != getModel().getMnemonic())
|
|
{
|
|
firePropertyChange(MNEMONIC_CHANGED_PROPERTY, old, (int) mne);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set the current keyboard mnemonic value. This value corresponds to a
|
|
* single key code (one of the {@link java.awt.event.KeyEvent} VK_*
|
|
* codes) and is used to activate the button when pressed in conjunction
|
|
* with the "mouseless modifier" of the button's look and feel class, and
|
|
* when focus is in one of the button's ancestors.
|
|
*
|
|
* @param mne A new mnemonic to use for the button
|
|
*/
|
|
public void setMnemonic(int mne)
|
|
{
|
|
int old = mne;
|
|
getModel().setMnemonic(mne);
|
|
if (old != getModel().getMnemonic())
|
|
{
|
|
firePropertyChange(MNEMONIC_CHANGED_PROPERTY, old, mne);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Sets the button's mnemonic index. The mnemonic index is a hint to the
|
|
* look and feel class, suggesting which character in the button's label
|
|
* should be underlined when drawing the label. If the mnemonic index is
|
|
* -1, no mnemonic will be displayed.
|
|
*
|
|
* If no mnemonic index is set, the button will choose a mnemonic index
|
|
* by default, which will be the first occurrence of the mnemonic
|
|
* character in the button's text.
|
|
*
|
|
* @param index An offset into the "text" property of the button
|
|
* @throws IllegalArgumentException If <code>index</code> is not within the
|
|
* range of legal offsets for the "text" property of the button.
|
|
* @since 1.4
|
|
*/
|
|
|
|
public void setDisplayedMnemonicIndex(int index)
|
|
{
|
|
if (index < -1 || index >= text.length())
|
|
throw new IllegalArgumentException();
|
|
else
|
|
mnemonicIndex = index;
|
|
}
|
|
|
|
/**
|
|
* Get the button's mnemonic index, which is an offset into the button's
|
|
* "text" property. The character specified by this offset should be
|
|
* underlined when the look and feel class draws this button.
|
|
*
|
|
* @return An index into the button's "text" property
|
|
*/
|
|
public int getDisplayedMnemonicIndex(int index)
|
|
{
|
|
return mnemonicIndex;
|
|
}
|
|
|
|
|
|
/**
|
|
* Set the "rolloverEnabled" property. When rollover is enabled, and the
|
|
* look and feel supports it, the button will change its icon to
|
|
* rollover_icon, when the mouse passes over it.
|
|
*
|
|
* @param r Whether or not to enable rollover icon changes
|
|
*/
|
|
public void setRolloverEnabled(boolean r)
|
|
{
|
|
boolean old = getModel().isRollover();
|
|
getModel().setRollover(r);
|
|
if (old != getModel().isRollover())
|
|
{
|
|
firePropertyChange(ROLLOVER_ENABLED_CHANGED_PROPERTY, old, r);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not rollover icon changes are enabled on the
|
|
* button.
|
|
*
|
|
* @return The state of the "rolloverEnabled" property
|
|
*/
|
|
public boolean isRolloverEnabled()
|
|
{
|
|
return getModel().isRollover();
|
|
}
|
|
|
|
/**
|
|
* Set the value of the button's "selected" property. Selection is only
|
|
* meaningful for toggle-type buttons (check boxes, radio buttons).
|
|
*
|
|
* @param s New value for the property
|
|
*/
|
|
public void setSelected(boolean s)
|
|
{
|
|
getModel().setSelected(s);
|
|
}
|
|
|
|
/**
|
|
* Get the value of the button's "selected" property. Selection is only
|
|
* meaningful for toggle-type buttons (check boxes, radio buttons).
|
|
*
|
|
* @return The value of the property
|
|
*/
|
|
public boolean isSelected()
|
|
{
|
|
return getModel().isSelected();
|
|
}
|
|
|
|
/**
|
|
* Enables or disables the button. A button will neither be selectable
|
|
* nor preform any actions unless it is enabled.
|
|
*
|
|
* @param b Whether or not to enable the button
|
|
*/
|
|
public void setEnabled(boolean b)
|
|
{
|
|
super.setEnabled(b);
|
|
getModel().setEnabled(b);
|
|
}
|
|
|
|
/**
|
|
* Set the horizontal alignment of the button's text and icon. The
|
|
* alignment is a numeric constant from {@link SwingConstants}. It must
|
|
* be one of: <code>RIGHT</code>, <code>LEFT</code>, <code>CENTER</code>,
|
|
* <code>LEADING</code> or <code>TRAILING</code>. The default is
|
|
* <code>RIGHT</code>.
|
|
*
|
|
* @return The current horizontal alignment
|
|
*/
|
|
public int getHorizontalAlignment()
|
|
{
|
|
return hori_align;
|
|
}
|
|
|
|
/**
|
|
* Set the horizontal alignment of the button's text and icon. The
|
|
* alignment is a numeric constant from {@link SwingConstants}. It must
|
|
* be one of: <code>RIGHT</code>, <code>LEFT</code>, <code>CENTER</code>,
|
|
* <code>LEADING</code> or <code>TRAILING</code>. The default is
|
|
* <code>RIGHT</code>.
|
|
*
|
|
* @param a The new horizontal alignment
|
|
* @throws IllegalArgumentException If alignment is not one of the legal
|
|
* constants.
|
|
*/
|
|
public void setHorizontalAlignment(int a)
|
|
{
|
|
int old = hori_align;
|
|
hori_align = a;
|
|
if (old != a)
|
|
{
|
|
firePropertyChange(HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, old, a);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the horizontal position of the button's text relative to its
|
|
* icon. The position is a numeric constant from {@link
|
|
* SwingConstants}. It must be one of: <code>RIGHT</code>,
|
|
* <code>LEFT</code>, <code>CENTER</code>, <code>LEADING</code> or
|
|
* <code>TRAILING</code>. The default is <code>TRAILING</code>.
|
|
*
|
|
* @return The current horizontal text position
|
|
*/
|
|
public int getHorizontalTextPosition()
|
|
{
|
|
return hori_text_pos;
|
|
}
|
|
|
|
/**
|
|
* Set the horizontal position of the button's text relative to its
|
|
* icon. The position is a numeric constant from {@link
|
|
* SwingConstants}. It must be one of: <code>RIGHT</code>,
|
|
* <code>LEFT</code>, <code>CENTER</code>, <code>LEADING</code> or
|
|
* <code>TRAILING</code>. The default is <code>TRAILING</code>.
|
|
*
|
|
* @param t The new horizontal text position
|
|
* @throws IllegalArgumentException If position is not one of the legal
|
|
* constants.
|
|
*/
|
|
public void setHorizontalTextPosition(int t)
|
|
{
|
|
int old = hori_text_pos;
|
|
hori_text_pos = t;
|
|
if (old != t)
|
|
{
|
|
firePropertyChange(HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, old, t);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the vertical alignment of the button's text and icon. The
|
|
* alignment is a numeric constant from {@link SwingConstants}. It must
|
|
* be one of: <code>CENTER</code>, <code>TOP</code>, or
|
|
* <code>BOTTOM</code>. The default is <code>CENTER</code>.
|
|
*
|
|
* @return The current vertical alignment
|
|
*/
|
|
public int getVerticalAlignment()
|
|
{
|
|
return vert_align;
|
|
}
|
|
|
|
/**
|
|
* Set the vertical alignment of the button's text and icon. The
|
|
* alignment is a numeric constant from {@link SwingConstants}. It must
|
|
* be one of: <code>CENTER</code>, <code>TOP</code>, or
|
|
* <code>BOTTOM</code>. The default is <code>CENTER</code>.
|
|
*
|
|
* @param a The new vertical alignment
|
|
* @throws IllegalArgumentException If alignment is not one of the legal
|
|
* constants.
|
|
*/
|
|
public void setVerticalAlignment(int a)
|
|
{
|
|
int old = vert_align;
|
|
vert_align = a;
|
|
if (old != a)
|
|
{
|
|
firePropertyChange(VERTICAL_ALIGNMENT_CHANGED_PROPERTY, old, a);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the vertical position of the button's text relative to its
|
|
* icon. The alignment is a numeric constant from {@link
|
|
* SwingConstants}. It must be one of: <code>CENTER</code>,
|
|
* <code>TOP</code>, or <code>BOTTOM</code>. The default is
|
|
* <code>CENTER</code>.
|
|
*
|
|
* @return The current vertical position
|
|
*/
|
|
public int getVerticalTextPosition()
|
|
{
|
|
return vert_text_pos;
|
|
}
|
|
|
|
/**
|
|
* Set the vertical position of the button's text relative to its
|
|
* icon. The alignment is a numeric constant from {@link
|
|
* SwingConstants}. It must be one of: <code>CENTER</code>,
|
|
* <code>TOP</code>, or <code>BOTTOM</code>. The default is
|
|
* <code>CENTER</code>.
|
|
*
|
|
* @param t The new vertical position
|
|
* @throws IllegalArgumentException If position is not one of the legal
|
|
* constants.
|
|
*/
|
|
public void setVerticalTextPosition(int t)
|
|
{
|
|
int old = vert_text_pos;
|
|
vert_text_pos = t;
|
|
if (old != t)
|
|
{
|
|
firePropertyChange(VERTICAL_TEXT_POSITION_CHANGED_PROPERTY, old, t);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set the value of the "borderPainted" property. If set to
|
|
* <code>false</code>, the button's look and feel class should not paint
|
|
* a border for the button. The default is <code>true</code>.
|
|
*
|
|
* @return The current value of the property.
|
|
*/
|
|
public boolean isBorderPainted()
|
|
{
|
|
return paint_border;
|
|
}
|
|
|
|
/**
|
|
* Set the value of the "borderPainted" property. If set to
|
|
* <code>false</code>, the button's look and feel class should not paint
|
|
* a border for the button. The default is <code>true</code>.
|
|
*
|
|
* @param b The new value of the property.
|
|
*/
|
|
public void setBorderPainted(boolean b)
|
|
{
|
|
boolean old = paint_border;
|
|
paint_border = b;
|
|
if (b != old)
|
|
{
|
|
firePropertyChange(BORDER_PAINTED_CHANGED_PROPERTY, old, b);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the value of the "action" property.
|
|
*
|
|
* @return The current value of the "action" property
|
|
*/
|
|
public Action getAction()
|
|
{
|
|
return action;
|
|
}
|
|
|
|
/**
|
|
* <p>Set the button's "action" property, subscribing the new action to the
|
|
* button, as an ActionListener, if it is not already subscribed. The old
|
|
* Action, if it exists, is unsubscribed, and the button is unsubscribed
|
|
* from the old Action if it was previously subscribed as a
|
|
* PropertyChangeListener.</p>
|
|
*
|
|
* <p>This method also configures several of the button's properties from
|
|
* the Action, by calling {@link configurePropertiesFromAction}, and
|
|
* subscribes the button to the Action as a PropertyChangeListener.
|
|
* Subsequent changes to the Action will thus reconfigure the button
|
|
* automatically.</p>
|
|
*
|
|
* @param a The new value of the "action" property
|
|
*/
|
|
public void setAction(Action a)
|
|
{
|
|
if (action != null)
|
|
{
|
|
action.removePropertyChangeListener(actionPropertyChangeListener);
|
|
removeActionListener(action);
|
|
if (actionPropertyChangeListener != null)
|
|
{
|
|
action.removePropertyChangeListener(actionPropertyChangeListener);
|
|
actionPropertyChangeListener = null;
|
|
}
|
|
actionPropertyChangeListener = createActionPropertyChangeListener(a);
|
|
}
|
|
|
|
Action old = action;
|
|
action = a;
|
|
configurePropertiesFromAction(action);
|
|
|
|
if (action != null)
|
|
{
|
|
action.addPropertyChangeListener(actionPropertyChangeListener);
|
|
addActionListener(action);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the button's default "icon" property.
|
|
*
|
|
* @return The current default icon
|
|
*/
|
|
public Icon getIcon()
|
|
{
|
|
return default_icon;
|
|
}
|
|
|
|
/**
|
|
* Set the button's default "icon" property. This icon is used as a basis
|
|
* for the pressed and disabled icons, if none are explicitly set.
|
|
*
|
|
* @param i The new default icon
|
|
*/
|
|
public void setIcon(Icon i)
|
|
{
|
|
Icon old = default_icon;
|
|
default_icon = i;
|
|
if (old != i)
|
|
{
|
|
firePropertyChange(ICON_CHANGED_PROPERTY, old, i);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the button's "text" property. This property is synonymous with
|
|
* the "label" property.
|
|
*
|
|
* @return The current "text" property
|
|
*/
|
|
public String getText()
|
|
{
|
|
return text;
|
|
}
|
|
|
|
/**
|
|
* Set the button's "label" property. This property is synonymous with the
|
|
* "text" property.
|
|
*
|
|
* @param label The new "label" property
|
|
*/
|
|
public void setLabel(String label)
|
|
{
|
|
setText(label);
|
|
}
|
|
|
|
/**
|
|
* Return the button's "label" property. This property is synonymous with
|
|
* the "text" property.
|
|
*
|
|
* @return The current "label" property
|
|
*/
|
|
public String getLabel()
|
|
{
|
|
return getText();
|
|
}
|
|
|
|
/**
|
|
* Set the button's "text" property. This property is synonymous with the
|
|
* "label" property.
|
|
*
|
|
* @param t The new "text" property
|
|
*/
|
|
public void setText(String t)
|
|
{
|
|
String old = text;
|
|
text = t;
|
|
if (t != old)
|
|
{
|
|
firePropertyChange(TEXT_CHANGED_PROPERTY, old, t);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the button's "margin" property, which is an {@link Insets} object
|
|
* describing the distance between the button's border and its text and
|
|
* icon.
|
|
*
|
|
* @return The current "margin" property
|
|
*/
|
|
public Insets getMargin()
|
|
{
|
|
return margin;
|
|
}
|
|
|
|
/**
|
|
* Set the button's "margin" property, which is an {@link Insets} object
|
|
* describing the distance between the button's border and its text and
|
|
* icon.
|
|
*
|
|
* @param m The new "margin" property
|
|
*/
|
|
public void setMargin(Insets m)
|
|
{
|
|
Insets old = margin;
|
|
margin = m;
|
|
if (m != old)
|
|
{
|
|
firePropertyChange(MARGIN_CHANGED_PROPERTY, old, m);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the button's "pressedIcon" property. The look and feel class
|
|
* should paint this icon when the "pressed" property of the button's
|
|
* {@link ButtonModel} is <code>true</code>. This property may be
|
|
* <code>null</code>, in which case the default icon is used.
|
|
*
|
|
* @return The current "pressedIcon" property
|
|
*/
|
|
public Icon getPressedIcon()
|
|
{
|
|
return pressed_icon;
|
|
}
|
|
|
|
/**
|
|
* Set the button's "pressedIcon" property. The look and feel class
|
|
* should paint this icon when the "pressed" property of the button's
|
|
* {@link ButtonModel} is <code>true</code>. This property may be
|
|
* <code>null</code>, in which case the default icon is used.
|
|
*
|
|
* @param pressedIcon The new "pressedIcon" property
|
|
*/
|
|
public void setPressedIcon(Icon pressedIcon)
|
|
{
|
|
Icon old = pressed_icon;
|
|
pressed_icon = pressedIcon;
|
|
if (pressed_icon != old)
|
|
{
|
|
firePropertyChange(PRESSED_ICON_CHANGED_PROPERTY, old, pressed_icon);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the button's "disabledIcon" property. The look and feel class
|
|
* should paint this icon when the "enabled" property of the button's
|
|
* {@link ButtonModel} is <code>false</code>. This property may be
|
|
* <code>null</code>, in which case an icon is constructed, based on the
|
|
* default icon.
|
|
*
|
|
* @return The current "disabledIcon" property
|
|
*/
|
|
public Icon getDisabledIcon()
|
|
{
|
|
return disabled_icon;
|
|
}
|
|
|
|
/**
|
|
* Set the button's "disabledIcon" property. The look and feel class should
|
|
* paint this icon when the "enabled" property of the button's {@link
|
|
* ButtonModel} is <code>false</code>. This property may be
|
|
* <code>null</code>, in which case an icon is constructed, based on the
|
|
* default icon.
|
|
*
|
|
* @param disabledIcon The new "disabledIcon" property
|
|
*/
|
|
public void setDisabledIcon(Icon disabledIcon)
|
|
{
|
|
disabled_icon = disabledIcon;
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
|
|
/**
|
|
* Return the button's "paintFocus" property. This property controls
|
|
* whether or not the look and feel class will paint a special indicator
|
|
* of focus state for the button. If it is false, the button still paints
|
|
* when focused, but no special decoration is painted to indicate the
|
|
* presence of focus.
|
|
*
|
|
* @return The current "paintFocus" property
|
|
*/
|
|
public boolean isFocusPainted()
|
|
{
|
|
return paint_focus;
|
|
}
|
|
|
|
/**
|
|
* Set the button's "paintFocus" property. This property controls whether
|
|
* or not the look and feel class will paint a special indicator of focus
|
|
* state for the button. If it is false, the button still paints when
|
|
* focused, but no special decoration is painted to indicate the presence
|
|
* of focus.
|
|
*
|
|
* @param b The new "paintFocus" property
|
|
*/
|
|
public void setFocusPainted(boolean b)
|
|
{
|
|
boolean old = paint_focus;
|
|
paint_focus = b;
|
|
|
|
if (old != b)
|
|
{
|
|
firePropertyChange(FOCUS_PAINTED_CHANGED_PROPERTY, old, b);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the button's "focusTraversable" property. This property controls
|
|
* whether or not the button can receive focus when the user attempts to
|
|
* traverse the focus hierarchy.
|
|
*
|
|
* @return The current "focusTraversable" property
|
|
*/
|
|
public boolean isFocusTraversable()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Verifies that a particular key is one of the valid constants used for
|
|
* describing horizontal alignment and positioning. The valid constants
|
|
* are the following members of {@link SwingConstants}:
|
|
* <code>RIGHT</code>, <code>LEFT</code>, <code>CENTER</code>,
|
|
* <code>LEADING</code> or <code>TRAILING</code>.
|
|
*
|
|
* @param key The key to check
|
|
* @param exception A message to include in an IllegalArgumentException
|
|
*
|
|
* @return the value of key
|
|
*
|
|
* @throws IllegalArgumentException If key is not one of the valid constants
|
|
*
|
|
* @see setHorizontalTextPosition()
|
|
* @see setHorizontalAlignment()
|
|
*/
|
|
protected int checkHorizontalKey(int key, String exception)
|
|
{
|
|
switch (key)
|
|
{
|
|
case SwingConstants.RIGHT:
|
|
case SwingConstants.LEFT:
|
|
case SwingConstants.CENTER:
|
|
case SwingConstants.LEADING:
|
|
case SwingConstants.TRAILING:
|
|
break;
|
|
default:
|
|
throw new IllegalArgumentException(exception);
|
|
}
|
|
return key;
|
|
}
|
|
|
|
/**
|
|
* Verifies that a particular key is one of the valid constants used for
|
|
* describing vertical alignment and positioning. The valid constants are
|
|
* the following members of {@link SwingConstants}: <code>TOP</code>,
|
|
* <code>BOTTOM</code> or <code>CENTER</code>.
|
|
*
|
|
* @param key The key to check
|
|
* @param exception A message to include in an IllegalArgumentException
|
|
*
|
|
* @return the value of key
|
|
*
|
|
* @throws IllegalArgumentException If key is not one of the valid constants
|
|
*
|
|
* @see setVerticalTextPosition()
|
|
* @see setVerticalAlignment()
|
|
*/
|
|
protected int checkVerticalKey(int key, String exception)
|
|
{
|
|
switch (key)
|
|
{
|
|
case SwingConstants.TOP:
|
|
case SwingConstants.BOTTOM:
|
|
case SwingConstants.CENTER:
|
|
break;
|
|
default:
|
|
throw new IllegalArgumentException(exception);
|
|
}
|
|
return key;
|
|
}
|
|
|
|
/**
|
|
* Configure various properties of the button by reading properties
|
|
* of an {@link Action}. The mapping of properties is as follows:
|
|
*
|
|
* <table>
|
|
*
|
|
* <tr><th>Action keyed property</th> <th>AbstractButton property</th></tr>
|
|
*
|
|
* <tr><td>NAME </td> <td>text </td></tr>
|
|
* <tr><td>SMALL_ICON </td> <td>icon </td></tr>
|
|
* <tr><td>SHORT_DESCRIPTION </td> <td>toolTipText </td></tr>
|
|
* <tr><td>MNEMONIC_KEY </td> <td>mnemonic </td></tr>
|
|
* <tr><td>ACTION_COMMAND_KEY </td> <td>actionCommand </td></tr>
|
|
*
|
|
* </table>
|
|
*
|
|
* <p>In addition, this method always sets the button's "enabled" property to
|
|
* the value of the Action's "enabled" property.</p>
|
|
*
|
|
* <p>If the provided Action is <code>null</code>, the text, icon, and
|
|
* toolTipText properties of the button are set to <code>null</code>, and
|
|
* the "enabled" property is set to <code>true</code>; the mnemonic and
|
|
* actionCommand properties are unchanged.</p>
|
|
*
|
|
* @param a An Action to configure the button from
|
|
*/
|
|
protected void configurePropertiesFromAction(Action a)
|
|
{
|
|
if (a == null)
|
|
{
|
|
setText(null);
|
|
setIcon(null);
|
|
setEnabled(true);
|
|
setToolTipText(null);
|
|
}
|
|
else
|
|
{
|
|
setText((String)(a.getValue(Action.NAME)));
|
|
setIcon((Icon)(a.getValue(Action.SMALL_ICON)));
|
|
setEnabled(a.isEnabled());
|
|
setToolTipText((String)(a.getValue(Action.SHORT_DESCRIPTION)));
|
|
setMnemonic(((Integer)(a.getValue(Action.MNEMONIC_KEY))).intValue());
|
|
setActionCommand((String)(a.getValue(Action.ACTION_COMMAND_KEY)));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* <p>A factory method which should return an {@link ActionListener} that
|
|
* propagates events from the button's {@link ButtonModel} to any of the
|
|
* button's ActionListeners. By default, this is an inner class which
|
|
* calls {@link AbstractButton.fireActionPerformed} with a modified copy
|
|
* of the incoming model {@link ActionEvent}.</p>
|
|
*
|
|
* <p>The button calls this method during construction, stores the
|
|
* resulting ActionListener in its <code>actionListener</code> member
|
|
* field, and subscribes it to the button's model. If the button's model
|
|
* is changed, this listener is unsubscribed from the old model and
|
|
* subscribed to the new one.</p>
|
|
*
|
|
* @return A new ActionListener
|
|
*/
|
|
protected ActionListener createActionListener()
|
|
{
|
|
return new ActionListener()
|
|
{
|
|
public void actionPerformed(ActionEvent e)
|
|
{
|
|
e.setSource(AbstractButton.this);
|
|
AbstractButton.this.fireActionPerformed(e);
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* <p>A factory method which should return a {@link PropertyChangeListener}
|
|
* that accepts changes to the specified {@link Action} and reconfigure
|
|
* the {@link AbstractButton}, by default using the {@link
|
|
* configurePropertiesFromAction} method.</p>
|
|
*
|
|
* <p>The button calls this method whenever a new Action is assigned to
|
|
* the button's "action" property, via {@link setAction}, and stores the
|
|
* resulting PropertyChangeListener in its
|
|
* <code>actionPropertyChangeListener</code> member field. The button
|
|
* then subscribes the listener to the button's new action. If the
|
|
* button's action is changed subsequently, the listener is unsubscribed
|
|
* from the old action and subscribed to the new one.</p>
|
|
*
|
|
* @param a The Action which will be listened to, and which should be
|
|
* the same as the source of any PropertyChangeEvents received by the
|
|
* new listener returned from this method.
|
|
*
|
|
* @return A new PropertyChangeListener
|
|
*/
|
|
protected PropertyChangeListener createActionPropertyChangeListener(Action a)
|
|
{
|
|
return new PropertyChangeListener()
|
|
{
|
|
public void propertyChange(PropertyChangeEvent e)
|
|
{
|
|
Action act = (Action)(e.getSource());
|
|
AbstractButton.this.configurePropertiesFromAction(act);
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* <p>Factory method which creates a {@link ChangeListener}, used to
|
|
* subscribe to ChangeEvents from the button's model. Subclasses of
|
|
* AbstractButton may wish to override the listener used to subscribe to
|
|
* such ChangeEvents. By default, the listener just propagates the
|
|
* {@link ChangeEvent} to the button's ChangeListeners, via the {@link
|
|
* AbstractButton.fireStateChanged} method.</p>
|
|
*
|
|
* <p>The button calls this method during construction, stores the
|
|
* resulting ChangeListener in its <code>changeListener</code> member
|
|
* field, and subscribes it to the button's model. If the button's model
|
|
* is changed, this listener is unsubscribed from the old model and
|
|
* subscribed to the new one.</p>
|
|
*
|
|
* @return The new ChangeListener
|
|
*/
|
|
protected ChangeListener createChangeListener()
|
|
{
|
|
return new ChangeListener()
|
|
{
|
|
public void stateChanged(ChangeEvent e)
|
|
{
|
|
AbstractButton.this.fireStateChanged(e);
|
|
AbstractButton.this.revalidate();
|
|
AbstractButton.this.repaint();
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* <p>Factory method which creates a {@link ItemListener}, used to
|
|
* subscribe to ItemEvents from the button's model. Subclasses of
|
|
* AbstractButton may wish to override the listener used to subscribe to
|
|
* such ItemEvents. By default, the listener just propagates the
|
|
* {@link ItemEvent} to the button's ItemListeners, via the {@link
|
|
* AbstractButton.fireItemStateChanged} method.</p>
|
|
*
|
|
* <p>The button calls this method during construction, stores the
|
|
* resulting ItemListener in its <code>changeListener</code> member
|
|
* field, and subscribes it to the button's model. If the button's model
|
|
* is changed, this listener is unsubscribed from the old model and
|
|
* subscribed to the new one.</p>
|
|
*
|
|
* <p>Note that ItemEvents are only generated from the button's model
|
|
* when the model's <em>selected</em> property changes. If you want to
|
|
* subscribe to other properties of the model, you must subscribe to
|
|
* ChangeEvents.
|
|
*
|
|
* @return The new ItemListener
|
|
*/
|
|
protected ItemListener createItemListener()
|
|
{
|
|
return new ItemListener()
|
|
{
|
|
public void itemStateChanged(ItemEvent e)
|
|
{
|
|
AbstractButton.this.fireItemStateChanged(e);
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Programmatically perform a "click" on the button: arming, pressing,
|
|
* waiting, un-pressing, and disarming the model.
|
|
*/
|
|
public void doClick()
|
|
{
|
|
doClick(100);
|
|
}
|
|
|
|
/**
|
|
* Programmatically perform a "click" on the button: arming, pressing,
|
|
* waiting, un-pressing, and disarming the model.
|
|
*
|
|
* @param pressTime The number of milliseconds to wait in the pressed state
|
|
*/
|
|
public void doClick(int pressTime)
|
|
{
|
|
getModel().setArmed(true);
|
|
getModel().setPressed(true);
|
|
try
|
|
{
|
|
java.lang.Thread.sleep(pressTime);
|
|
}
|
|
catch (java.lang.InterruptedException e)
|
|
{
|
|
// probably harmless
|
|
}
|
|
getModel().setPressed(false);
|
|
getModel().setArmed(false);
|
|
}
|
|
|
|
/**
|
|
* Return the button's disabled selected icon. The look and feel class
|
|
* should paint this icon when the "enabled" property of the button's model
|
|
* is <code>false</code> and its "selected" property is
|
|
* <code>true</code>. This icon can be <code>null</code>, in which case
|
|
* it is synthesized from the button's selected icon.
|
|
*
|
|
* @return The current disabled selected icon
|
|
*/
|
|
public Icon getDisabledSelectedIcon()
|
|
{
|
|
return disabled_selected_icon;
|
|
}
|
|
|
|
/**
|
|
* Set the button's disabled selected icon. The look and feel class
|
|
* should paint this icon when the "enabled" property of the button's model
|
|
* is <code>false</code> and its "selected" property is
|
|
* <code>true</code>. This icon can be <code>null</code>, in which case
|
|
* it is synthesized from the button's selected icon.
|
|
*
|
|
* @param disabledSelectedIcon The new disabled selected icon
|
|
*/
|
|
public void setDisabledSelectedIcon(Icon disabledSelectedIcon)
|
|
{
|
|
Icon old = disabled_selected_icon;
|
|
disabled_selected_icon = disabledSelectedIcon;
|
|
if (old != disabledSelectedIcon)
|
|
{
|
|
firePropertyChange(DISABLED_SELECTED_ICON_CHANGED_PROPERTY, old,
|
|
disabledSelectedIcon);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Return the button's rollover icon. The look and feel class should
|
|
* paint this icon when the "rolloverEnabled" property of the button is
|
|
* <code>true</code> and the mouse rolls over the button.
|
|
*
|
|
* @return The current rollover icon
|
|
*/
|
|
public Icon getRolloverIcon()
|
|
{
|
|
return rollover_icon;
|
|
}
|
|
|
|
/**
|
|
* Set the button's rollover icon. The look and feel class should
|
|
* paint this icon when the "rolloverEnabled" property of the button is
|
|
* <code>true</code> and the mouse rolls over the button.
|
|
*
|
|
* @param rolloverIcon The new rollover icon
|
|
*/
|
|
public void setRolloverIcon(Icon rolloverIcon)
|
|
{
|
|
Icon old = rollover_icon;
|
|
rollover_icon = rolloverIcon;
|
|
if (old != rolloverIcon)
|
|
{
|
|
firePropertyChange(ROLLOVER_ICON_CHANGED_PROPERTY, old,
|
|
rolloverIcon);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the button's rollover selected icon. The look and feel class
|
|
* should paint this icon when the "rolloverEnabled" property of the button
|
|
* is <code>true</code>, the "selected" property of the button's model is
|
|
* <code>true</code>, and the mouse rolls over the button.
|
|
*
|
|
* @return The current rollover selected icon
|
|
*/
|
|
public Icon getRolloverSelectedIcon()
|
|
{
|
|
return rollover_selected_icon;
|
|
}
|
|
|
|
/**
|
|
* Set the button's rollover selected icon. The look and feel class
|
|
* should paint this icon when the "rolloverEnabled" property of the button
|
|
* is <code>true</code>, the "selected" property of the button's model is
|
|
* <code>true</code>, and the mouse rolls over the button.
|
|
*
|
|
* @param rolloverSelectedIcon The new rollover selected icon
|
|
*/
|
|
public void setRolloverSelectedIcon(Icon rolloverSelectedIcon)
|
|
{
|
|
Icon old = rollover_selected_icon;
|
|
rollover_selected_icon = rolloverSelectedIcon;
|
|
if (old != rolloverSelectedIcon)
|
|
{
|
|
firePropertyChange(ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, old,
|
|
rolloverSelectedIcon);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Return the button's selected icon. The look and feel class should
|
|
* paint this icon when the "selected" property of the button's model is
|
|
* <code>true</code>, and either the "rolloverEnabled" property of the
|
|
* button is <code>false</code> or the mouse is not currently rolled
|
|
* over the button.
|
|
*
|
|
* @return The current selected icon
|
|
*/
|
|
public Icon getSelectedIcon()
|
|
{
|
|
return selected_icon;
|
|
}
|
|
|
|
/**
|
|
* Set the button's selected icon. The look and feel class should
|
|
* paint this icon when the "selected" property of the button's model is
|
|
* <code>true</code>, and either the "rolloverEnabled" property of the
|
|
* button is <code>false</code> or the mouse is not currently rolled
|
|
* over the button.
|
|
*
|
|
* @param selectedIcon The new selected icon
|
|
*/
|
|
public void setSelectedIcon(Icon selectedIcon)
|
|
{
|
|
Icon old = selected_icon;
|
|
selected_icon = selectedIcon;
|
|
if (old != selectedIcon)
|
|
{
|
|
firePropertyChange(SELECTED_ICON_CHANGED_PROPERTY, old,
|
|
selectedIcon);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns an single-element array containing the "text" property of the
|
|
* button if the "selected" property of the button's model is
|
|
* <code>true</code>, otherwise returns <code>null</code>.
|
|
*
|
|
* @return The button's "selected object" array
|
|
*/
|
|
public Object[] getSelectedObjects()
|
|
{
|
|
if (isSelected())
|
|
{
|
|
Object[] objs = new Object[1];
|
|
objs[0] = getText();
|
|
return objs;
|
|
}
|
|
else
|
|
{
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Called when image data becomes available for one of the button's icons.
|
|
*
|
|
* @param img The image being updated
|
|
* @param infoflags One of the constant codes in {@link ImageObserver} used to describe
|
|
* updated portions of an image.
|
|
* @param x X coordinate of the region being updated
|
|
* @param y Y coordinate of the region being updated
|
|
* @param w Width of the region beign updated
|
|
* @param h Height of the region being updated
|
|
*
|
|
* @return <code>true</code> if img is equal to the button's current
|
|
* icon, otherwise <code>false</code>
|
|
*/
|
|
public boolean imageUpdate(Image img, int infoflags, int x, int y, int w,
|
|
int h)
|
|
{
|
|
return current_icon == img;
|
|
}
|
|
|
|
/**
|
|
* Returns the value of the button's "contentAreaFilled" property. This
|
|
* property indicates whether the area surrounding the text and icon of
|
|
* the button should be filled by the look and feel class. If this
|
|
* property is <code>false</code>, the look and feel class should leave
|
|
* the content area transparent.
|
|
*
|
|
* @return The current value of the "contentAreaFilled" property
|
|
*/
|
|
public boolean isContentAreaFilled()
|
|
{
|
|
return content_area_filled;
|
|
}
|
|
|
|
/**
|
|
* Sets the value of the button's "contentAreaFilled" property. This
|
|
* property indicates whether the area surrounding the text and icon of
|
|
* the button should be filled by the look and feel class. If this
|
|
* property is <code>false</code>, the look and feel class should leave
|
|
* the content area transparent.
|
|
*
|
|
* @param b The new value of the "contentAreaFilled" property
|
|
*/
|
|
public void setContentAreaFilled(boolean b)
|
|
{
|
|
boolean old = content_area_filled;
|
|
content_area_filled = b;
|
|
if (b != old)
|
|
{
|
|
firePropertyChange(CONTENT_AREA_FILLED_CHANGED_PROPERTY, old, b);
|
|
revalidate();
|
|
repaint();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Paints the button's border, if the button's "borderPainted" property is
|
|
* <code>true</code>, by out calling to the button's look and feel class.
|
|
*
|
|
* @param g The graphics context used to paint the border
|
|
*/
|
|
protected void paintBorder(Graphics g)
|
|
{
|
|
if (isBorderPainted())
|
|
super.paintBorder(g);
|
|
}
|
|
|
|
/**
|
|
* Returns a string, used only for debugging, which identifies or somehow
|
|
* represents this button. The exact value is implementation-defined.
|
|
*
|
|
* @return A string representation of the button
|
|
*/
|
|
protected String paramString()
|
|
{
|
|
return "AbstractButton";
|
|
}
|
|
|
|
|
|
/**
|
|
* Set the "UI" property of the button, which is a look and feel class
|
|
* responsible for handling the button's input events and painting it.
|
|
*
|
|
* @param ui The new "UI" property
|
|
*/
|
|
public void setUI(ButtonUI ui)
|
|
{
|
|
super.setUI(ui);
|
|
}
|
|
|
|
/**
|
|
* Set the "UI" property of the button, which is a look and feel class
|
|
* responsible for handling the button's input events and painting it.
|
|
*
|
|
* @return The current "UI" property
|
|
*/
|
|
public ButtonUI getUI()
|
|
{
|
|
return (ButtonUI) ui;
|
|
}
|
|
|
|
/**
|
|
* Set the "UI" property to a class constructed, via the {@link
|
|
* UIManager}, from the current look and feel. This should be overridden
|
|
* for each subclass of AbstractButton, to retrieve a suitable {@link
|
|
* ButtonUI} look and feel class.
|
|
*/
|
|
public void updateUI()
|
|
{
|
|
}
|
|
}
|