ca.sqlpower.wabit.report
Interface ReportContentRenderer

All Superinterfaces:

ca.sqlpower.object.SPObject, WabitObject

All Known Subinterfaces:

WabitObjectReportRenderer

All Known Implementing Classes:

CellSetRenderer, ChartRenderer, ImageRenderer, Label, ResultSetRenderer

public interface ReportContentRenderer
extends WabitObject

Interface for providers of rendered (absolute layout) content.

Nested Class Summary

static class

ReportContentRenderer.BackgroundColours

Method Summary

java.awt.Color	getBackgroundColour()
void	refresh() Refreshes the data being rendered by this ReportContentRenderer so that it has the most recent data.
boolean	renderReportContent(java.awt.Graphics2D g, ContentBox contentBox, double scaleFactor, int pageIndex, boolean printing) Renders as much report content as will fit within the bounds of the given content box.
void	resetToFirstPage() Tells this content renderer that the next call to #renderReportContent(Graphics2D, ContentBox, double) should produce the first page of output again.

Methods inherited from interface ca.sqlpower.wabit.WabitObject

getParent

Methods inherited from interface ca.sqlpower.object.SPObject

addChild, addSPListener, allowsChildren, begin, childPositionOffset, cleanup, commit, generateNewUUID, getChildren, getChildren, getDependencies, getName, getSession, getUUID, removeChild, removeDependency, removeSPListener, rollback, setName, setParent, setUUID

Method Detail

renderReportContent

boolean renderReportContent(java.awt.Graphics2D g,
                            ContentBox contentBox,
                            double scaleFactor,
                            int pageIndex,
                            boolean printing)

Renders as much report content as will fit within the bounds of the given content box.

Report content renderers can be implemented in two different ways:

• Label-like renderers attempt to show all their content every time they are called, and never ask for another page. These renderers don't necessarily render exactly the same content on every page--a footer label with a page number variable is a good example.
• Resultset-like renderers that show as much content as possible each time they are called, and keep track of what to start rendering on the next call. These types of renderers ask for more pages until they have nothing left to render. If called again, they simply do not draw anything.

  Parameters:

  g - The graphics to render into. The origin (top left corner or (0,0)) of this graphics is translated to the top-left corner of the content box.

  contentBox - The box that determines the size and shape that the rendered data must fit within. You can ignore the X and Y coordinates of the box because the given graphics object's origin is already set to this box's origin.

  scaleFactor - The amount of scaling currently in effect. The nominal size of a unit when displayed via the given graphics is scaleFactor/72 inches.

  pageIndex - The zero-based page number for which the corresponding report content will be rendered.

  printing - This tells the renderer if the report is being printed. If set to true the full report will be built, otherwise a cached result will be used. Set this to true if the report is being printed.

  Returns:

  True if this renderer has more data to render, and would like to be called upon again. Returning true will typically cause the report to grow by another page. The final page of the report is the first one where all content renderers involved return false.

resetToFirstPage

void resetToFirstPage()

Tells this content renderer that the next call to #renderReportContent(Graphics2D, ContentBox, double) should produce the first page of output again.

getBackgroundColour

java.awt.Color getBackgroundColour()

refresh

void refresh()

Refreshes the data being rendered by this ReportContentRenderer so that it has the most recent data. If the data this renderer renders is static, then it doesn't need to do anything (no-op).