OpenJDK 27 · javax.swing.plaf.synth.SynthButtonUI · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private SynthStyle	style

Access	Constructor and Description
public	SynthButtonUI() Constructs a `SynthButtonUI`.

Method Summary

Modifier and Type	Method and Description
public static ComponentUI	Returns: the UI object createUI(JComponent component to create UI object for c) Hides javax.swing.plaf.basic.BasicButtonUI.createUI. Creates a new UI object for the given component.
public int	getBaseline(JComponent c, int width, int height) Overrides javax.swing.plaf.basic.BasicButtonUI.getBaseline. Returns the baseline.
private int	getComponentState(JComponent c) Returns the current state of the passed in `AbstractButton`.
public SynthContext	getContext(JComponent c) Implements javax.swing.plaf.synth.SynthUI.getContext. Returns the Context for the specified component.
pack-priv SynthContext	getContext(JComponent c, int state)
protected Icon	Returns: default icon getDefaultIcon(AbstractButton button the icon is associated with b) Returns the default icon.
private Icon	getEnabledIcon(AbstractButton b, Icon defaultIcon)
protected Icon	Returns: an icon getIcon(AbstractButton button the icon is associated with b) Returns the Icon to use for painting the button.
private Icon	getIcon(AbstractButton button b, Icon icon returned from the button for the specific state specificIcon, Icon fallback icon defaultIcon, int the synth state of the button state) This method will return the icon that should be used for a button.
public Dimension	getMaximumSize(JComponent c) Overrides javax.swing.plaf.basic.BasicButtonUI.getMaximumSize. Returns the specified component's maximum size appropriate for the look and feel.
public Dimension	getMinimumSize(JComponent c) Overrides javax.swing.plaf.basic.BasicButtonUI.getMinimumSize. Returns the specified component's minimum size appropriate for the look and feel.
public Dimension	getPreferredSize(JComponent c) Overrides javax.swing.plaf.basic.BasicButtonUI.getPreferredSize. Returns the specified component's preferred size appropriate for the look and feel.
private Icon	getPressedIcon(AbstractButton b, Icon defaultIcon)
private Icon	getRolloverIcon(AbstractButton b, Icon defaultIcon)
private Icon	getSelectedIcon(AbstractButton b, Icon defaultIcon)
protected Icon	Returns: the Icon used in calculating the preferred/minimum/maximum size. getSizingIcon(AbstractButton specifies the `AbstractButton` used when calculating the preferred/minimum/maximum size. b) Returns the Icon used in calculating the preferred/minimum/maximum size.
private Icon	getSpecificIcon(AbstractButton b, Icon specificSelectedIcon, Icon specificIcon, Icon defaultIcon, int state)
private Icon	getSynthDisabledIcon(AbstractButton b, Icon defaultIcon)
private Icon	getSynthIcon(AbstractButton b, int synthConstant)
private int	getTextShiftOffset(SynthContext state) Returns the amount to shift the text/icon when painting.
protected void	installDefaults(AbstractButton b) Overrides javax.swing.plaf.basic.BasicButtonUI.installDefaults. Installs default properties.
protected void	installListeners(AbstractButton b) Overrides javax.swing.plaf.basic.BasicButtonUI.installListeners. Registers listeners.
public void	paint(Graphics the `Graphics` object used for painting g, JComponent the component being painted c) Overrides javax.swing.plaf.basic.BasicButtonUI.paint. Paints the specified component according to the Look and Feel.
protected void	paint(SynthContext context for the component being painted context, Graphics the `Graphics` object used for painting g) Paints the specified component.
pack-priv void	paintBackground(SynthContext context, Graphics g, JComponent c)
public void	paintBorder(SynthContext context, Graphics g, int x, int y, int w, int h) Implements javax.swing.plaf.synth.SynthUI.paintBorder. Paints the border.
public void	propertyChange(PropertyChangeEvent e) Implements java.beans.PropertyChangeListener.propertyChange. This method gets called when a bound property is changed.
protected void	uninstallDefaults(AbstractButton b) Overrides javax.swing.plaf.basic.BasicButtonUI.uninstallDefaults. Uninstalls default properties.
protected void	uninstallListeners(AbstractButton b) Overrides javax.swing.plaf.basic.BasicButtonUI.uninstallListeners. Unregisters listeners.
public void	update(Graphics the `Graphics` object used for painting g, JComponent the component being painted c) Overrides javax.swing.plaf.ComponentUI.update. Notifies this UI delegate to repaint the specified component.
pack-priv void	updateStyle(AbstractButton b)

Inherited from javax.swing.plaf.basic.BasicButtonUI:: clearTextShiftOffset createButtonListener getBaselineResizeBehavior getDefaultTextIconGap getPropertyPrefix getTextShiftOffset installKeyboardActions installUI paintButtonPressed paintFocus paintIcon paintText paintText setTextShiftOffset uninstallKeyboardActions uninstallUI

style	back to summary
private SynthStyle style

SynthButtonUI	back to summary
public SynthButtonUI() Constructs a `SynthButtonUI`.

Method Detail

createUI	back to summary
public static ComponentUI createUI(JComponent c) Hides javax.swing.plaf.basic.BasicButtonUI.createUI. Creates a new UI object for the given component. Parameters c:JComponent component to create UI object for Returns:ComponentUI the UI object

createUI

back to summary

public static ComponentUI createUI(JComponent c)

Hides javax.swing.plaf.basic.BasicButtonUI.createUI.

Creates a new UI object for the given component.

Parameters

c:JComponent: component to create UI object for

Returns:ComponentUI

the UI object

getBaseline	back to summary
public int getBaseline(JComponent c, int width, int height) Overrides javax.swing.plaf.basic.BasicButtonUI.getBaseline. Doc from javax.swing.plaf.basic.BasicButtonUI.getBaseline. Returns the baseline. Annotations @Override

getBaseline

back to summary

public int getBaseline(JComponent c, int width, int height)

Overrides javax.swing.plaf.basic.BasicButtonUI.getBaseline.

Doc from javax.swing.plaf.basic.BasicButtonUI.getBaseline.

Returns the baseline.

Annotations

@Override

getComponentState	back to summary
private int getComponentState(JComponent c) Returns the current state of the passed in `AbstractButton`.

getContext	back to summary
public SynthContext getContext(JComponent c) Implements javax.swing.plaf.synth.SynthUI.getContext. Doc from javax.swing.plaf.synth.SynthUI.getContext. Returns the Context for the specified component. Annotations @Override

getContext

back to summary

public SynthContext getContext(JComponent c)

Implements javax.swing.plaf.synth.SynthUI.getContext.

Doc from javax.swing.plaf.synth.SynthUI.getContext.

Returns the Context for the specified component.

Annotations

@Override

getContext	back to summary
pack-priv SynthContext getContext(JComponent c, int state)

getDefaultIcon	back to summary
protected Icon getDefaultIcon(AbstractButton b) Returns the default icon. This should not callback to the JComponent. Parameters b:AbstractButton button the icon is associated with Returns:Icon default icon

getDefaultIcon

back to summary

protected Icon getDefaultIcon(AbstractButton b)

Returns the default icon. This should not callback to the JComponent.

Parameters

b:AbstractButton: button the icon is associated with

Returns:Icon

default icon

getEnabledIcon	back to summary
private Icon getEnabledIcon(AbstractButton b, Icon defaultIcon)

getIcon	back to summary
protected Icon getIcon(AbstractButton b) Returns the Icon to use for painting the button. The icon is chosen with respect to the current state of the button. Parameters b:AbstractButton button the icon is associated with Returns:Icon an icon

getIcon

back to summary

protected Icon getIcon(AbstractButton b)

Returns the Icon to use for painting the button. The icon is chosen with respect to the current state of the button.

Parameters

b:AbstractButton: button the icon is associated with

Returns:Icon

an icon

getIcon back to summary

getIcon	back to summary
private Icon getIcon(AbstractButton b, Icon specificIcon, Icon defaultIcon, int state) This method will return the icon that should be used for a button. We only want to use the synth icon defined by the style if the specific icon has not been defined for the button state and the backup icon is a UIResource (we set it, not the developer) or `null`. Parameters b:AbstractButton button specificIcon:Icon icon returned from the button for the specific state defaultIcon:Icon fallback icon state:int the synth state of the button

private Icon getIcon(AbstractButton b, Icon specificIcon, Icon defaultIcon, int state)

This method will return the icon that should be used for a button. We only want to use the synth icon defined by the style if the specific icon has not been defined for the button state and the backup icon is a UIResource (we set it, not the developer) or null.

Parameters

b:AbstractButton: button
specificIcon:Icon: icon returned from the button for the specific state
defaultIcon:Icon: fallback icon
state:int: the synth state of the button

getMaximumSize back to summary

getMaximumSize	back to summary
public Dimension getMaximumSize(JComponent c) Overrides javax.swing.plaf.basic.BasicButtonUI.getMaximumSize. Doc from javax.swing.plaf.ComponentUI.getMaximumSize. Returns the specified component's maximum size appropriate for the look and feel. If `null` is returned, the maximum size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method invokes `getPreferredSize` and returns that value. Annotations @Override

public Dimension getMaximumSize(JComponent c)

Overrides javax.swing.plaf.basic.BasicButtonUI.getMaximumSize.

Doc from javax.swing.plaf.ComponentUI.getMaximumSize.

Returns the specified component's maximum size appropriate for the look and feel. If null is returned, the maximum size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method invokes getPreferredSize and returns that value.

Annotations

@Override

getMinimumSize back to summary

getMinimumSize	back to summary
public Dimension getMinimumSize(JComponent c) Overrides javax.swing.plaf.basic.BasicButtonUI.getMinimumSize. Doc from javax.swing.plaf.ComponentUI.getMinimumSize. Returns the specified component's minimum size appropriate for the look and feel. If `null` is returned, the minimum size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method invokes `getPreferredSize` and returns that value. Annotations @Override

public Dimension getMinimumSize(JComponent c)

Overrides javax.swing.plaf.basic.BasicButtonUI.getMinimumSize.

Doc from javax.swing.plaf.ComponentUI.getMinimumSize.

Returns the specified component's minimum size appropriate for the look and feel. If null is returned, the minimum size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method invokes getPreferredSize and returns that value.

Annotations

@Override

getPreferredSize back to summary

getPreferredSize	back to summary
public Dimension getPreferredSize(JComponent c) Overrides javax.swing.plaf.basic.BasicButtonUI.getPreferredSize. Doc from javax.swing.plaf.ComponentUI.getPreferredSize. Returns the specified component's preferred size appropriate for the look and feel. If `null` is returned, the preferred size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method returns `null`. Annotations @Override

public Dimension getPreferredSize(JComponent c)

Overrides javax.swing.plaf.basic.BasicButtonUI.getPreferredSize.

Doc from javax.swing.plaf.ComponentUI.getPreferredSize.

Returns the specified component's preferred size appropriate for the look and feel. If null is returned, the preferred size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method returns null.

Annotations

@Override

getPressedIcon	back to summary
private Icon getPressedIcon(AbstractButton b, Icon defaultIcon)

getRolloverIcon	back to summary
private Icon getRolloverIcon(AbstractButton b, Icon defaultIcon)

getSelectedIcon	back to summary
private Icon getSelectedIcon(AbstractButton b, Icon defaultIcon)

getSizingIcon back to summary

getSizingIcon	back to summary
protected Icon getSizingIcon(AbstractButton b) Returns the Icon used in calculating the preferred/minimum/maximum size. Parameters b:AbstractButton specifies the `AbstractButton` used when calculating the preferred/minimum/maximum size. Returns:Icon the Icon used in calculating the preferred/minimum/maximum size.

protected Icon getSizingIcon(AbstractButton b)

Returns the Icon used in calculating the preferred/minimum/maximum size.

Parameters

b:AbstractButton: specifies the AbstractButton used when calculating the preferred/minimum/maximum size.

Returns:Icon

the Icon used in calculating the preferred/minimum/maximum size.

getSpecificIcon	back to summary
private Icon getSpecificIcon(AbstractButton b, Icon specificSelectedIcon, Icon specificIcon, Icon defaultIcon, int state)

getSynthDisabledIcon	back to summary
private Icon getSynthDisabledIcon(AbstractButton b, Icon defaultIcon)

getSynthIcon	back to summary
private Icon getSynthIcon(AbstractButton b, int synthConstant)

getTextShiftOffset	back to summary
private int getTextShiftOffset(SynthContext state) Returns the amount to shift the text/icon when painting.

installDefaults	back to summary
protected void installDefaults(AbstractButton b) Overrides javax.swing.plaf.basic.BasicButtonUI.installDefaults. Doc from javax.swing.plaf.basic.BasicButtonUI.installDefaults. Installs default properties. Annotations @Override

installDefaults

back to summary

protected void installDefaults(AbstractButton b)

Overrides javax.swing.plaf.basic.BasicButtonUI.installDefaults.

Doc from javax.swing.plaf.basic.BasicButtonUI.installDefaults.

Installs default properties.

Annotations

@Override

installListeners	back to summary
protected void installListeners(AbstractButton b) Overrides javax.swing.plaf.basic.BasicButtonUI.installListeners. Doc from javax.swing.plaf.basic.BasicButtonUI.installListeners. Registers listeners. Annotations @Override

installListeners

back to summary

protected void installListeners(AbstractButton b)

Overrides javax.swing.plaf.basic.BasicButtonUI.installListeners.

Doc from javax.swing.plaf.basic.BasicButtonUI.installListeners.

Registers listeners.

Annotations

@Override

paint back to summary

paint	back to summary
public void paint(Graphics g, JComponent c) Overrides javax.swing.plaf.basic.BasicButtonUI.paint. Paints the specified component according to the Look and Feel. This method is not used by Synth Look and Feel. Painting is handled by the `paint(SynthContext, Graphics)` method. Parameters g:Graphics the `Graphics` object used for painting c:JComponent the component being painted Annotations @Override See Also `paint(SynthContext, Graphics)`

public void paint(Graphics g, JComponent c)

Overrides javax.swing.plaf.basic.BasicButtonUI.paint.

Paints the specified component according to the Look and Feel.

This method is not used by Synth Look and Feel. Painting is handled by the paint(SynthContext, Graphics) method.

Parameters

g:Graphics: the Graphics object used for painting
c:JComponent: the component being painted

Annotations

@Override

See Also

paint(SynthContext, Graphics)

paint back to summary

paint	back to summary
protected void paint(SynthContext context, Graphics g) Paints the specified component. Parameters context:SynthContext context for the component being painted g:Graphics the `Graphics` object used for painting See Also `update(Graphics, JComponent)`

protected void paint(SynthContext context, Graphics g)

Paints the specified component.

Parameters

context:SynthContext: context for the component being painted
g:Graphics: the Graphics object used for painting

See Also

update(Graphics, JComponent)

paintBackground	back to summary
pack-priv void paintBackground(SynthContext context, Graphics g, JComponent c)

paintBorder	back to summary
public void paintBorder(SynthContext context, Graphics g, int x, int y, int w, int h) Implements javax.swing.plaf.synth.SynthUI.paintBorder. Doc from javax.swing.plaf.synth.SynthUI.paintBorder. Paints the border. Annotations @Override

paintBorder

back to summary

public void paintBorder(SynthContext context, Graphics g, int x, int y, int w, int h)

Implements javax.swing.plaf.synth.SynthUI.paintBorder.

Doc from javax.swing.plaf.synth.SynthUI.paintBorder.

Paints the border.

Annotations

@Override

propertyChange	back to summary
public void propertyChange(PropertyChangeEvent e) Implements java.beans.PropertyChangeListener.propertyChange. Doc from java.beans.PropertyChangeListener.propertyChange. This method gets called when a bound property is changed. Annotations @Override

propertyChange

back to summary

public void propertyChange(PropertyChangeEvent e)

Implements java.beans.PropertyChangeListener.propertyChange.

Doc from java.beans.PropertyChangeListener.propertyChange.

This method gets called when a bound property is changed.

Annotations

@Override

uninstallDefaults	back to summary
protected void uninstallDefaults(AbstractButton b) Overrides javax.swing.plaf.basic.BasicButtonUI.uninstallDefaults. Doc from javax.swing.plaf.basic.BasicButtonUI.uninstallDefaults. Uninstalls default properties. Annotations @Override

uninstallDefaults

back to summary

protected void uninstallDefaults(AbstractButton b)

Overrides javax.swing.plaf.basic.BasicButtonUI.uninstallDefaults.

Doc from javax.swing.plaf.basic.BasicButtonUI.uninstallDefaults.

Uninstalls default properties.

Annotations

@Override

uninstallListeners	back to summary
protected void uninstallListeners(AbstractButton b) Overrides javax.swing.plaf.basic.BasicButtonUI.uninstallListeners. Doc from javax.swing.plaf.basic.BasicButtonUI.uninstallListeners. Unregisters listeners. Annotations @Override

uninstallListeners

back to summary

protected void uninstallListeners(AbstractButton b)

Overrides javax.swing.plaf.basic.BasicButtonUI.uninstallListeners.

Doc from javax.swing.plaf.basic.BasicButtonUI.uninstallListeners.

Unregisters listeners.

Annotations

@Override

update back to summary

update	back to summary
public void update(Graphics g, JComponent c) Overrides javax.swing.plaf.ComponentUI.update. Notifies this UI delegate to repaint the specified component. This method paints the component background, then calls the `paint(SynthContext, Graphics)` method. In general, this method does not need to be overridden by subclasses. All Look and Feel rendering code should reside in the `paint` method. Parameters g:Graphics the `Graphics` object used for painting c:JComponent the component being painted Annotations @Override See Also `paint(SynthContext, Graphics)`

public void update(Graphics g, JComponent c)

Overrides javax.swing.plaf.ComponentUI.update.

Notifies this UI delegate to repaint the specified component. This method paints the component background, then calls the paint(SynthContext, Graphics) method.

In general, this method does not need to be overridden by subclasses. All Look and Feel rendering code should reside in the paint method.

Parameters

g:Graphics: the Graphics object used for painting
c:JComponent: the component being painted

Annotations

@Override

See Also

paint(SynthContext, Graphics)

updateStyle	back to summary
pack-priv void updateStyle(AbstractButton b)

public Class SynthButtonUI

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail