Save This Page
Home » pentaho-reporting-engine-classic-0.8.10 » org.jfree.report.modules.output.support » pagelayout » [javadoc | source]
org.jfree.report.modules.output.support.pagelayout
public interface: SimplePageLayoutWorker [javadoc | source]

All Known Implementing Classes:
    SimplePageLayouter, TableWriter

The layout worker is responsible to perform the to perform the content creation and output.
Field Summary
public static final  boolean PAGEBREAK_BEFORE_HANDLED    A constant defining, that the 'pagebreak before' should be handled. 
public static final  boolean PAGEBREAK_BEFORE_IGNORED    A constant defining, that the 'pagebreak before' should be ignored. 
public static final  boolean BAND_SPOOLED    A constant defining, that the output should be spooled and not yet printed. 
public static final  boolean BAND_PRINTED    A constant defining, that the output can be safely printed. 
Method from org.jfree.report.modules.output.support.pagelayout.SimplePageLayoutWorker Summary:
getCursorPosition,   getReservedSpace,   getTopContentPosition,   isPageEmpty,   isPageEnded,   isWatermarkSupported,   print,   printBottom,   printWatermark,   resetCursor,   setReservedSpace,   setTopPageContentPosition
Method from org.jfree.report.modules.output.support.pagelayout.SimplePageLayoutWorker Detail:
 public float getCursorPosition()
    Returns the current cursor position. It is assumed, that the cursor goes from top to down, columns are not used.
 public float getReservedSpace()
    Returns the reserved size for the current page. This size is not used when performing a layout. This is usually used to preserve the pagefooters space.
 public float getTopContentPosition()
    Returns the position of the first content.
 public boolean isPageEmpty()
    Checks, whether the current page is empty. An page is empty if it does not contain printed content. An empty page may have spooled content.
 public boolean isPageEnded()
    Checks, whether the page has ended. Once a page that is completly filled, only the page footer will be printed and a page break will be done after that.
 public boolean isWatermarkSupported()
 public boolean print(Band band,
    boolean spoolBand,
    boolean handlePagebreakBefore) throws ReportProcessingException
    Prints the given band at the current cursor position.
 public boolean printBottom(Band band) throws ReportProcessingException
    Prints the given band at the bottom of the page.
 public boolean printWatermark(Band watermark) throws ReportProcessingException
 public  void resetCursor()
    Reinitialize the cursor of the layout worker. Called when a new page is started.
 public  void setReservedSpace(float reserved)
    Defines the reserved size for the current page. This size is not used when performing a layout. This is usually used to preserve the pagefooters space.
 public  void setTopPageContentPosition(float topPosition)
    Marks the position of the first content after the page header. This can be used to limit the maximum size of bands so that they do not exceed the available page space.

    This feature will be obsolete when bands can span multiple pages.