Style Intelligence v12.0

inetsoft.report.io
Interface Formatter

All Known Implementing Classes:
BaseFormatter, DelimitedFormatter, HTMLBundleFormatter, HTMLFormatter, ReportFormatter, RTFFormatter, TemplateFormatter

public interface Formatter

Formatter is responsible for converting report and report elements into an external format. This defines the API of all formatter classes.


Method Summary
 void addProgressListener(ProgressListener listener)
          Add a listener to be notified of export progress.
 void end()
          Write the end of report.
 void endHeader()
          End a header section.
 void prolog(ReportSheet sheet)
          Write the prolog of report.
 void removeProgressListener(ProgressListener listener)
          Remove a listener.
 void setDocumentInfo(DocumentInfo info)
          Set the document info to export.
 void startHeader(int type)
          Start a header section.
 void startHeader(String eid, boolean header)
          Start a header selection for element associated header/footer.
 void write(AreaBreakElement elem)
          Write the areabreak element.
 void write(BeanElement elem)
          Write the bean element.
 void write(ChartElement elem)
          Write the chart element.
 void write(CompositeElement elem)
          Write the composite element.
 void write(CondPageBreakElement elem)
          Write the conditional page break element.
 void write(FormElement elem)
          Write the form element.
 void write(HeadingElement elem)
          Write the heading text element.
 void write(NewlineElement elem)
          Write the newline element.
 void write(PageBreakElement elem)
          Write the pagebreak element.
 void write(PageLayoutElement elem)
          Write the page layout element.
 void write(PainterElement elem)
          Write the painter element.
 void write(ParameterElement elem)
          Write the parameter element.
 void write(ReportSheet sheet)
          Export a report.
 void write(SectionElement elem)
          Write the section element.
 void write(SeparatorElement elem)
          Write the separator element.
 void write(SpaceElement elem)
          Write the space element.
 void write(TabElement elem)
          Write the tab element.
 void write(TableElement elem)
          Write the table element.
 void write(TextBoxElement elem)
          Write the textbox element.
 void write(TextElement elem)
          Write the text element.
 void write(TOCElement elem)
          Write the TOC element.
 void write(inetsoft.report.style.XTableStyle style)
          Write embedded table style.
 

Method Detail

setDocumentInfo

void setDocumentInfo(DocumentInfo info)
Set the document info to export.


write

void write(ReportSheet sheet)
           throws IOException
Export a report.

Parameters:
sheet - report to export.
Throws:
IOException

prolog

void prolog(ReportSheet sheet)
Write the prolog of report.


startHeader

void startHeader(int type)
Start a header section.

Parameters:
type - header/footer type. Defined in ReportSheet.

startHeader

void startHeader(String eid,
                 boolean header)
Start a header selection for element associated header/footer.

Parameters:
eid - element ID.
header - true if header, false if footer.

endHeader

void endHeader()
End a header section.


write

void write(inetsoft.report.style.XTableStyle style)
Write embedded table style.


write

void write(TextElement elem)
Write the text element.


write

void write(HeadingElement elem)
Write the heading text element.


write

void write(TableElement elem)
Write the table element.


write

void write(SectionElement elem)
           throws IOException
Write the section element.

Throws:
IOException

write

void write(FormElement elem)
Write the form element.


write

void write(PainterElement elem)
Write the painter element.


write

void write(ChartElement elem)
Write the chart element.

Since:
10.1

write

void write(TextBoxElement elem)
Write the textbox element.


write

void write(TabElement elem)
Write the tab element.


write

void write(NewlineElement elem)
Write the newline element.


write

void write(AreaBreakElement elem)
Write the areabreak element.


write

void write(PageBreakElement elem)
Write the pagebreak element.


write

void write(PageLayoutElement elem)
           throws IOException
Write the page layout element.

Throws:
IOException

write

void write(CondPageBreakElement elem)
Write the conditional page break element.


write

void write(SpaceElement elem)
Write the space element.


write

void write(SeparatorElement elem)
Write the separator element.


write

void write(TOCElement elem)
           throws IOException
Write the TOC element.

Throws:
IOException

write

void write(ParameterElement elem)
           throws IOException
Write the parameter element.

Throws:
IOException

write

void write(CompositeElement elem)
           throws IOException
Write the composite element.

Throws:
IOException

write

void write(BeanElement elem)
           throws IOException
Write the bean element.

Throws:
IOException

end

void end()
         throws IOException
Write the end of report.

Throws:
IOException

addProgressListener

void addProgressListener(ProgressListener listener)
Add a listener to be notified of export progress.


removeProgressListener

void removeProgressListener(ProgressListener listener)
Remove a listener.


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.