BasicButtonUI (Java Platform SE 6) (original) (raw)
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
Field Summary | |
---|---|
protected int | defaultTextIconGap |
protected int | defaultTextShiftOffset |
Constructor Summary |
---|
BasicButtonUI() |
Method Summary | |
---|---|
protected void | clearTextShiftOffset() |
protected BasicButtonListener | createButtonListener(AbstractButton b) |
static ComponentUI | createUI(JComponent c) |
int | [getBaseline](../../../../javax/swing/plaf/basic/BasicButtonUI.html#getBaseline%28javax.swing.JComponent, int, int%29)(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 appropriate for the look and feel. |
void | [paint](../../../../javax/swing/plaf/basic/BasicButtonUI.html#paint%28java.awt.Graphics, javax.swing.JComponent%29)(Graphics g,JComponent c) Paints the specified component appropriate for the look and feel. |
protected void | [paintButtonPressed](../../../../javax/swing/plaf/basic/BasicButtonUI.html#paintButtonPressed%28java.awt.Graphics, javax.swing.AbstractButton%29)(Graphics g,AbstractButton b) |
protected void | [paintFocus](../../../../javax/swing/plaf/basic/BasicButtonUI.html#paintFocus%28java.awt.Graphics, javax.swing.AbstractButton, java.awt.Rectangle, java.awt.Rectangle, java.awt.Rectangle%29)(Graphics g,AbstractButton b,Rectangle viewRect,Rectangle textRect,Rectangle iconRect) |
protected void | [paintIcon](../../../../javax/swing/plaf/basic/BasicButtonUI.html#paintIcon%28java.awt.Graphics, javax.swing.JComponent, java.awt.Rectangle%29)(Graphics g,JComponent c,Rectangle iconRect) |
protected void | [paintText](../../../../javax/swing/plaf/basic/BasicButtonUI.html#paintText%28java.awt.Graphics, javax.swing.AbstractButton, java.awt.Rectangle, java.lang.String%29)(Graphics g,AbstractButton b,Rectangle textRect,String text) Method which renders the text of the current button. |
protected void | [paintText](../../../../javax/swing/plaf/basic/BasicButtonUI.html#paintText%28java.awt.Graphics, javax.swing.JComponent, java.awt.Rectangle, java.lang.String%29)(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](../../../../javax/swing/plaf/ComponentUI.html#contains%28javax.swing.JComponent, int, int%29), [getAccessibleChild](../../../../javax/swing/plaf/ComponentUI.html#getAccessibleChild%28javax.swing.JComponent, int%29), getAccessibleChildrenCount, [update](../../../../javax/swing/plaf/ComponentUI.html#update%28java.awt.Graphics, javax.swing.JComponent%29) |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../../java/lang/Object.html#wait%28long, int%29) |
Field Detail |
---|
defaultTextIconGap
protected int defaultTextIconGap
defaultTextShiftOffset
protected int defaultTextShiftOffset
Constructor Detail |
---|
BasicButtonUI
public BasicButtonUI()
Method Detail |
---|
createUI
public static ComponentUI createUI(JComponent c)
getPropertyPrefix
protected String getPropertyPrefix()
installUI
public void installUI(JComponent c)
Description copied from class: [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html#installUI%28javax.swing.JComponent%29)
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:
- 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.
- 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](../../../../javax/swing/plaf/ComponentUI.html#installUI%28javax.swing.JComponent%29)
in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
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](../../../../javax/swing/plaf/ComponentUI.html#uninstallUI%28javax.swing.JComponent%29)
Reverses configuration which was done on the specified component duringinstallUI
. 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:
- 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](../../../../javax/swing/plaf/ComponentUI.html#uninstallUI%28javax.swing.JComponent%29)
in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
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](../../../../javax/swing/plaf/ComponentUI.html#paint%28java.awt.Graphics, javax.swing.JComponent%29)
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](../../../../javax/swing/plaf/ComponentUI.html#paint%28java.awt.Graphics, javax.swing.JComponent%29)
in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
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)](../../../../javax/swing/plaf/ComponentUI.html#update%28java.awt.Graphics, javax.swing.JComponent%29)
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](../../../../javax/swing/plaf/ComponentUI.html#getMinimumSize%28javax.swing.JComponent%29)
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](../../../../javax/swing/plaf/ComponentUI.html#getMinimumSize%28javax.swing.JComponent%29)
in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
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](../../../../javax/swing/plaf/ComponentUI.html#getPreferredSize%28javax.swing.JComponent%29)
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](../../../../javax/swing/plaf/ComponentUI.html#getPreferredSize%28javax.swing.JComponent%29)
in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
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](../../../../javax/swing/plaf/ComponentUI.html#getMaximumSize%28javax.swing.JComponent%29)
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](../../../../javax/swing/plaf/ComponentUI.html#getMaximumSize%28javax.swing.JComponent%29)
in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
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)
getBaseline
public int getBaseline(JComponent c, int width, int height)
Returns the baseline.
Overrides:
[getBaseline](../../../../javax/swing/plaf/ComponentUI.html#getBaseline%28javax.swing.JComponent, int, int%29)
in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
Parameters:
c
- JComponent
baseline is being requested for
width
- the width to get the baseline for
height
- the height to get the baseline for
Returns:
baseline or a value < 0 indicating there is no reasonable baseline
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if c
is null
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")
- if width or height is < 0
Since:
1.6
See Also:
[JComponent.getBaseline(int, int)](../../../../javax/swing/JComponent.html#getBaseline%28int, int%29)
getBaselineResizeBehavior
public Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c)
Returns an enum indicating how the baseline of the component changes as the size changes.
Overrides:
[getBaselineResizeBehavior](../../../../javax/swing/plaf/ComponentUI.html#getBaselineResizeBehavior%28javax.swing.JComponent%29)
in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
Parameters:
c
- JComponent
to return baseline resize behavior for
Returns:
an enum indicating how the baseline changes as the component size changes
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if c
is null
Since:
1.6
See Also:
[JComponent.getBaseline(int, int)](../../../../javax/swing/JComponent.html#getBaseline%28int, int%29)
Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.