Package Summary  Overview Summary

class:JToggleButton [CHANGED]

All Implemented Interfaces:
ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants
Direct Known Subclasses:
JCheckBox, JRadioButton

@JavaBean(defaultProperty="UIClassID",
          description="An implementation of a two-state button.")
public class JToggleButton
extends AbstractButton
implements Accessible
An implementation of a two-state button. The JRadioButton and JCheckBox classes are subclasses of this class. For information on using them see How to Use Buttons, Check Boxes, and Radio Buttons , a section in The Java Tutorial .

Buttons can be configured, and to some degree controlled, by Actions. Using an Action with a button has many benefits beyond directly configuring a button. Refer to Swing Components Supporting Action for more details, and you can find more information in How to Use Actions , a section in The Java Tutorial .

Warning: Swing is not thread safe. For more information see Swing's Threading Policy .

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™JavaBeans has been added to the java.beans package. Please see XMLEncoder.

Since:
1.2
See Also:
JRadioButton, JCheckBox
All Implemented Interfaces:
ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants
Direct Known Subclasses:
JCheckBox, JRadioButton

@JavaBean(defaultProperty="UIClassID",
          description="An implementation of a two-state button.")
public class JToggleButton
extends AbstractButton
implements Accessible
An implementation of a two-state button. The JRadioButton and JCheckBox classes are subclasses of this class. For information on using them see How to Use Buttons, Check Boxes, and Radio Buttons , a section in The Java Tutorial .

Buttons can be configured, and to some degree controlled, by Actions. Using an Action with a button has many benefits beyond directly configuring a button. Refer to Swing Components Supporting Action for more details, and you can find more information in How to Use Actions , a section in The Java Tutorial .

Warning: Swing is not thread safe. For more information see Swing's Threading Policy .

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.

Since:
1.2
See Also:
JRadioButton, JCheckBox
All Implemented Interfaces:
ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants
Direct Known Subclasses:
JCheckBox, JRadioButton

@JavaBean(defaultProperty="UIClassID",
          description="An implementation of a two-state button.")
public class JToggleButton
extends AbstractButton
implements Accessible
An implementation of a two-state button. The JRadioButton and JCheckBox classes are subclasses of this class. For information on using them see How to Use Buttons, Check Boxes, and Radio Buttons , a section in The Java Tutorial .

Buttons can be configured, and to some degree controlled, by Actions. Using an Action with a button has many benefits beyond directly configuring a button. Refer to Swing Components Supporting Action for more details, and you can find more information in How to Use Actions , a section in The Java Tutorial .

Warning: Swing is not thread safe. For more information see Swing's Threading Policy .

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the java.beans package. Please see XMLEncoder.

Since:
1.2
See Also:
JRadioButton, JCheckBox

constructor:JToggleButton() [NONE]

  • JToggleButton

    public JToggleButton()
    Creates an initially unselected toggle button without setting the text or image.
  • constructor:JToggleButton(javax.swing.Icon) [NONE]

    JToggleButton

    public JToggleButton?(Icon icon)
    Creates an initially unselected toggle button with the specified image but no text.
    Parameters:
    icon - the image that the button should display

    constructor:JToggleButton(javax.swing.Icon,boolean) [NONE]

    JToggleButton

    public JToggleButton?(Icon icon, boolean selected)
    Creates a toggle button with the specified image and selection state, but no text.
    Parameters:
    icon - the image that the button should display
    selected - if true, the button is initially selected; otherwise, the button is initially unselected

    constructor:JToggleButton(java.lang.String) [NONE]

    JToggleButton

    public JToggleButton?(String text)
    Creates an unselected toggle button with the specified text.
    Parameters:
    text - the string displayed on the toggle button

    constructor:JToggleButton(java.lang.String,boolean) [NONE]

    JToggleButton

    public JToggleButton?(String text, boolean selected)
    Creates a toggle button with the specified text and selection state.
    Parameters:
    text - the string displayed on the toggle button
    selected - if true, the button is initially selected; otherwise, the button is initially unselected

    constructor:JToggleButton(javax.swing.Action) [NONE]

    JToggleButton

    public JToggleButton?(Action a)
    Creates a toggle button where properties are taken from the Action supplied.
    Parameters:
    a - an instance of an Action
    Since:
    1.3

    constructor:JToggleButton(java.lang.String,javax.swing.Icon) [NONE]

    JToggleButton

    public JToggleButton?(String text, Icon icon)
    Creates a toggle button that has the specified text and image, and that is initially unselected.
    Parameters:
    text - the string displayed on the button
    icon - the image that the button should display

    constructor:JToggleButton(java.lang.String,javax.swing.Icon,boolean) [NONE]

    JToggleButton

    public JToggleButton?(String text, Icon icon, boolean selected)
    Creates a toggle button with the specified text, image, and selection state.
    Parameters:
    text - the text of the toggle button
    icon - the image that the button should display
    selected - if true, the button is initially selected; otherwise, the button is initially unselected

    method:updateUI() [NONE]

  • updateUI

    public void updateUI()
    Resets the UI property to a value from the current look and feel.
    Overrides:
    updateUI in class AbstractButton
    See Also:
    JComponent.updateUI()
  • method:getUIClassID() [NONE]

    getUIClassID

    @BeanProperty(bound=false, description="A string that specifies the name of the L&F class") public String getUIClassID()
    Returns a string that specifies the name of the l&f class that renders this component.
    Overrides:
    getUIClassID in class JComponent
    Returns:
    the string "ToggleButtonUI"
    See Also:
    JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

    method:requestFocus(java.awt.event.FocusEvent.Cause) [NONE]

    requestFocus

    public void requestFocus?(FocusEvent.Cause cause)
    If this toggle button is a member of the ButtonGroup which has another toggle button which is selected and can be the focus owner, and the focus cause argument denotes window activation or focus traversal action of any direction the result of the method execution is the same as calling Component.requestFocus(FocusEvent.Cause) on the toggle button selected in the group. In all other cases the result of the method is the same as calling Component.requestFocus(FocusEvent.Cause) on this toggle button.
    Overrides:
    requestFocus in class Component
    Parameters:
    cause - the cause why the focus is requested
    Since:
    9
    See Also:
    ButtonGroup, Component.requestFocus(FocusEvent.Cause), FocusEvent.Cause

    method:requestFocusInWindow(java.awt.event.FocusEvent.Cause) [NONE]

    requestFocusInWindow

    public boolean requestFocusInWindow?(FocusEvent.Cause cause)
    If this toggle button is a member of the ButtonGroup which has another toggle button which is selected and can be the focus owner, and the focus cause argument denotes window activation or focus traversal action of any direction the result of the method execution is the same as calling Component.requestFocusInWindow(FocusEvent.Cause) on the toggle button selected in the group. In all other cases the result of the method is the same as calling Component.requestFocusInWindow(FocusEvent.Cause) on this toggle button.
    Overrides:
    requestFocusInWindow in class Component
    Parameters:
    cause - the cause why the focus is requested
    Returns:
    false if the focus change request is guaranteed to fail; true if it is likely to succeed
    Since:
    9
    See Also:
    ButtonGroup, Component.requestFocusInWindow(FocusEvent.Cause), FocusEvent.Cause

    method:paramString() [NONE]

    paramString

    protected String paramString()
    Returns a string representation of this JToggleButton. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.
    Overrides:
    paramString in class AbstractButton
    Returns:
    a string representation of this JToggleButton.

    method:getAccessibleContext() [NONE]

    getAccessibleContext

    @BeanProperty(bound=false, expert=true, description="The AccessibleContext associated with this ToggleButton.") public AccessibleContext getAccessibleContext()
    Gets the AccessibleContext associated with this JToggleButton. For toggle buttons, the AccessibleContext takes the form of an AccessibleJToggleButton. A new AccessibleJToggleButton instance is created if necessary.
    Specified by:
    getAccessibleContext in interface Accessible
    Overrides:
    getAccessibleContext in class Component
    Returns:
    an AccessibleJToggleButton that serves as the AccessibleContext of this JToggleButton

    © 2020 Oracle Corporation and/or its affiliates