de.jaret.util.ui.table.renderer
Class BooleanCellRenderer

java.lang.Object
  de.jaret.util.ui.table.renderer.RendererBase
      de.jaret.util.ui.table.renderer.CellRendererBase
          de.jaret.util.ui.table.renderer.BooleanCellRenderer

All Implemented Interfaces:

ICellRenderer

public class BooleanCellRenderer
extends CellRendererBase
implements ICellRenderer

CellRenderer rendering a Boolean to a checkbox image (default) or any other two images.

Version:

$Id: BooleanCellRenderer.java 479 2007-06-01 22:01:50Z olk $

Author:

Peter Kliem

Field Summary

protected java.lang.String	_checkedRscName rsc name for the checked state.
protected java.lang.String	_uncheckedRscName default rsc name for the unchecked state.
protected static java.lang.String	CHECKED key for checked image in registry.
protected static java.lang.String	UNCHECKED key for unchecked image in registry.

Fields inherited from class de.jaret.util.ui.table.renderer.CellRendererBase

_inset, BLACKRGB, FOCUSINSETS, SELECTIONCOLOR, WHITERGB

Fields inherited from class de.jaret.util.ui.table.renderer.RendererBase

_printer, _scaleX, _scaleY, SCREEN_DPI_X, SCREEN_DPI_Y

Constructor Summary

BooleanCellRenderer()
Construct a boolean cell renderer for the display using default resources.

BooleanCellRenderer(org.eclipse.swt.printing.Printer printer)
Construct a boolean cell renderer for a printer device using default resources.

BooleanCellRenderer(org.eclipse.swt.printing.Printer printer, java.lang.String checkedRscName, java.lang.String uncheckedRscName)
Construct a boolean cell renderer for a printer device providing resource names.

BooleanCellRenderer(java.lang.String checkedRscName, java.lang.String uncheckedRscName)
Construct a boolean cell renderer for the display providing resource names.

Method Summary

ICellRenderer	createPrintRenderer(org.eclipse.swt.printing.Printer printer) Create a renderer connfigured for printing.
void	dispose() If there are resources to free - this is the place.
void	draw(org.eclipse.swt.graphics.GC gc, JaretTable jaretTable, ICellStyle cellStyle, org.eclipse.swt.graphics.Rectangle drawingArea, IRow row, IColumn column, boolean drawFocus, boolean selected, boolean printing) Draw a single cell.
int	getPreferredHeight(org.eclipse.swt.graphics.GC gc, ICellStyle cellStyle, int width, IRow row, IColumn column) Calculate the preferred height of a specific cell.
int	getPreferredWidth(java.util.List<IRow> rows, IColumn column) Calculate the preferred width for the column.

Methods inherited from class de.jaret.util.ui.table.renderer.CellRendererBase

applyInsets, drawBackground, drawBorder, drawCommentMarker, drawFocus, drawSelection, getBackgroundColor, getBorderColor, getFont, getForegroundColor, getInnerWidth, getTooltip, getVerticalSpacesSum, isInCommentMarkerArea

Methods inherited from class de.jaret.util.ui.table.renderer.RendererBase

getPrinter, getScaleX, getScaleY, restoreGCAttributes, saveGCAttributes, scaleX, scaleY

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.jaret.util.ui.table.renderer.ICellRenderer

getTooltip

Field Detail

_checkedRscName

protected java.lang.String _checkedRscName

rsc name for the checked state.

_uncheckedRscName

protected java.lang.String _uncheckedRscName

default rsc name for the unchecked state.

CHECKED

protected static final java.lang.String CHECKED

key for checked image in registry.

See Also:

Constant Field Values

UNCHECKED

protected static final java.lang.String UNCHECKED

key for unchecked image in registry.

See Also:

Constant Field Values

Constructor Detail

BooleanCellRenderer

public BooleanCellRenderer(org.eclipse.swt.printing.Printer printer)

Construct a boolean cell renderer for a printer device using default resources.

Parameters:

printer - printer device

BooleanCellRenderer

public BooleanCellRenderer()

Construct a boolean cell renderer for the display using default resources.

BooleanCellRenderer

public BooleanCellRenderer(org.eclipse.swt.printing.Printer printer,
                           java.lang.String checkedRscName,
                           java.lang.String uncheckedRscName)

Construct a boolean cell renderer for a printer device providing resource names.

Parameters:

printer - printer device

checkedRscName - resource path for the checked image

uncheckedRscName - resource path for the unchecked image

BooleanCellRenderer

public BooleanCellRenderer(java.lang.String checkedRscName,
                           java.lang.String uncheckedRscName)

Construct a boolean cell renderer for the display providing resource names.

Parameters:

checkedRscName - resource path for the checked image

uncheckedRscName - resource path for the unchecked image

Method Detail

draw

public void draw(org.eclipse.swt.graphics.GC gc,
                 JaretTable jaretTable,
                 ICellStyle cellStyle,
                 org.eclipse.swt.graphics.Rectangle drawingArea,
                 IRow row,
                 IColumn column,
                 boolean drawFocus,
                 boolean selected,
                 boolean printing)

Draw a single cell. The draw method should be null safe (handling null as the cell value).

Specified by:

draw in interface ICellRenderer

Parameters:

gc - GC to paint on

jaretTable - table the rendering is for

cellStyle - style of the cell

drawingArea - rectangle to draw within

row - row of the cell to paint

column - column of the cell to paint

drawFocus - true if a focus mark should be drawn

selected - true if the cell is currently selected

printing - true if the render operation is for a printer

getPreferredWidth

public int getPreferredWidth(java.util.List<IRow> rows,
                             IColumn column)

Calculate the preferred width for the column. Default implementation: no prferred width.

Specified by:

getPreferredWidth in interface ICellRenderer

Overrides:

getPreferredWidth in class CellRendererBase

Parameters:

rows - the rows currently displayed by the table

column - the column for which the preferred width is to be calculated

Returns:

the preferred width or -1 for no special preferred width.

getPreferredHeight

public int getPreferredHeight(org.eclipse.swt.graphics.GC gc,
                              ICellStyle cellStyle,
                              int width,
                              IRow row,
                              IColumn column)

Calculate the preferred height of a specific cell. Default implementation returning: no information.

Specified by:

getPreferredHeight in interface ICellRenderer

Overrides:

getPreferredHeight in class CellRendererBase

Parameters:

gc - GC that will used

cellStyle - cell style of the cell

width - width of the column (thus of the cell)

row - row

column - column

Returns:

the preferred height or -1 for no special preferred height

dispose

public void dispose()

If there are resources to free - this is the place.

Specified by:

dispose in interface ICellRenderer

createPrintRenderer

public ICellRenderer createPrintRenderer(org.eclipse.swt.printing.Printer printer)

Create a renderer connfigured for printing.

Specified by:

createPrintRenderer in interface ICellRenderer

Parameters:

printer - printer to use

Returns:

a configured renderer for printing