|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.jrefinery.report.function.AbstractFunction | +--com.jrefinery.report.targets.table.TableWriter
The TableWriter is the content creation function used to collect the cell data. After the layouting is done, the layouted bands are forwarded to the TableProducer. The virtual page has an unlimited size, only when a manual pagebreak is encountered, a new page is started.
This can be used to f.i. to create separate sheets in Excel-Workbooks, the detailed semantics depend on concrete implementation of the TableProducer.
This writer is not thread-safe.
Field Summary | |
static java.lang.String |
BASE_RESOURCE_CLASS
The base class for localised resources. |
static java.lang.String |
SHEET_NAME_FUNCTION_PROPERTY
The SheetName-function property, defines the name of an StringFunction that creates the sheet names. |
Fields inherited from interface com.jrefinery.report.function.Expression |
AUTOACTIVATE_PROPERTY |
Constructor Summary | |
TableWriter()
Creates a new TableWriter. |
Method Summary | |
ReportEvent |
getCurrentEvent()
Returns the current event, which has been updated at the start of every ReportListener method. |
int |
getDependencyLevel()
The dependency level defines the level of execution for this function. |
float |
getMaxWidth()
Gets the maximum width available for a root band during the layouting process. |
TableProducer |
getProducer()
Gets the TableProducer. |
java.util.ResourceBundle |
getResources()
Retrieves the resources for this PreviewFrame. |
java.lang.Object |
getValue()
Return the current expression value. |
void |
groupFinished(ReportEvent event)
Prints the group footer for the current group. |
void |
groupStarted(ReportEvent event)
Prints the group header for the current group. |
void |
itemsAdvanced(ReportEvent event)
Prints the itemband. |
void |
itemsFinished(ReportEvent event)
Handles the end of the item processing. |
void |
itemsStarted(ReportEvent event)
Handles the start of the item processing. |
void |
pageFinished(ReportEvent event)
Prints the page footer. |
void |
pageStarted(ReportEvent event)
Prints the PageHeader and all repeating group headers. |
protected void |
print(Band b)
Performs the band layout and prints the band. |
void |
reportFinished(ReportEvent event)
Receives notification that the report has finished. |
void |
reportStarted(ReportEvent event)
Receives notification that the report has started. |
void |
setCurrentEvent(ReportEvent currentEvent)
Defines the current event, which must be updated at the start of every ReportListener method. |
void |
setDependencyLevel(int deplevel)
Overrides the depency level. |
void |
setMaxWidth(float width)
Defines the maximum width available for a root band during the layouting process. |
void |
setProducer(TableProducer producer)
Sets the TableProducer, that should be used to create the TableCellData. |
void |
startPage()
Starts a new page. |
Methods inherited from class com.jrefinery.report.function.AbstractFunction |
clone, getDataRow, getInstance, getName, getProperties, getProperty, getProperty, initialize, isActive, reportDone, reportInitialized, setDataRow, setName, setProperties, setProperty |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String SHEET_NAME_FUNCTION_PROPERTY
public static final java.lang.String BASE_RESOURCE_CLASS
Constructor Detail |
public TableWriter()
Method Detail |
public java.lang.Object getValue()
The value depends (obviously) on the expression implementation.
public float getMaxWidth()
public void setMaxWidth(float width)
width
- the maximum width for a root band.public void startPage()
protected void print(Band b)
b
- the band.public int getDependencyLevel()
PageLayouter functions override the default behaviour an place them self at depency level -1, an so before any userdefined function.
getDependencyLevel
in interface Expression
getDependencyLevel
in class AbstractFunction
public void setDependencyLevel(int deplevel)
setDependencyLevel
in interface Expression
setDependencyLevel
in class AbstractFunction
deplevel
- the new depency level.public void reportStarted(ReportEvent event)
reportStarted
in interface ReportListener
reportStarted
in class AbstractFunction
event
- the event.public void reportFinished(ReportEvent event)
reportFinished
in interface ReportListener
reportFinished
in class AbstractFunction
event
- the event.public java.util.ResourceBundle getResources()
public void pageStarted(ReportEvent event)
pageStarted
in interface ReportListener
pageStarted
in class AbstractFunction
event
- the event.public void pageFinished(ReportEvent event)
pageFinished
in interface ReportListener
pageFinished
in class AbstractFunction
event
- the event.public void groupStarted(ReportEvent event)
groupStarted
in interface ReportListener
groupStarted
in class AbstractFunction
event
- the event.public void groupFinished(ReportEvent event)
groupFinished
in interface ReportListener
groupFinished
in class AbstractFunction
event
- the event.public void itemsAdvanced(ReportEvent event)
itemsAdvanced
in interface ReportListener
itemsAdvanced
in class AbstractFunction
event
- the event.public void itemsStarted(ReportEvent event)
The next events will be itemsAdvanced events until the itemsFinished event is raised.
itemsStarted
in interface ReportListener
itemsStarted
in class AbstractFunction
event
- The event.public void itemsFinished(ReportEvent event)
The itemBand is finished, the report starts to close open groups.
itemsFinished
in interface ReportListener
itemsFinished
in class AbstractFunction
event
- The event.public ReportEvent getCurrentEvent()
public void setCurrentEvent(ReportEvent currentEvent)
currentEvent
- the current event.public TableProducer getProducer()
public void setProducer(TableProducer producer)
producer
- the table producer that should be used to create the TableCellData.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |