- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.AbstractButton
-
- javax.swing.JToggleButton
-
- 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. TheJRadioButtonandJCheckBoxclasses 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 anActionwith a button has many benefits beyond directly configuring a button. Refer to Swing Components SupportingActionfor 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.beanspackage. Please seeXMLEncoder.- Since:
- 1.2
- See Also:
JRadioButton,JCheckBox, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected classJToggleButton.AccessibleJToggleButtonThis class implements accessibility support for theJToggleButtonclass.static classJToggleButton.ToggleButtonModelThe ToggleButton model-
Nested classes/interfaces declared in class javax.swing.AbstractButton
AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener
-
Nested classes/interfaces declared in class javax.swing.JComponent
JComponent.AccessibleJComponent
-
Nested classes/interfaces declared in class java.awt.Container
Container.AccessibleAWTContainer
-
Nested classes/interfaces declared in class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
-
Field Summary
-
Fields declared in class javax.swing.AbstractButton
actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY
-
Fields declared in class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
-
Fields declared in class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
-
Fields declared in interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
-
Fields declared in interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
-
-
Constructor Summary
Constructors Constructor Description JToggleButton()Creates an initially unselected toggle button without setting the text or image.JToggleButton(String text)Creates an unselected toggle button with the specified text.JToggleButton(String text, boolean selected)Creates a toggle button with the specified text and selection state.JToggleButton(String text, Icon icon)Creates a toggle button that has the specified text and image, and that is initially unselected.JToggleButton(String text, Icon icon, boolean selected)Creates a toggle button with the specified text, image, and selection state.JToggleButton(Action a)Creates a toggle button where properties are taken from the Action supplied.JToggleButton(Icon icon)Creates an initially unselected toggle button with the specified image but no text.JToggleButton(Icon icon, boolean selected)Creates a toggle button with the specified image and selection state, but no text.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AccessibleContextgetAccessibleContext()Gets the AccessibleContext associated with this JToggleButton.StringgetUIClassID()Returns a string that specifies the name of the l&f class that renders this component.protected StringparamString()Returns a string representation of this JToggleButton.voidrequestFocus(FocusEvent.Cause cause)If this toggle button is a member of theButtonGroupwhich 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 callingComponent.requestFocus(FocusEvent.Cause)on the toggle button selected in the group.booleanrequestFocusInWindow(FocusEvent.Cause cause)If this toggle button is a member of theButtonGroupwhich 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 callingComponent.requestFocusInWindow(FocusEvent.Cause)on the toggle button selected in the group.voidupdateUI()Resets the UI property to a value from the current look and feel.-
Methods declared in class javax.swing.AbstractButton
actionPropertyChanged, addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition
-
Methods declared in class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
-
Methods declared in class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree
-
Methods declared in class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Constructor Detail
-
JToggleButton
public JToggleButton()
Creates an initially unselected toggle button without setting the text or image.
-
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
-
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 displayselected- if true, the button is initially selected; otherwise, the button is initially unselected
-
JToggleButton
public JToggleButton(String text)
Creates an unselected toggle button with the specified text.- Parameters:
text- the string displayed on the toggle button
-
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 buttonselected- if true, the button is initially selected; otherwise, the button is initially unselected
-
JToggleButton
public JToggleButton(Action a)
Creates a toggle button where properties are taken from the Action supplied.- Parameters:
a- an instance of anAction- Since:
- 1.3
-
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 buttonicon- the image that the button should display
-
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 buttonicon- the image that the button should displayselected- if true, the button is initially selected; otherwise, the button is initially unselected
-
-
Method Detail
-
updateUI
public void updateUI()
Resets the UI property to a value from the current look and feel.- Overrides:
updateUIin classAbstractButton- See Also:
JComponent.updateUI()
-
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:
getUIClassIDin classJComponent- Returns:
- String "ToggleButtonUI"
- See Also:
JComponent.getUIClassID(),UIDefaults.getUI(javax.swing.JComponent)
-
requestFocus
public void requestFocus(FocusEvent.Cause cause)
If this toggle button is a member of theButtonGroupwhich 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 callingComponent.requestFocus(FocusEvent.Cause)on the toggle button selected in the group. In all other cases the result of the method is the same as callingComponent.requestFocus(FocusEvent.Cause)on this toggle button.- Overrides:
requestFocusin classComponent- Parameters:
cause- the cause why the focus is requested- Since:
- 9
- See Also:
ButtonGroup,Component.requestFocus(FocusEvent.Cause),FocusEvent.Cause
-
requestFocusInWindow
public boolean requestFocusInWindow(FocusEvent.Cause cause)
If this toggle button is a member of theButtonGroupwhich 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 callingComponent.requestFocusInWindow(FocusEvent.Cause)on the toggle button selected in the group. In all other cases the result of the method is the same as callingComponent.requestFocusInWindow(FocusEvent.Cause)on this toggle button.- Overrides:
requestFocusInWindowin classComponent- Parameters:
cause- the cause why the focus is requested- Returns:
falseif the focus change request is guaranteed to fail;trueif it is likely to succeed- Since:
- 9
- See Also:
ButtonGroup,Component.requestFocusInWindow(FocusEvent.Cause),FocusEvent.Cause
-
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 benull.- Overrides:
paramStringin classAbstractButton- Returns:
- a string representation of this JToggleButton.
-
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:
getAccessibleContextin interfaceAccessible- Overrides:
getAccessibleContextin classComponent- Returns:
- an AccessibleJToggleButton that serves as the AccessibleContext of this JToggleButton
-
-