diff options
Diffstat (limited to 'libjava/classpath/javax/swing/JButton.java')
| -rw-r--r-- | libjava/classpath/javax/swing/JButton.java | 129 |
1 files changed, 111 insertions, 18 deletions
diff --git a/libjava/classpath/javax/swing/JButton.java b/libjava/classpath/javax/swing/JButton.java index ff0ecfccfd4..787adb87cf1 100644 --- a/libjava/classpath/javax/swing/JButton.java +++ b/libjava/classpath/javax/swing/JButton.java @@ -1,5 +1,5 @@ /* JButton.java -- - Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc. + Copyright (C) 2002, 2004, 2005, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -72,49 +72,82 @@ public class JButton extends AbstractButton } private static final long serialVersionUID = -1907255238954382202L; - boolean def; - boolean is_def; + /** + * Indicates if this button is capable to become the default button. + */ + private boolean defaultCapable; + + /** + * Creates a new button with an empty string for the button text and no + * icon. + */ public JButton() { this(null, null); } + /** + * Creates a new button from the specified action. + * + * @param a the action (<code>null</code> permitted). + * + * @see AbstractButton#setAction(Action) + */ public JButton(Action a) { this(); setAction(a); } + /** + * Creates a new button with the specified icon (and an empty string for + * the button text). + * + * @param icon the icon (<code>null</code> permitted). + */ public JButton(Icon icon) { this(null, icon); } + /** + * Creates a new button with the specified text and no icon. + * + * @param text the button text (<code>null</code> permitted, will be + * substituted by an empty string). + */ public JButton(String text) { this(text, null); } + /** + * Creates a new button with the specified text and icon. + * + * @param text the button text (<code>null</code> permitted, will be + * substituted by an empty string). + * @param icon the icon (<code>null</code> permitted). + */ public JButton(String text, Icon icon) { super(); init(text, icon); setModel(new DefaultButtonModel()); - } - - public Object[] getSelectedObjects() - { - return null; + defaultCapable = true; } protected void configurePropertiesFromAction(Action a) - { - // Factory method which sets the AbstractButton's properties according to - // values from the Action instance. + { super.configurePropertiesFromAction(a); } + /** + * Returns the object that provides accessibility features for this + * <code>JButton</code> component. + * + * @return The accessible context (an instance of {@link AccessibleJButton}). + */ public AccessibleContext getAccessibleContext() { if (accessibleContext == null) @@ -122,6 +155,13 @@ public class JButton extends AbstractButton return accessibleContext; } + /** + * Returns the suffix (<code>"ButtonUI"</code> in this case) used to + * determine the class name for a UI delegate that can provide the look and + * feel for a <code>JButton</code>. + * + * @return <code>"ButtonUI"</code>. + */ public String getUIClassID() { // Returns a string that specifies the name of the L&F class that renders @@ -129,28 +169,65 @@ public class JButton extends AbstractButton return "ButtonUI"; } + /** + * Returns <code>true</code> if this button is the default button in + * its <code>JRootPane</code>. The default button gets automatically + * activated when the user presses <code>ENTER</code> (or whatever + * key this is bound to in the current Look and Feel). + * + * @return <code>true</code> if this button is the default button in + * its <code>JRootPane</code> + * + * @see #isDefaultCapable() + * @see #setDefaultCapable(boolean) + * @see JRootPane#getDefaultButton() + * @see JRootPane#setDefaultButton(JButton) + */ public boolean isDefaultButton() { - // Returns whether or not this button is the default button on the - // RootPane. - return is_def; + // The default button is managed by the JRootPane, so the safest way + // to determine this property is to ask the root pane of this button, + // if it exists. + JRootPane rp = SwingUtilities.getRootPane(this); + boolean isDefault = false; + if (rp != null) + isDefault = rp.getDefaultButton() == this; + return isDefault; } + /** + * Returns <code>true</code> if this button can act as the default button. + * This is <code>true</code> by default. + * + * @return <code>true</code> if this button can act as the default button + * + * @see #setDefaultCapable(boolean) + * @see #isDefaultButton() + * @see JRootPane#getDefaultButton() + * @see JRootPane#setDefaultButton(JButton) + */ public boolean isDefaultCapable() { // Returns whether or not this button is capable of being the default // button on the RootPane. - return def; + return defaultCapable; } + /** + * Returns an implementation-dependent string describing the attributes of + * this <code>JButton</code>. + * + * @return A string describing the attributes of this <code>JButton</code> + * (never <code>null</code>). + */ protected String paramString() { String superParam = super.paramString(); // 41 is the maximum number of chars which may be needed. StringBuffer sb = new StringBuffer(41); - sb.append(",defaultButton=").append(is_def); - sb.append(",defaultCapable=").append(def); + sb.append(",defaultButton=").append(isDefaultButton()); + sb.append(",defaultCapable=").append(defaultCapable); return superParam + sb.toString(); } @@ -169,11 +246,27 @@ public class JButton extends AbstractButton super.removeNotify(); } + /** + * Sets the <code>defaultCapable</code> property which indicates if + * this button may become the default button in its <code>JRootPane</code>. + * + * @param defaultCapable <code>true</code> if this button can become the + * default button in its JRootPane, <code>false</code> otherwise + * + * @see #setDefaultCapable(boolean) + * @see #isDefaultButton() + * @see JRootPane#getDefaultButton() + * @see JRootPane#setDefaultButton(JButton) + */ public void setDefaultCapable(boolean defaultCapable) { - def = defaultCapable; + this.defaultCapable = defaultCapable; } + /** + * Sets this button's UI delegate to the default (obtained from the + * {@link UIManager}) for the current look and feel. + */ public void updateUI() { setUI((ButtonUI) UIManager.getUI(this)); |