Module java.desktop

Class BasicTableHeaderUI

    • Field Detail

      • header

        protected JTableHeader header
        The JTableHeader that is delegating the painting to this UI.
      • rendererPane

        protected CellRendererPane rendererPane
        The instance of CellRendererPane.
      • mouseInputListener

        protected MouseInputListener mouseInputListener
        Listeners that are attached to the JTable
    • Constructor Detail

      • BasicTableHeaderUI

        public BasicTableHeaderUI​()
    • Method Detail

      • createMouseInputListener

        protected MouseInputListener createMouseInputListener​()
        Creates the mouse listener for the JTableHeader.
        Returns:
        the mouse listener for the JTableHeader
      • createUI

        public static ComponentUI createUI​(JComponent h)
        Returns a new instance of BasicTableHeaderUI.
        Parameters:
        h - a component.
        Returns:
        a new instance of BasicTableHeaderUI
      • 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:
        1. 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.
        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​()
        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:
        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()
      • uninstallDefaults

        protected void uninstallDefaults​()
        Uninstalls default properties
      • uninstallListeners

        protected void uninstallListeners​()
        Unregisters listeners.
      • 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)
      • 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 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)
      • 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 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
        Returns:
        a Dimension object containing given component's preferred size appropriate for the look and feel
        See Also:
        JComponent.getPreferredSize(), LayoutManager.preferredLayoutSize(java.awt.Container)