ImageObserver
, ItemSelectable
, MenuContainer
, Serializable
, Accessible
, SwingConstants
JCheckBox
, JRadioButton
@JavaBean(defaultProperty="UIClassID", description="An implementation of a two-state button.") public class JToggleButton extends AbstractButton implements Accessible
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
Action
s. 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
.
JRadioButton
,
JCheckBox
Modifier and Type | Class | Description |
---|---|---|
protected class |
JToggleButton.AccessibleJToggleButton |
This class implements accessibility support for the
JToggleButton class. |
static class |
JToggleButton.ToggleButtonModel |
The ToggleButton model
|
AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Container.AccessibleAWTContainer
JComponent.AccessibleJComponent
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
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
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.
|
Modifier and Type | Method | Description |
---|---|---|
AccessibleContext |
getAccessibleContext() |
Gets the AccessibleContext associated with this JToggleButton.
|
String |
getUIClassID() |
Returns a string that specifies the name of the l&f class
that renders this component.
|
protected String |
paramString() |
Returns a string representation of this JToggleButton.
|
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. |
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. |
void |
updateUI() |
Resets the UI property to a value from the current look and feel.
|
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
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, 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, 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
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
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, 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, hide, 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
public JToggleButton()
public JToggleButton(Icon icon)
icon
- the image that the button should displaypublic JToggleButton(Icon icon, boolean selected)
icon
- the image that the button should displayselected
- if true, the button is initially selected;
otherwise, the button is initially unselectedpublic JToggleButton(String text)
text
- the string displayed on the toggle buttonpublic JToggleButton(String text, boolean selected)
text
- the string displayed on the toggle buttonselected
- if true, the button is initially selected;
otherwise, the button is initially unselectedpublic JToggleButton(Action a)
a
- an instance of an Action
public JToggleButton(String text, Icon icon)
text
- the string displayed on the buttonicon
- the image that the button should displaypublic JToggleButton(String text, Icon icon, boolean selected)
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 unselectedpublic void updateUI()
updateUI
in class AbstractButton
JComponent.updateUI()
@BeanProperty(bound=false, description="A string that specifies the name of the L&F class") public String getUIClassID()
getUIClassID
in class JComponent
JComponent.getUIClassID()
,
UIDefaults.getUI(javax.swing.JComponent)
public void requestFocus(FocusEvent.Cause cause)
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.requestFocus
in class Component
cause
- the cause why the focus is requestedButtonGroup
,
Component.requestFocus(FocusEvent.Cause)
,
FocusEvent.Cause
public boolean requestFocusInWindow(FocusEvent.Cause cause)
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.requestFocusInWindow
in class Component
cause
- the cause why the focus is requestedfalse
if the focus change request is guaranteed to
fail; true
if it is likely to succeedButtonGroup
,
Component.requestFocusInWindow(FocusEvent.Cause)
,
FocusEvent.Cause
protected String paramString()
null
.paramString
in class AbstractButton
@BeanProperty(bound=false, expert=true, description="The AccessibleContext associated with this ToggleButton.") public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
getAccessibleContext
in class Component
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps