com.levigo.jadice.swing.tool
Class RenderParameters

java.lang.Object
  com.levigo.jadice.document.render.BasicRenderParameters
      com.levigo.jadice.swing.tool.RenderParameters

public class RenderParameters
extends BasicRenderParameters

This is a parameter object class used for calls to Tool.render(RenderParameters,boolean). By using a parameter object instead of immediate method parameters, we can keep the API stable while allowing future extensibility.

Field Summary

Fields inherited from class com.levigo.jadice.document.render.BasicRenderParameters

graphics, page, pageIndex, renderControls, renderedPageBounds, transform

Constructor Summary

RenderParameters(ViewComponent viewComponent, Page page, int pageIndex, Rectangle renderedPageBounds, Graphics2D g, RenderControls renderControls)

Method Summary

ViewComponent

getViewComponent() Get the view component triggering the render cycle.

Methods inherited from class com.levigo.jadice.document.render.BasicRenderParameters

getGraphics, getPage, getPageIndex, getRenderControls, getRenderedPageBounds, getRenderSize, getTransform

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderParameters

public RenderParameters(ViewComponent viewComponent,
                        Page page,
                        int pageIndex,
                        Rectangle renderedPageBounds,
                        Graphics2D g,
                        RenderControls renderControls)

Parameters:

viewComponent - the view component which is currently being rendered

page - the current page

pageIndex - the index of the page currently being rendered

renderedPageBounds - the bounds of the page currently being rendered in device units

g - the Graphics2D context onto which to render

renderControls - render controls used to render the page

Method Detail

getViewComponent

public ViewComponent getViewComponent()

Get the view component triggering the render cycle.

Returns:

the viewComponent