de.jaret.util.ui.timebars.swt.renderer
Interface GridRenderer

All Known Implementing Classes:

AbstractGridRenderer, DefaultGridRenderer

public interface GridRenderer

Renderer for drawing the background (grid) of the TimeBarViewer. The grid renderer cares for the vertical structure (draw) and has two additional methods for row based rendering that includes drawing a row highlight and the row selection and allow for simple row based effect rendernigs as well.

Version:

$Id: GridRenderer.java 836 2009-02-14 21:24:39Z kliem $

Author:

Peter Kliem

Method Summary

GridRenderer	createPrintRenderer(org.eclipse.swt.printing.Printer printer) Create a similar renderer for printing.
void	dispose() Dispose the renderer.
void	draw(org.eclipse.swt.graphics.GC gc, TimeBarViewerDelegate delegate, org.eclipse.swt.graphics.Rectangle drawingArea, boolean printing) Draw the grid.
void	drawRowAfterIntervals(org.eclipse.swt.graphics.GC gc, TimeBarViewerDelegate delegate, org.eclipse.swt.graphics.Rectangle drawingArea, TimeBarRow row, boolean selected, boolean printing) Do row painting AFTER intervals are drawn.
void	drawRowBeforeIntervals(org.eclipse.swt.graphics.GC gc, TimeBarViewerDelegate delegate, org.eclipse.swt.graphics.Rectangle drawingArea, TimeBarRow row, boolean selected, boolean printing) Do row painting BEFORE intervals are drawn.
void	setTickProvider(ITickProvider tickProvider) Set a tick provider the grid renderer may use.

Method Detail

draw

void draw(org.eclipse.swt.graphics.GC gc,
          TimeBarViewerDelegate delegate,
          org.eclipse.swt.graphics.Rectangle drawingArea,
          boolean printing)

Draw the grid.

Parameters:

gc - GC to paint on.

delegate - TimeBarViewerDelegate supplying information.

drawingArea - background area.

printing - flag indicating that the paint operation is for a printer.

drawRowBeforeIntervals

void drawRowBeforeIntervals(org.eclipse.swt.graphics.GC gc,
                            TimeBarViewerDelegate delegate,
                            org.eclipse.swt.graphics.Rectangle drawingArea,
                            TimeBarRow row,
                            boolean selected,
                            boolean printing)

Do row painting BEFORE intervals are drawn. This method (or the "after" method) is responsible for drawing highlighted rows and row selection.

Parameters:

gc - GC

delegate - time bar viewer delegate

drawingArea - area the row occupies on the screen

row - the row

selected - true if the row is selected

printing - true if printing

drawRowAfterIntervals

void drawRowAfterIntervals(org.eclipse.swt.graphics.GC gc,
                           TimeBarViewerDelegate delegate,
                           org.eclipse.swt.graphics.Rectangle drawingArea,
                           TimeBarRow row,
                           boolean selected,
                           boolean printing)

Do row painting AFTER intervals are drawn. This method (or the "before" method) is responsible for drawing highlighted rows and row selection.

Parameters:

gc - GC

delegate - time bar viewer delegate

drawingArea - area the row occupies on the screen

row - the row

selected - true if the row is selected

printing - true if printing

setTickProvider

void setTickProvider(ITickProvider tickProvider)

Set a tick provider the grid renderer may use.

Parameters:

tickProvider - the tick provider

dispose

void dispose()

Dispose the renderer. Should free up any resources locked.

createPrintRenderer

GridRenderer createPrintRenderer(org.eclipse.swt.printing.Printer printer)

Create a similar renderer for printing. The creation should copy settings made to the producing renderer.

Parameters:

printer - Printer device

Returns:

a configured renderer for printing.