public class

BasicTableHeaderUI

extends TableHeaderUI
java.lang.Object
   ↳ javax.swing.plaf.ComponentUI
     ↳ javax.swing.plaf.TableHeaderUI
       ↳ javax.swing.plaf.basic.BasicTableHeaderUI
Known Direct Subclasses

Class Overview

BasicTableHeaderUI implementation

Summary

Nested Classes
class BasicTableHeaderUI.MouseInputHandler This inner class is marked "public" due to a compiler bug. 
Fields
protected JTableHeader header The JTableHeader that is delegating the painting to this UI.
protected MouseInputListener mouseInputListener
protected CellRendererPane rendererPane
Public Constructors
BasicTableHeaderUI()
Public Methods
static ComponentUI createUI(JComponent h)
int getBaseline(JComponent c, int width, int height)
Returns the baseline.
Dimension getMaximumSize(JComponent c)
Return the maximum size of the header.
Dimension getMinimumSize(JComponent c)
Return the minimum size of the header.
Dimension getPreferredSize(JComponent c)
Return the preferred size of the header.
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.
void uninstallUI(JComponent c)
Reverses configuration which was done on the specified component during installUI.
Protected Methods
MouseInputListener createMouseInputListener()
Creates the mouse listener for the JTableHeader.
int getRolloverColumn()
Returns the index of the column header over which the mouse currently is.
void installDefaults()
Initialize JTableHeader properties, e.g.
void installKeyboardActions()
Register all keyboard actions on the JTableHeader.
void installListeners()
Attaches listeners to the JTableHeader.
void rolloverColumnUpdated(int oldColumn, int newColumn)
This method gets called every time the rollover column in the table header is updated.
void uninstallDefaults()
void uninstallKeyboardActions()
Unregisters default key actions.
void uninstallListeners()
[Expand]
Inherited Methods
From class javax.swing.plaf.ComponentUI
From class java.lang.Object

Fields

protected JTableHeader header

The JTableHeader that is delegating the painting to this UI.

protected MouseInputListener mouseInputListener

protected CellRendererPane rendererPane

Public Constructors

public BasicTableHeaderUI ()

Public Methods

public static ComponentUI createUI (JComponent h)

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

Returns the baseline.

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
IllegalArgumentException
See Also

public Dimension getMaximumSize (JComponent c)

Return the maximum size of the header. The maximum width is the sum of the maximum widths of each column (plus inter-cell spacing).

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

public Dimension getMinimumSize (JComponent c)

Return the minimum size of the header. The minimum width is the sum of the minimum widths of each column (plus inter-cell spacing).

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

public Dimension getPreferredSize (JComponent c)

Return the preferred size of the header. The preferred height is the maximum of the preferred heights of all of the components provided by the header renderers. The preferred width is the sum of the preferred widths of each column (plus inter-cell spacing).

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

public void installUI (JComponent c)

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.

Parameters
c the component where this UI delegate is being installed

public void paint (Graphics g, JComponent c)

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.

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

public void uninstallUI (JComponent c)

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.

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

Protected Methods

protected MouseInputListener createMouseInputListener ()

Creates the mouse listener for the JTableHeader.

protected int getRolloverColumn ()

Returns the index of the column header over which the mouse currently is. When the mouse is not over the table header, -1 is returned.

Returns
  • the index of the current rollover column
See Also

protected void installDefaults ()

Initialize JTableHeader properties, e.g. font, foreground, and background. The font, foreground, and background properties are only set if their current value is either null or a UIResource, other properties are set if the current value is null.

See Also

protected void installKeyboardActions ()

Register all keyboard actions on the JTableHeader.

protected void installListeners ()

Attaches listeners to the JTableHeader.

protected void rolloverColumnUpdated (int oldColumn, int newColumn)

This method gets called every time the rollover column in the table header is updated. Every look and feel supporting rollover effect in table header should override this method and repaint the header.

Parameters
oldColumn the index of the previous rollover column or -1 if the mouse was not over a column
newColumn the index of the new rollover column or -1 if the mouse is not over a column
See Also

protected void uninstallDefaults ()

protected void uninstallKeyboardActions ()

Unregisters default key actions.

protected void uninstallListeners ()