|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.report.io.BaseFormatter
public abstract class BaseFormatter
This is the base class of all formatter classes. It contains common methods of formatter classes.
| Field Summary | |
|---|---|
protected DocumentInfo |
docInfo
|
protected ReportSheet |
report
|
| Constructor Summary | |
|---|---|
BaseFormatter()
|
|
| Method Summary | |
|---|---|
void |
addProgressListener(ProgressListener listener)
Add a listener to be notified of export progress. |
abstract void |
end()
Write end. |
protected abstract void |
endCell()
End a cell. |
protected abstract void |
endGrid()
End the layout grid. |
protected abstract void |
endRow()
End a row. |
static String |
escape(String str)
Escape a string with XML escape string for attribute values. |
protected void |
fireProgressEvent(int current)
Fire a progress event. |
protected void |
init(ReportSheet report)
Initialize the report. |
protected void |
localize(ReportSheet sheet)
Localize the report. |
void |
removeProgressListener(ProgressListener listener)
Remove a listener. |
void |
setDocumentInfo(DocumentInfo info)
Set the document info to export. |
protected abstract void |
startCell(TabularSheet sheet,
int r,
int c,
Object bg,
Insets borders,
Color bcolor,
Rectangle span,
String width,
boolean repeat)
Start a new cell. |
protected abstract void |
startGrid(int rows,
int cols)
Start a layout grid (for tabular layout). |
protected abstract void |
startRow(TabularSheet sheet,
int row)
Start a new row. |
void |
write(ParameterElement elem)
Write a parameter element. |
void |
write(ReportElement elem)
Write one element. |
void |
write(ReportSheet sheet)
Export a report. |
protected void |
write(SubreportElement subreport)
Write a subreport. |
protected void |
writeBeanPropertyDefinition(String prop,
BeanPropertyDefinition map)
Write a bean mapping definition. |
protected void |
writeContents(BeanSheet sheet)
Export a BeanSheet object. |
protected void |
writeContents(StyleSheet sheet)
Export a StyleSheet report. |
protected void |
writeContents(TabularSheet sheet)
Export a TabularSheet report. |
protected void |
writeElementContents(ReportElement elem,
ReportSheet sheet)
Export a element content object. |
protected void |
writeSection(inetsoft.report.internal.SectionElementDef elem)
Write section. |
protected abstract void |
writeSectionBand(SectionBand band)
Print one band. |
protected abstract void |
writeShapes(PageLayout.Shape[] shapes)
Write the pagelayout shapes specifications. |
protected void |
writeWarnings(ReportElement elem,
ReportSheet sheet)
Write warning informations. |
protected void |
writeWarnings(String[] warnings)
Write warning messages. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface inetsoft.report.io.Formatter |
|---|
endHeader, prolog, startHeader, startHeader, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write |
| Field Detail |
|---|
protected DocumentInfo docInfo
protected ReportSheet report
| Constructor Detail |
|---|
public BaseFormatter()
| Method Detail |
|---|
public void setDocumentInfo(DocumentInfo info)
setDocumentInfo in interface Formatterpublic void addProgressListener(ProgressListener listener)
addProgressListener in interface Formatterpublic void removeProgressListener(ProgressListener listener)
removeProgressListener in interface Formatterprotected void fireProgressEvent(int current)
protected void writeContents(StyleSheet sheet)
throws IOException
IOException
protected void writeContents(BeanSheet sheet)
throws IOException
IOException
protected void writeElementContents(ReportElement elem,
ReportSheet sheet)
throws IOException
IOException
protected void writeContents(TabularSheet sheet)
throws IOException
IOException
protected void writeWarnings(ReportElement elem,
ReportSheet sheet)
protected abstract void startGrid(int rows,
int cols)
rows - number of rows.cols - number of columns.protected abstract void endGrid()
protected abstract void startRow(TabularSheet sheet,
int row)
sheet - tabular report object.row - row index in the grid.protected abstract void endRow()
protected abstract void startCell(TabularSheet sheet,
int r,
int c,
Object bg,
Insets borders,
Color bcolor,
Rectangle span,
String width,
boolean repeat)
r - row index.c - column index.bg - cell background color or image.borders - border setting.bcolor - border color.span - cell span.width - column width. See TabularSheet for width specification
format.repeat - true to repeat the cell contents on every page.protected abstract void endCell()
protected void init(ReportSheet report)
public void write(ReportSheet sheet)
throws IOException
write in interface Formattersheet - report to export.
IOExceptionprotected void localize(ReportSheet sheet)
public void write(ReportElement elem)
throws IOException
elem - report element.
IOException
protected void writeWarnings(String[] warnings)
throws IOException
IOException
public void write(ParameterElement elem)
throws IOException
write in interface FormatterIOException
protected void writeSection(inetsoft.report.internal.SectionElementDef elem)
throws IOException
IOException
protected void write(SubreportElement subreport)
throws IOException
IOException
protected abstract void writeSectionBand(SectionBand band)
throws IOException
IOExceptionprotected abstract void writeShapes(PageLayout.Shape[] shapes)
public abstract void end()
throws IOException
end in interface FormatterIOException
protected void writeBeanPropertyDefinition(String prop,
BeanPropertyDefinition map)
public static String escape(String str)
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||