de.jaret.util.ui.timebars.swt.renderer
Class DefaultGridRenderer

java.lang.Object
  de.jaret.util.ui.timebars.swt.renderer.RendererBase
      de.jaret.util.ui.timebars.swt.renderer.AbstractGridRenderer
          de.jaret.util.ui.timebars.swt.renderer.DefaultGridRenderer

All Implemented Interfaces:

GridRenderer

public class DefaultGridRenderer
extends AbstractGridRenderer

Simple default grid renderer for the timebar viewer. Uses a holiday enumerator (jaretutils) to color the days.

Version:

$Id: DefaultGridRenderer.java 1073 2010-11-22 21:25:33Z kliem $

Author:

Peter Kliem

Field Summary

protected ITickProvider

_tickProvider external tick provider.

Fields inherited from class de.jaret.util.ui.timebars.swt.renderer.AbstractGridRenderer

_highlightAlpha, _highlightColor, _rowSelectAlpha, _rowSelectColor, HIGHLIGHT_COLOR, ROWSELECT_COLOR

Fields inherited from class de.jaret.util.ui.timebars.swt.renderer.RendererBase

_printer, _scaleX, _scaleY

Constructor Summary

DefaultGridRenderer()
Create a DefaultGridRenderer for the screen.

DefaultGridRenderer(org.eclipse.swt.printing.Printer printer)
Create a DefaultGridRenderer for a printer.

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	drawIntern(org.eclipse.swt.graphics.GC gc, TimeBarViewerDelegate delegate, org.eclipse.swt.graphics.Rectangle drawingArea, boolean printing, boolean horizontal)
void	drawIntern(org.eclipse.swt.graphics.GC gc, TimeBarViewerDelegate delegate, org.eclipse.swt.graphics.Rectangle drawingArea, boolean printing, boolean horizontal, ITickProvider tickProvider)
void	setHolidayEnumerator(de.jaret.util.date.holidayenumerator.HolidayEnumerator he) Set the holiday enumerator to be used for coloring days.
void	setMarkHolidays(boolean mark) If mark holidaysdays is set to true, days that are holidays days according to the holiday enumerator are colored.
void	setMarkSpecialDays(boolean mark) If mark special days is set to true, days that are special days according to the holiday enumerator are colored.
void	setMarkWeekends(boolean mark) If mark weekends is set to true, weekend days will be colored.
void	setTickProvider(ITickProvider tickProvider) Set a tick provider to determine the ticks to be drawn.
void	setUpperPPSMarkLimit(double limit) Set the limit for the pixPerSecond (scale) for marking days.

Methods inherited from class de.jaret.util.ui.timebars.swt.renderer.AbstractGridRenderer

drawRowAfterIntervals, drawRowBeforeIntervals, getHighlightAlpha, getHighlightColor, getRowSelectAlpha, getRowSelectColor, setHighlightAlpha, setHighlightColor, setRowSelectAlpha, setRowSelectColor

Methods inherited from class de.jaret.util.ui.timebars.swt.renderer.RendererBase

drawFocus, getDefaultLineWidth, getPrinter, getScaleX, getScaleY, scaleX, scaleY

Methods inherited from class java.lang.Object

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

Field Detail

_tickProvider

protected ITickProvider _tickProvider

external tick provider.

Constructor Detail

DefaultGridRenderer

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

Create a DefaultGridRenderer for a printer.

Parameters:

printer - printer device

DefaultGridRenderer

public DefaultGridRenderer()

Create a DefaultGridRenderer for the screen.

Method Detail

setTickProvider

public void setTickProvider(ITickProvider tickProvider)

Set a tick provider to determine the ticks to be drawn. If no tick provider is set the defaulst by the tick scaler will be used.

Parameters:

tickProvider - tick provider to be used or null.

setHolidayEnumerator

public void setHolidayEnumerator(de.jaret.util.date.holidayenumerator.HolidayEnumerator he)

Set the holiday enumerator to be used for coloring days.

Parameters:

he - HolidayEnumerator to be used

setMarkWeekends

public void setMarkWeekends(boolean mark)

If mark weekends is set to true, weekend days will be colored.

Parameters:

mark - true for week end coloring

setMarkSpecialDays

public void setMarkSpecialDays(boolean mark)

If mark special days is set to true, days that are special days according to the holiday enumerator are colored.

Parameters:

mark - true for coloring spcial days

setMarkHolidays

public void setMarkHolidays(boolean mark)

If mark holidaysdays is set to true, days that are holidays days according to the holiday enumerator are colored.

Parameters:

mark - true for coloring holidays

setUpperPPSMarkLimit

public void setUpperPPSMarkLimit(double limit)

Set the limit for the pixPerSecond (scale) for marking days.

Parameters:

limit - pixPerSecond limit (upper bound)

draw

public 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.

drawIntern

public void drawIntern(org.eclipse.swt.graphics.GC gc,
                       TimeBarViewerDelegate delegate,
                       org.eclipse.swt.graphics.Rectangle drawingArea,
                       boolean printing,
                       boolean horizontal,
                       ITickProvider tickProvider)

drawIntern

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

dispose

public void dispose()

Dispose the renderer. Should free up any resources locked.

Specified by:

dispose in interface GridRenderer

Overrides:

dispose in class AbstractGridRenderer

createPrintRenderer

public 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.