javax.swing.plaf.basic
Class BasicButtonUI

java.lang.Object
  javax.swing.plaf.ComponentUI
      javax.swing.plaf.ButtonUI
          javax.swing.plaf.basic.BasicButtonUI

Direct Known Subclasses:

BasicToggleButtonUI, MetalButtonUI

public class BasicButtonUI

extends ButtonUI

BasicButton implementation

Author:

Jeff Dinkins

Field Summary

private static BasicButtonUI	buttonUI
private Color	defaultBackground
private Border	defaultBorder
private Font	defaultFont
private Color	defaultForeground
private boolean	defaults_initialized
protected int	defaultTextIconGap
protected int	defaultTextShiftOffset
private static Rectangle	iconRect
private static String	propertyPrefix
private int	shiftOffset
private static Rectangle	textRect
private static Rectangle	viewRect

Constructor Summary

BasicButtonUI()

Method Summary

protected void	clearTextShiftOffset()
protected BasicButtonListener	createButtonListener(AbstractButton b)
static ComponentUI	createUI(JComponent c) Returns an instance of the UI delegate for the specified component.
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 appropriate for the look and feel.
void	paint(Graphics g, JComponent c) Paints the specified component appropriate 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 during installUI.

Methods inherited from class javax.swing.plaf.ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, update

Methods inherited from class java.lang.Object

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

Field Detail

buttonUI

private static final BasicButtonUI buttonUI

defaultTextIconGap

protected int defaultTextIconGap

shiftOffset

private int shiftOffset

defaultTextShiftOffset

protected int defaultTextShiftOffset

defaults_initialized

private boolean defaults_initialized

propertyPrefix

private static final String propertyPrefix

See Also:

Constant Field Values

defaultForeground

private Color defaultForeground

defaultBackground

private Color defaultBackground

defaultFont

private Font defaultFont

defaultBorder

private Border defaultBorder

viewRect

private static Rectangle viewRect

textRect

private static Rectangle textRect

iconRect

private static Rectangle iconRect

Constructor Detail

BasicButtonUI

public BasicButtonUI()

Method Detail

createUI

public static ComponentUI createUI(JComponent c)

Description copied from class: ComponentUI

Returns an instance of the UI delegate for the specified component. Each subclass must provide its own static createUI method that returns an instance of that UI delegate subclass. If the UI delegate subclass is stateless, it may return an instance that is shared by multiple components. If the UI delegate is stateful, then it should return a new instance per component. The default implementation of this method throws an error, as it should never be invoked.

getPropertyPrefix

protected String getPropertyPrefix()

installUI

public void installUI(JComponent c)

Description copied from class: ComponentUI

Configures the specified component appropriate for the look and feel. This method is invoked when the ComponentUI 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:

1. Install any 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.
2. Install a LayoutManager on the component if necessary.
3. Create/add any required sub-components to the component.
4. Create/install event listeners on the component.
5. Create/install a PropertyChangeListener on the component in order to detect and respond to component property changes appropriately.
6. Install keyboard UI (mnemonics, traversal, etc.) on the component.
7. Initialize any appropriate instance data.

Overrides:

installUI in class ComponentUI

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 during installUI. This method is invoked when this UIComponent instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed in installUI, being careful to leave the JComponent instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following:

1. Remove any UI-set borders from the component.
2. Remove any UI-set layout managers on the component.
3. Remove any UI-added sub-components from the component.
4. Remove any UI-added event/property listeners from the component.
5. Remove any UI-installed keyboard UI from the component.
6. Nullify any allocated instance data objects to allow for GC.

Overrides:

uninstallUI in class ComponentUI

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 appropriate for the look and feel. This method is invoked from the ComponentUI.update method when the specified component is being painted. Subclasses should override this method and use the specified Graphics object to render the content of the component.

Overrides:

paint in class ComponentUI

Parameters:

g - the Graphics context in which to paint

c - 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 context

b - Current button to render

textRect - 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. 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.

Overrides:

getMinimumSize in class ComponentUI

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 or null

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. 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.

Overrides:

getPreferredSize in class ComponentUI

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. 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.

Overrides:

getMaximumSize in class ComponentUI

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 or null

See Also:

JComponent.getMaximumSize(), LayoutManager2.maximumLayoutSize(java.awt.Container)