com.sciapp.table
Class SortTableRenderer

java.lang.Object
  extended by com.sciapp.table.SortTableRenderer
All Implemented Interfaces:
TableCellRenderer
Direct Known Subclasses:
SortTableButtonRenderer

public abstract class SortTableRenderer
extends Object
implements TableCellRenderer

SortTableRenderer is responsible for drawing the columns of the table header. The getTableCellRendererComponent method defined in the TableCellRenderer interface returns the component used in drawing the header, according to which sorting method is in use: ascending, descending, no sorting.


Constructor Summary
SortTableRenderer()
          Constructs a SortTableRenderer object to be used in drawing the columns of the table header.
 
Method Summary
abstract  Component getAscSortComponent()
          Returns the component used when ascending sorting is being used.
abstract  Component getDescSortComponent()
          Returns the component used when descending sorting is being used.
abstract  Component getNoSortComponent()
          Returns the component used when no sorting is being used.
 Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column)
          Returns the component used for drawing the cell.
abstract  void prepareRenderer(int sortIndex, Object value, int column, Component comp)
          Prepares the component used for drawing the header.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SortTableRenderer

public SortTableRenderer()
Constructs a SortTableRenderer object to be used in drawing the columns of the table header.

Method Detail

getAscSortComponent

public abstract Component getAscSortComponent()
Returns the component used when ascending sorting is being used.

Returns:
the component used when ascending sorting is being used.

getDescSortComponent

public abstract Component getDescSortComponent()
Returns the component used when descending sorting is being used.

Returns:
the component used when descending sorting is being used.

getNoSortComponent

public abstract Component getNoSortComponent()
Returns the component used when no sorting is being used.

Returns:
the component used when no sorting is being used.

getTableCellRendererComponent

public Component getTableCellRendererComponent(JTable table,
                                               Object value,
                                               boolean isSelected,
                                               boolean hasFocus,
                                               int row,
                                               int column)
Returns the component used for drawing the cell. This method is used to configure the renderer appropriately before drawing.

Specified by:
getTableCellRendererComponent in interface TableCellRenderer
Parameters:
table - the JTable that is asking the renderer to draw; can be null
value - the value of the cell to be rendered. It is up to the specific renderer to interpret and draw the value. For example, if value is the string "true", it could be rendered as a string or it could be rendered as a check box that is checked. null is a valid value
isSelected - true if the cell is to be rendered with the selection highlighted; otherwise false
hasFocus - if true, render cell appropriately. For example, put a special border on the cell, if the cell can be edited, render in the color used to indicate editing
row - the row index of the cell being drawn. When drawing the header, the value of row is -1
column - the column index of the cell being drawn

prepareRenderer

public abstract void prepareRenderer(int sortIndex,
                                     Object value,
                                     int column,
                                     Component comp)
Prepares the component used for drawing the header.

Parameters:
sortIndex - the sorting order of the column being drawn
value - the value of the header column
column - the column being drawn
comp - the component being drawn