- java.lang.Object
-
- javax.swing.plaf.ComponentUI
-
- javax.swing.plaf.ButtonUI
-
- javax.swing.plaf.basic.BasicButtonUI
-
- Direct Known Subclasses:
- BasicToggleButtonUI, MetalButtonUI, SynthButtonUI
public class BasicButtonUI extends ButtonUI
BasicButton implementation
-
-
Field Summary
Fields Modifier and Type Field and Description protected int
defaultTextIconGap
protected int
defaultTextShiftOffset
-
Constructor Summary
Constructors Constructor and Description BasicButtonUI()
-
Method Summary
Methods Modifier and Type Method and Description protected void
clearTextShiftOffset()
protected BasicButtonListener
createButtonListener(AbstractButton b)
static ComponentUI
createUI(JComponent c)
int
getBaseline(JComponent c, int width, int height)
Returns the baseline.Component.BaselineResizeBehavior
getBaselineResizeBehavior(JComponent c)
Returns an enum indicating how the baseline of the component changes as the size changes.int
getDefaultTextIconGap(AbstractButton b)
Dimension
getMaximumSize(JComponent c)
Returns the specified component's maximum size appropriate for the look and feel.Dimension
getMinimumSize(JComponent c)
Returns the specified component's minimum size appropriate for the look and feel.Dimension
getPreferredSize(JComponent c)
Returns the specified component's preferred size appropriate for the look and feel.protected String
getPropertyPrefix()
protected int
getTextShiftOffset()
protected void
installDefaults(AbstractButton b)
protected void
installKeyboardActions(AbstractButton b)
protected void
installListeners(AbstractButton b)
void
installUI(JComponent c)
Configures the specified component appropriately for the look and feel.void
paint(Graphics g, JComponent c)
Paints the specified component appropriately for the look and feel.protected void
paintButtonPressed(Graphics g, AbstractButton b)
protected void
paintFocus(Graphics g, AbstractButton b, Rectangle viewRect, Rectangle textRect, Rectangle iconRect)
protected void
paintIcon(Graphics g, JComponent c, Rectangle iconRect)
protected void
paintText(Graphics g, AbstractButton b, Rectangle textRect, String text)
Method which renders the text of the current button.protected void
paintText(Graphics g, JComponent c, Rectangle textRect, String text)
As of Java 2 platform v 1.4 this method should not be used or overriden.protected void
setTextShiftOffset()
protected void
uninstallDefaults(AbstractButton b)
protected void
uninstallKeyboardActions(AbstractButton b)
protected void
uninstallListeners(AbstractButton b)
void
uninstallUI(JComponent c)
Reverses configuration which was done on the specified component duringinstallUI
.-
Methods inherited from class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount, update
-
-
-
-
Field Detail
-
defaultTextIconGap
protected int defaultTextIconGap
-
defaultTextShiftOffset
protected int defaultTextShiftOffset
-
-
Method Detail
-
createUI
public static ComponentUI createUI(JComponent c)
-
getPropertyPrefix
protected String getPropertyPrefix()
-
installUI
public void installUI(JComponent c)
Description copied from class:ComponentUI
Configures the specified component appropriately for the look and feel. This method is invoked when theComponentUI
instance is being installed as the UI delegate on the specified component. This method should completely configure the component for the look and feel, including the following:- Install default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should not be overridden.
- Install a
LayoutManager
on the component if necessary. - Create/add any required sub-components to the component.
- Create/install event listeners on the component.
- Create/install a
PropertyChangeListener
on the component in order to detect and respond to component property changes appropriately. - Install keyboard UI (mnemonics, traversal, etc.) on the component.
- Initialize any appropriate instance data.
- Overrides:
installUI
in classComponentUI
- Parameters:
c
- the component where this UI delegate is being installed- See Also:
ComponentUI.uninstallUI(javax.swing.JComponent)
,JComponent.setUI(javax.swing.plaf.ComponentUI)
,JComponent.updateUI()
-
installDefaults
protected void installDefaults(AbstractButton b)
-
installListeners
protected void installListeners(AbstractButton b)
-
installKeyboardActions
protected void installKeyboardActions(AbstractButton b)
-
uninstallUI
public void uninstallUI(JComponent c)
Description copied from class:ComponentUI
Reverses configuration which was done on the specified component duringinstallUI
. This method is invoked when thisUIComponent
instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed ininstallUI
, being careful to leave theJComponent
instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following:- Remove any UI-set borders from the component.
- Remove any UI-set layout managers on the component.
- Remove any UI-added sub-components from the component.
- Remove any UI-added event/property listeners from the component.
- Remove any UI-installed keyboard UI from the component.
- Nullify any allocated instance data objects to allow for GC.
- Overrides:
uninstallUI
in classComponentUI
- Parameters:
c
- the component from which this UI delegate is being removed; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components- See Also:
ComponentUI.installUI(javax.swing.JComponent)
,JComponent.updateUI()
-
uninstallKeyboardActions
protected void uninstallKeyboardActions(AbstractButton b)
-
uninstallListeners
protected void uninstallListeners(AbstractButton b)
-
uninstallDefaults
protected void uninstallDefaults(AbstractButton b)
-
createButtonListener
protected BasicButtonListener createButtonListener(AbstractButton b)
-
getDefaultTextIconGap
public int getDefaultTextIconGap(AbstractButton b)
-
paint
public void paint(Graphics g, JComponent c)
Description copied from class:ComponentUI
Paints the specified component appropriately for the look and feel. This method is invoked from theComponentUI.update
method when the specified component is being painted. Subclasses should override this method and use the specifiedGraphics
object to render the content of the component.- Overrides:
paint
in classComponentUI
- Parameters:
g
- theGraphics
context in which to paintc
- the component being painted; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components- See Also:
ComponentUI.update(java.awt.Graphics, javax.swing.JComponent)
-
paintIcon
protected void paintIcon(Graphics g, JComponent c, Rectangle iconRect)
-
paintText
protected void paintText(Graphics g, JComponent c, Rectangle textRect, String text)
As of Java 2 platform v 1.4 this method should not be used or overriden. Use the paintText method which takes the AbstractButton argument.
-
paintText
protected void paintText(Graphics g, AbstractButton b, Rectangle textRect, String text)
Method which renders the text of the current button.- Parameters:
g
- Graphics contextb
- Current button to rendertextRect
- Bounding rectangle to render the text.text
- String to render- Since:
- 1.4
-
paintFocus
protected void paintFocus(Graphics g, AbstractButton b, Rectangle viewRect, Rectangle textRect, Rectangle iconRect)
-
paintButtonPressed
protected void paintButtonPressed(Graphics g, AbstractButton b)
-
clearTextShiftOffset
protected void clearTextShiftOffset()
-
setTextShiftOffset
protected void setTextShiftOffset()
-
getTextShiftOffset
protected int getTextShiftOffset()
-
getMinimumSize
public Dimension getMinimumSize(JComponent c)
Description copied from class:ComponentUI
Returns the specified component's minimum size appropriate for the look and feel. Ifnull
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 invokesgetPreferredSize
and returns that value.- Overrides:
getMinimumSize
in classComponentUI
- Parameters:
c
- the component whose minimum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components- Returns:
- a
Dimension
object ornull
- See Also:
JComponent.getMinimumSize()
,LayoutManager.minimumLayoutSize(java.awt.Container)
,ComponentUI.getPreferredSize(javax.swing.JComponent)
-
getPreferredSize
public Dimension getPreferredSize(JComponent c)
Description copied from class:ComponentUI
Returns the specified component's preferred size appropriate for the look and feel. Ifnull
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 returnsnull
.- Overrides:
getPreferredSize
in classComponentUI
- Parameters:
c
- the component whose preferred size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components- See Also:
JComponent.getPreferredSize()
,LayoutManager.preferredLayoutSize(java.awt.Container)
-
getMaximumSize
public Dimension getMaximumSize(JComponent c)
Description copied from class:ComponentUI
Returns the specified component's maximum size appropriate for the look and feel. Ifnull
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 invokesgetPreferredSize
and returns that value.- Overrides:
getMaximumSize
in classComponentUI
- Parameters:
c
- the component whose maximum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components- Returns:
- a
Dimension
object ornull
- See Also:
JComponent.getMaximumSize()
,LayoutManager2.maximumLayoutSize(java.awt.Container)
-
getBaseline
public int getBaseline(JComponent c, int width, int height)
Returns the baseline.- Overrides:
getBaseline
in classComponentUI
- Parameters:
c
-JComponent
baseline is being requested forwidth
- the width to get the baseline forheight
- the height to get the baseline for- Returns:
- baseline or a value < 0 indicating there is no reasonable baseline
- Throws:
NullPointerException
- ifc
isnull
IllegalArgumentException
- if width or height is < 0- Since:
- 1.6
- See Also:
JComponent.getBaseline(int, int)
-
getBaselineResizeBehavior
public Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c)
Returns an enum indicating how the baseline of the component changes as the size changes.- Overrides:
getBaselineResizeBehavior
in classComponentUI
- Parameters:
c
-JComponent
to return baseline resize behavior for- Returns:
- an enum indicating how the baseline changes as the component size changes
- Throws:
NullPointerException
- ifc
isnull
- Since:
- 1.6
- See Also:
JComponent.getBaseline(int, int)
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/plaf/basic/basicbuttonui.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.