Custom renderers support.

Author: Qualtagh

README.md

@@ -24,8 +24,10 @@ New features:
 - Generic support for L&Fs (it means they're not reimplemented, they're used as delegates for rendering)
 - Easy to use table model API
 - Table header cells highlighting on mouse over
+- Table header cells etching on mouse dragging
 - Table cells spans API to merge cells inside a table itself (not in a header)
 - Drawing of dragged columns group in a table itself (not only in a header)
+- Custom header cell renderer support
 - Partial test coverage
 - Setting custom rowspan. Rowspan is calculated automatically in a greedy way, but sometimes such a picture is needed (and it can't be calculated automatically):
 

src/org/quinto/swing/table/view/CustomTableHeaderRenderer.java

@@ -0,0 +1,25 @@
+package org.quinto.swing.table.view;
+
+import java.awt.Component;
+import javax.swing.JTable;
+import org.quinto.swing.table.model.IModelFieldGroup;
+
+public interface CustomTableHeaderRenderer {
+  /**
+   * Warning: originalComponent may be shared within a level by different cells.
+   * If rendering of one cell changes originalComponent's properties
+   * then rendering of other cells should restore original properties (or set them to appropriate values).
+   * @param originalComponent
+   * @param table
+   * @param value
+   * @param isSelected
+   * @param hasFocus
+   * @param isDragged
+   * @param row
+   * @param viewColumn
+   * @param modelColumn
+   * @param dataField
+   * @return 
+   */
+  public Component getTableCellRendererComponent( Component originalComponent, JTable table, Object value, boolean isSelected, boolean hasFocus, boolean isDragged, int row, int viewColumn, int modelColumn, IModelFieldGroup dataField );
+}

src/org/quinto/swing/table/view/JBroTableHeaderUI.java

@@ -35,6 +35,7 @@
 import javax.swing.table.TableColumn;
 import org.apache.log4j.Logger;
 import org.quinto.swing.table.model.IModelFieldGroup;
+import org.quinto.swing.table.model.ModelData;
 
 public class JBroTableHeaderUI extends BasicTableHeaderUI {
   private static final Logger LOGGER = Logger.getLogger( JBroTableHeaderUI.class );
@@ -50,6 +51,7 @@ public class JBroTableHeaderUI extends BasicTableHeaderUI {
   private boolean updating;
   private ComponentUI headerDelegate;
   private ReverseBorder lastBorder;
+  private CustomTableHeaderRenderer customRenderer;
 
   public JBroTableHeaderUI( JBroTable table ) {
     this.table = table;
@@ -66,6 +68,14 @@ void updateLookAndFeel() {
     }
     updating = false;
   }
+
+  public CustomTableHeaderRenderer getCustomRenderer() {
+    return customRenderer;
+  }
+
+  public void setCustomRenderer( CustomTableHeaderRenderer customRenderer ) {
+    this.customRenderer = customRenderer;
+  }
 
   public JBroTableHeader getHeader() {
     return ( JBroTableHeader )header;
@@ -401,7 +411,11 @@ private void paintCell( Graphics g, Rectangle cellRect, JBroTableColumn group )
     boolean parentUIdeterminesRolloverColumnItself = hasParentUI( renderer );
     boolean rollover = parentUIdeterminesRolloverColumnItself ? group == getHeader().getDraggedGroup() : group == selectedColumn;
     table.setCurrentLevel( group.getY() );
-    Component comp = renderer.getTableCellRendererComponent( table, group.getHeaderValue(), rollover, rollover, group.getY(), getTableColumnModel().getColumnRelativeIndex( group ) );
+    Object value = group.getHeaderValue();
+    int row = group.getY();
+    JBroTableColumnModel tcm = getTableColumnModel();
+    int viewColumn = tcm.getColumnRelativeIndex( group );
+    Component comp = renderer.getTableCellRendererComponent( table, value, rollover, rollover, row, viewColumn );
     table.setCurrentLevel( null );
     if ( !parentUIdeterminesRolloverColumnItself && comp instanceof JComponent && group == getHeader().getDraggedGroup() ) {
       Border border = ( ( JComponent )comp ).getBorder();
@@ -411,6 +425,29 @@ private void paintCell( Graphics g, Rectangle cellRect, JBroTableColumn group )
         ( ( JComponent )comp ).setBorder( lastBorder );
       }
     }
+    if ( customRenderer != null ) {
+      IModelFieldGroup dataField = null;
+      int modelColumn = group.getModelIndex();
+      ModelData data = table.getData();
+      if ( data != null ) {
+        if ( modelColumn >= 0 && data.getFields() != null && modelColumn < data.getFields().length )
+          dataField = data.getFields()[ modelColumn ];
+        else {
+          int coords[] = data.getIndexOfModelFieldGroup( String.valueOf( group.getIdentifier() ) );
+          int level = coords[ 1 ];
+          int col = coords[ 0 ];
+          if ( level >= 0 && col >= 0 ) {
+            List< IModelFieldGroup[] > fields = data.getFieldGroups();
+            if ( fields.size() > level ) {
+              IModelFieldGroup levelFields[] = fields.get( level );
+              if ( levelFields.length > col )
+                dataField = levelFields[ col ];
+            }
+          }
+        }
+      }
+      comp = customRenderer.getTableCellRendererComponent( comp, table, value, rollover, rollover, group == getHeader().getDraggedGroup(), row, viewColumn, modelColumn, dataField );
+    }
     paintCell( g, comp, cellRect );
   }
 

src/org/quinto/swing/table/view/ReverseBorder.java

@@ -6,6 +6,10 @@
 import java.awt.Insets;
 import javax.swing.border.Border;
 
+/**
+ * A border that rotates a delegate border by 180 degrees.
+ * <p>It causes a raised bevel border to be lowered and vice versa.</p>
+ */
 public class ReverseBorder implements Border {
   private final Border delegate;
 

test/org/quinto/swing/table/view/JBroTableColumnModelShowcase.java

@@ -3,7 +3,12 @@
 import com.sun.java.swing.plaf.motif.MotifLookAndFeel;
 import com.sun.java.swing.plaf.windows.WindowsClassicLookAndFeel;
 import com.sun.java.swing.plaf.windows.WindowsLookAndFeel;
+import java.awt.Color;
+import java.awt.Component;
 import java.awt.FlowLayout;
+import java.awt.Font;
+import java.awt.Graphics;
+import java.awt.GridLayout;
 import java.awt.Toolkit;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
@@ -12,8 +17,11 @@
 import java.util.Collections;
 import javax.swing.JButton;
 import javax.swing.JFrame;
+import javax.swing.JLabel;
+import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import javax.swing.JTable;
+import javax.swing.SwingConstants;
 import javax.swing.UIManager;
 import javax.swing.UnsupportedLookAndFeelException;
 import javax.swing.plaf.metal.DefaultMetalTheme;
@@ -23,6 +31,7 @@
 import javax.swing.plaf.nimbus.NimbusLookAndFeel;
 import javax.swing.table.TableColumn;
 import org.apache.log4j.Logger;
+import org.quinto.swing.table.model.IModelFieldGroup;
 import org.quinto.swing.table.model.ModelData;
 import org.quinto.swing.table.model.ModelField;
 import org.quinto.swing.table.model.ModelFieldGroup;
@@ -39,6 +48,8 @@ public class JBroTableColumnModelShowcase {
 
   public static void main( String args[] ) {
     Utils.initSimpleConsoleLogger();
+    
+    // Look & Feel switcher.
     Method m;
     try {
       m = Toolkit.class.getDeclaredMethod( "setDesktopProperty", String.class, Object.class );
@@ -104,6 +115,8 @@ else if ( laf == 4 ) {
       }
     };
     lafChanger.actionPerformed( null );
+    
+    // Table model.
     int colCnt = 10;
     int rowCnt = 10;
     ModelField fields[] = new ModelField[ colCnt ];
@@ -127,11 +140,47 @@ else if ( laf == 4 ) {
         rows[ i ].setValue( j, i == j ? "sort me" : String.valueOf( ( char )( 'A' + j ) ) + i );
     }
     data.setRows( rows );
+    
+    // Table view.
     table = new JBroTable( data );
     table.setAutoCreateRowSorter( true );
+    table.getTableHeader().getUI().setCustomRenderer( new CustomTableHeaderRenderer() {
+      @Override
+      public Component getTableCellRendererComponent( final Component originalComponent, JTable table, Object value, boolean isSelected, boolean hasFocus, boolean isDragged, int row, int viewColumn, int modelColumn, IModelFieldGroup dataField ) {
+        if ( dataField == null || !( originalComponent instanceof JLabel ) )
+          return originalComponent;
+        JLabel ret = ( JLabel )originalComponent;
+        String fieldName = dataField.getIdentifier();
+        // "GC" cell is right aligned. Other cells are centered.
+        ret.setHorizontalAlignment( "GC".equals( fieldName ) ? SwingConstants.RIGHT : SwingConstants.CENTER );
+        // "D" cell caption is written in bold. Other captions have plain font.
+        ret.setFont( ret.getFont().deriveFont( "D".equals( fieldName ) ? Font.BOLD : Font.PLAIN ) );
+        // "B" cell would be half-transparent red with Windows L&F (not classic).
+        // Note that background is reset on each call by underlying renderer so there's no need to reset background for other cells.
+        // Properties like alignment and font should be reset on each call if they were changed before.
+        if ( "B".equals( fieldName ) && !originalComponent.getClass().getName().contains( "DefaultTableCellHeaderRenderer" ) )
+          ret.setBackground( new Color( 220, 50, 50, 50 ) );
+        // "C" cell would be half-transparent red.
+        if ( "C".equals( fieldName ) ) {
+          JPanel p = new JPanel( new GridLayout( 1, 1 ) ) {
+            @Override
+            public void paint( Graphics g ) {
+              super.paint( g );
+              g.setColor( new Color( 220, 50, 50, 50 ) );
+              g.fillRect( 0, 0, getWidth(), getHeight() );
+            }
+          };
+          p.add( ret );
+          return p;
+        }
+        return ret;
+      }
+    } );
     System.out.println( table.getColumnModel() );
     for ( TableColumn tc : Collections.list( table.getColumnModel().getColumns() ) )
       System.out.println( tc.getHeaderValue() );
+    
+    // Frame.
     frame = new JFrame( "Testing" );
     frame.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE );
     frame.setLayout( new FlowLayout() );

version.properties

@@ -1 +1 @@
-project.version=1.0.1
+project.version=1.0.3