com.jrefinery.report.targets.pageable.pagelayout
Class FlowPageLayouter

java.lang.Object
  |
  +--com.jrefinery.report.function.AbstractFunction
        |
        +--com.jrefinery.report.targets.pageable.pagelayout.PageLayouter
              |
              +--com.jrefinery.report.targets.pageable.pagelayout.FlowPageLayouter
All Implemented Interfaces:
java.lang.Cloneable, java.util.EventListener, Expression, Function, ReportListener

public class FlowPageLayouter
extends PageLayouter

A page layouter. No real implementation ... next release ..

Author:
Thomas Morgner.

Nested Class Summary
 
Nested classes inherited from class com.jrefinery.report.targets.pageable.pagelayout.PageLayouter
PageLayouter.LayoutManagerState
 
Field Summary
 
Fields inherited from interface com.jrefinery.report.function.Expression
AUTOACTIVATE_PROPERTY
 
Constructor Summary
FlowPageLayouter()
          Creates a new page layouter.
 
Method Summary
 void endTask(LayoutTask task)
          Ends a task.
 LayoutTask getTaskForEvent(ReportEvent event)
          Gets a task for an event.
 void initialize()
          Checks that the function has been correctly initialized.
 boolean isManualPageBreak()
          A detector whether the last pagebreak was a manual pagebreak or an automatic one.
 boolean isNewPageStarted()
          Returns false.
 void performLayout(ReportEvent event)
          Performs layout.
 void restoreSaveState(ReportState state)
          Restores the layoutmanager state by using this state as new base for processing.
protected  PageLayouter.LayoutManagerState saveCurrentState()
          Saves the current state.
 
Methods inherited from class com.jrefinery.report.targets.pageable.pagelayout.PageLayouter
clearCurrentEvent, clearLogicalPage, clearSaveState, clone, endPage, getCurrentEvent, getDependencyLevel, getLayoutManagerState, getLogicalPage, getReport, getValue, isFinishingPage, isGeneratedPageEmpty, isPageEnded, isPageRestartDone, isRestartingPage, setCurrentEvent, setDependencyLevel, setFinishingPage, setGeneratedPageEmpty, setLogicalPage, setPageRestartDone, setRestartingPage, startPage
 
Methods inherited from class com.jrefinery.report.function.AbstractFunction
getDataRow, getInstance, getName, getProperties, getProperty, getProperty, groupFinished, groupStarted, isActive, itemsAdvanced, itemsFinished, itemsStarted, pageFinished, pageStarted, reportDone, reportFinished, reportInitialized, reportStarted, setDataRow, setName, setProperties, setProperty
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FlowPageLayouter

public FlowPageLayouter()
Creates a new page layouter.

Method Detail

getTaskForEvent

public LayoutTask getTaskForEvent(ReportEvent event)
Gets a task for an event.

Parameters:
event - the event.
Returns:
the layout task.

endTask

public void endTask(LayoutTask task)
Ends a task.

Parameters:
task - the task.

performLayout

public void performLayout(ReportEvent event)
Performs layout.

Parameters:
event - the event.

saveCurrentState

protected PageLayouter.LayoutManagerState saveCurrentState()
Saves the current state.

Specified by:
saveCurrentState in class PageLayouter
Returns:
null.

restoreSaveState

public void restoreSaveState(ReportState state)
                      throws ReportProcessingException
Restores the layoutmanager state by using this state as new base for processing. This state must be an clone of the last report state for the previous page or the original last report state - or the processing will print stupid things.

Overrides:
restoreSaveState in class PageLayouter
Parameters:
state - the state.
Throws:
ReportProcessingException - never.

isManualPageBreak

public boolean isManualPageBreak()
A detector whether the last pagebreak was a manual pagebreak or an automatic one.

Returns:
true or false.

initialize

public void initialize()
                throws FunctionInitializeException
Checks that the function has been correctly initialized. If there is a problem, this method throws a FunctionInitializeException.

The default implementation checks that the function name is not null, and calls the isInitialized() method (now deprecated).

Specified by:
initialize in interface Expression
Overrides:
initialize in class AbstractFunction
Throws:
FunctionInitializeException - if the function name is not set or the call to isInitialized returns false.

isNewPageStarted

public boolean isNewPageStarted()
Returns false.

Specified by:
isNewPageStarted in class PageLayouter
Returns:
false.