Class BasicTableHeaderUI
- java.lang.Object
-
- javax.swing.plaf.ComponentUI
-
- javax.swing.plaf.TableHeaderUI
-
- javax.swing.plaf.basic.BasicTableHeaderUI
- Direct Known Subclasses:
- SynthTableHeaderUI
public class BasicTableHeaderUI extends TableHeaderUI
BasicTableHeaderUI implementation
Nested Classes
Modifier and Type | Class and Description |
---|---|
class |
BasicTableHeaderUI.MouseInputHandler This class should be treated as a "protected" inner class. |
Fields
Modifier and Type | Field and Description |
---|---|
protected JTableHeader |
header The JTableHeader that is delegating the painting to this UI. |
protected MouseInputListener |
mouseInputListener |
protected CellRendererPane |
rendererPane |
Constructors
Constructor and Description |
---|
BasicTableHeaderUI() |
Methods
Modifier and Type | Method and Description |
---|---|
protected MouseInputListener |
createMouseInputListener() Creates the mouse listener for the JTableHeader. |
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. |
protected int |
getRolloverColumn() Returns the index of the column header over which the mouse currently is. |
protected void |
installDefaults() Initializes JTableHeader properties such as font, foreground, and background. |
protected void |
installKeyboardActions() Register all keyboard actions on the JTableHeader. |
protected void |
installListeners() Attaches listeners to the JTableHeader. |
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 |
rolloverColumnUpdated(int oldColumn,
int newColumn) This method gets called every time when a rollover column in the table header is updated. |
protected void |
uninstallDefaults() |
protected void |
uninstallKeyboardActions() Unregisters default key actions. |
protected void |
uninstallListeners() |
void |
uninstallUI(JComponent c) Reverses configuration which was done on the specified component during |
Methods inherited from class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount, getBaselineResizeBehavior, update
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Fields
header
protected JTableHeader header
The JTableHeader that is delegating the painting to this UI.
rendererPane
protected CellRendererPane rendererPane
mouseInputListener
protected MouseInputListener mouseInputListener
Constructors
BasicTableHeaderUI
public BasicTableHeaderUI()
Methods
createMouseInputListener
protected MouseInputListener createMouseInputListener()
Creates the mouse listener for the JTableHeader.
createUI
public static ComponentUI createUI(JComponent h)
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 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 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()
Initializes JTableHeader properties such as 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:
installUI(javax.swing.JComponent)
installListeners
protected void installListeners()
Attaches listeners to the JTableHeader.
installKeyboardActions
protected void installKeyboardActions()
Register all keyboard actions on the JTableHeader.
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:
- 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()
uninstallDefaults
protected void uninstallDefaults()
uninstallListeners
protected void uninstallListeners()
uninstallKeyboardActions
protected void uninstallKeyboardActions()
Unregisters default key actions.
getRolloverColumn
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
- Since:
- 1.6
- See Also:
rolloverColumnUpdated(int, int)
rolloverColumnUpdated
protected void rolloverColumnUpdated(int oldColumn, int newColumn)
This method gets called every time when a rollover column in the table header is updated. Every look and feel that supports a rollover effect in a 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 - Since:
- 1.6
- See Also:
-
getRolloverColumn()
,JTableHeader.getHeaderRect(int)
getBaseline
public int getBaseline(JComponent c, int width, int height)
Returns the baseline.
- Overrides:
-
getBaseline
in classComponentUI
- 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
- ifc
isnull
-
IllegalArgumentException
- if width or height is < 0 - Since:
- 1.6
- See Also:
JComponent.getBaseline(int, int)
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 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 classComponentUI
- Parameters:
-
g
- theGraphics
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)
getMinimumSize
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).
- 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)
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).
- 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)
Return the maximum size of the header. The maximum width is the sum of the maximum widths of each column (plus inter-cell spacing).
- 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)
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/basic/BasicTableHeaderUI.html