Class FlatToggleButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JToggleButton

com.formdev.flatlaf.extras.components.FlatToggleButton

All Implemented Interfaces:

FlatComponentExtension, FlatStyleableComponent, ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants

public class FlatToggleButton
extends JToggleButton
implements FlatComponentExtension, FlatStyleableComponent

Subclass of JToggleButton that provides easy access to FlatLaf specific client properties.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class JToggleButton

JToggleButton.AccessibleJToggleButton, JToggleButton.ToggleButtonModel

Nested classes/interfaces inherited from class AbstractButton

AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class 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 inherited from class JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface 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
FlatToggleButton()

Method Summary

Modifier and Type	Method	Description
FlatButton.ButtonType	getButtonType()	Returns type of button.
int	getMinimumHeight()	Returns minimum height of a component.
int	getMinimumWidth()	Returns minimum width of a component.
Object	getOutline()	Returns the outline color of the component border.
Color	getTabSelectedBackground()	Returns background color if selected and toggle button type is FlatButton.ButtonType.tab.
Color	getTabUnderlineColor()	Returns color of underline if toggle button type is FlatButton.ButtonType.tab.
int	getTabUnderlineHeight()	Returns thickness of underline if toggle button type is FlatButton.ButtonType.tab.
int	getTabUnderlinePlacement()	Returns placement of underline if toggle button type is FlatButton.ButtonType.tab.
boolean	isSquareSize()	Returns whether the button preferred size will be made square (quadratically).
void	setButtonType(FlatButton.ButtonType buttonType)	Specifies type of button.
void	setMinimumHeight(int minimumHeight)	Specifies minimum height of a component.
void	setMinimumWidth(int minimumWidth)	Specifies minimum width of a component.
void	setOutline(Object outline)	Specifies the outline color of the component border.
void	setSquareSize(boolean squareSize)	Specifies whether the button preferred size will be made square (quadratically).
void	setTabSelectedBackground(Color tabSelectedBackground)	Specifies background color if selected and toggle button type is FlatButton.ButtonType.tab.
void	setTabUnderlineColor(Color tabUnderlineColor)	Specifies color of underline if toggle button type is FlatButton.ButtonType.tab.
void	setTabUnderlineHeight(int tabUnderlineHeight)	Specifies thickness of underline if toggle button type is FlatButton.ButtonType.tab.
void	setTabUnderlinePlacement(int placement)	Specifies placement of underline if toggle button type is FlatButton.ButtonType.tab.

Methods inherited from class JToggleButton

getAccessibleContext, getUIClassID, paramString, requestFocus, requestFocusInWindow, updateUI

Methods inherited from class 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 inherited from class JComponent

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

Methods inherited from class 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 inherited from class 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, 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

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface FlatComponentExtension

getClientProperty, getClientPropertyBoolean, getClientPropertyBoolean, getClientPropertyColor, getClientPropertyEnumString, getClientPropertyInsets, getClientPropertyInt, getClientPropertyInt, putClientProperty, putClientPropertyBoolean, putClientPropertyEnumString

Methods inherited from interface FlatStyleableComponent

getClientProperty, getStyle, getStyleClass, getStyleMap, putClientProperty, setStyle, setStyleClass, setStyleMap

Constructor Details

FlatToggleButton

public FlatToggleButton()

Method Details

getButtonType

public FlatButton.ButtonType getButtonType()

Returns type of button.

setButtonType

public void setButtonType(FlatButton.ButtonType buttonType)

Specifies type of button.

isSquareSize

public boolean isSquareSize()

Returns whether the button preferred size will be made square (quadratically).

setSquareSize

public void setSquareSize(boolean squareSize)

Specifies whether the button preferred size will be made square (quadratically).

getMinimumWidth

public int getMinimumWidth()

Returns minimum width of a component.

setMinimumWidth

public void setMinimumWidth(int minimumWidth)

Specifies minimum width of a component.

getMinimumHeight

public int getMinimumHeight()

Returns minimum height of a component.

setMinimumHeight

public void setMinimumHeight(int minimumHeight)

Specifies minimum height of a component.

getOutline

public Object getOutline()

Returns the outline color of the component border.

setOutline

public void setOutline(Object outline)

Specifies the outline color of the component border.

Allowed Values are:

• null
• string "error"
• string "warning"
• any color (type Color)
• an array of two colors (type Color[2]) where the first color is for focused state and the second for unfocused state

getTabUnderlinePlacement

public int getTabUnderlinePlacement()

Returns placement of underline if toggle button type is FlatButton.ButtonType.tab. If underline placement is not specified, returns SwingConstants.BOTTOM as the default value.

Since:

2.3

setTabUnderlinePlacement

public void setTabUnderlinePlacement(int placement)

Specifies placement of underline if toggle button type is FlatButton.ButtonType.tab.

Parameters:

placement - One of the following constants defined in SwingConstants: SwingConstants.TOP, SwingConstants.LEFT, SwingConstants.BOTTOM, or SwingConstants.RIGHT.

Since:

2.3

getTabUnderlineHeight

public int getTabUnderlineHeight()

Returns thickness of underline if toggle button type is FlatButton.ButtonType.tab.

setTabUnderlineHeight

public void setTabUnderlineHeight(int tabUnderlineHeight)

Specifies thickness of underline if toggle button type is FlatButton.ButtonType.tab.

getTabUnderlineColor

public Color getTabUnderlineColor()

Returns color of underline if toggle button type is FlatButton.ButtonType.tab.

setTabUnderlineColor

public void setTabUnderlineColor(Color tabUnderlineColor)

Specifies color of underline if toggle button type is FlatButton.ButtonType.tab.

getTabSelectedBackground

public Color getTabSelectedBackground()

Returns background color if selected and toggle button type is FlatButton.ButtonType.tab.

setTabSelectedBackground

public void setTabSelectedBackground(Color tabSelectedBackground)

Specifies background color if selected and toggle button type is FlatButton.ButtonType.tab.