Style Intelligence v12.0

inetsoft.report.io
Class RTFFormatter

java.lang.Object
  extended by inetsoft.report.io.BaseFormatter
      extended by inetsoft.report.io.RTFFormatter
All Implemented Interfaces:
Formatter

Deprecated. 4.1

public class RTFFormatter
extends BaseFormatter

Formatter is responsible for converting report and report elements into an external format. RTFFormatter is deprecated. Please use RTFGenerator to create a RTF file instead.


Field Summary
protected  Vector centerV
          Deprecated.  
protected  int currAlign
          Deprecated.  
protected  Vector leftV
          Deprecated.  
protected  OutputStream output
          Deprecated.  
protected  Vector rightV
          Deprecated.  
protected  ReportSheet sheet
          Deprecated.  
protected  PrintWriter writer
          Deprecated.  
 
Fields inherited from class inetsoft.report.io.BaseFormatter
docInfo, report
 
Constructor Summary
RTFFormatter(OutputStream output)
          Deprecated. Create a report formatter.
 
Method Summary
protected  void addElement(ReportElement elem)
          Deprecated. Add element to the list.
 void end()
          Deprecated. Write the end of report.
protected  void endCell()
          Deprecated. End a cell.
protected  void endGrid()
          Deprecated. End the layout grid.
 void endHeader()
          Deprecated. End a header section.
protected  void endRow()
          Deprecated. End a row.
protected  void flushElements()
          Deprecated. Write out the buffered paragraphs.
protected  String getFontName(Font font)
          Deprecated. Get the real font name.
protected  String getLineProperty(int line)
          Deprecated. Get line style property string option.
protected  void init(ReportSheet report)
          Deprecated. Initialize the report.
 void prolog(ReportSheet sheetin)
          Deprecated. Write the prolog of report.
 void setPageSize(double width, double height)
          Deprecated. replaced by ReportSheet.setPageSize().
 void setPageSize(Size size)
          Deprecated. replaced by ReportSheet.setPageSize().
protected  void startCell(TabularSheet sheet, int r, int c, Object bg, Insets borders, Color bcolor, Rectangle span, String width, boolean repeat)
          Deprecated. Start a new cell.
protected  void startGrid(int rows, int cols)
          Deprecated. Start a layout grid (for tabular layout).
 void startHeader(int type)
          Deprecated. Start a header section.
 void startHeader(String eid, boolean header)
          Deprecated. Start a header selection for element associated header/footer.
protected  void startRow(TabularSheet sheet, int row)
          Deprecated. Start a new row.
 void write(AreaBreakElement elem)
          Deprecated. Write the areabreak element.
 void write(BeanElement elem)
          Deprecated. Write the bean element.
 void write(ChartElement elem)
          Deprecated. Write the chart element.
 void write(CompositeElement elem)
          Deprecated. Write the composite element.
 void write(CondPageBreakElement elem)
          Deprecated. Write the conditional page break element.
 void write(FormElement elem)
          Deprecated. Write the form element.
 void write(HeadingElement elem)
          Deprecated. Write the heading text element.
 void write(NewlineElement elem)
          Deprecated. Write the newline element.
protected  void write(OutputStream out, int val, int bytes)
          Deprecated. Write value in reverse byte order.
 void write(PageBreakElement elem)
          Deprecated. Write the pagebreak element.
 void write(PageLayoutElement elem)
          Deprecated. Write the page layout element.
 void write(PainterElement elem)
          Deprecated. Defer the writing of PainterElement to the left|center|right vector
 void write(ReportSheet sheet)
          Deprecated. Export a report.
 void write(SectionElement elem0)
          Deprecated. Write the section element.
 void write(SeparatorElement elem)
          Deprecated. Write the separator element.
 void write(SpaceElement elem)
          Deprecated. Write the space element.
 void write(TabElement elem)
          Deprecated. Write the tab element.
 void write(TableElement elem0)
          Deprecated. Write the table element.
 void write(TextBoxElement elem0)
          Deprecated. Write the textbox element.
 void write(TextElement elem0)
          Deprecated. Write the text element.
 void write(TOCElement elem)
          Deprecated. Write the TOC element.
 void write(inetsoft.report.style.XTableStyle style)
          Deprecated. Write embedded table style.
protected  void writeAlignment(int align)
          Deprecated. Write horizontal alignment option.
protected  void writeCell(Vector para, int align)
          Deprecated.  
protected  void writeColorTable(Color c)
          Deprecated. Write color table entry.
protected  String writeFont(Font font, boolean underline)
          Deprecated.  
 void writePainter(PainterElement elem0)
          Deprecated. Write the painter element.
protected  void writePainter(String hlink, Painter painter, Size size, Color fg, Color bg)
          Deprecated. Write a painter paragraph.
protected  void writePainter(String hlink, Painter painter, Size size, Color fg, Color bg, String target)
          Deprecated. Write a painter paragraph.
protected  void writeParagraph(String hlink, Object obj, Font font, Color fg, Color bg)
          Deprecated. Write text paragraph.
protected  void writeSectionBand(SectionBand band)
          Deprecated. Print one band.
protected  void writeShapes(PageLayout.Shape[] shapes)
          Deprecated. Write the pagelayout shapes specifications.
protected  void writeText(TextElement elem0)
          Deprecated. Write the text element.
protected  void writeWarnings(ReportElement elem, ReportSheet sheet)
          Deprecated. Write warning messages.
protected  void writeWrapSpace(Insets space)
          Deprecated. Write the painter external space.
 
Methods inherited from class inetsoft.report.io.BaseFormatter
addProgressListener, escape, fireProgressEvent, localize, removeProgressListener, setDocumentInfo, write, write, write, writeBeanPropertyDefinition, writeContents, writeContents, writeContents, writeElementContents, writeSection, writeWarnings
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

writer

protected PrintWriter writer
Deprecated. 

output

protected OutputStream output
Deprecated. 

sheet

protected ReportSheet sheet
Deprecated. 

leftV

protected Vector leftV
Deprecated. 

centerV

protected Vector centerV
Deprecated. 

rightV

protected Vector rightV
Deprecated. 

currAlign

protected int currAlign
Deprecated. 
Constructor Detail

RTFFormatter

public RTFFormatter(OutputStream output)
Deprecated. 
Create a report formatter.

Method Detail

setPageSize

public void setPageSize(double width,
                        double height)
Deprecated. replaced by ReportSheet.setPageSize().

Set the page size in inches.

Parameters:
width - page width.
height - page height.

setPageSize

public void setPageSize(Size size)
Deprecated. replaced by ReportSheet.setPageSize().

Set the page size in inches. Common paper sizes are defined as constants in StyleConstants.

Parameters:
size - Size object in inches.

startGrid

protected void startGrid(int rows,
                         int cols)
Deprecated. 
Start a layout grid (for tabular layout).

Specified by:
startGrid in class BaseFormatter
Parameters:
rows - number of rows.
cols - number of columns.

endGrid

protected void endGrid()
Deprecated. 
End the layout grid.

Specified by:
endGrid in class BaseFormatter

startRow

protected void startRow(TabularSheet sheet,
                        int row)
Deprecated. 
Start a new row.

Specified by:
startRow in class BaseFormatter
Parameters:
sheet - tabular report object.
row - row index in the grid.

endRow

protected void endRow()
Deprecated. 
End a row.

Specified by:
endRow in class BaseFormatter

startCell

protected void startCell(TabularSheet sheet,
                         int r,
                         int c,
                         Object bg,
                         Insets borders,
                         Color bcolor,
                         Rectangle span,
                         String width,
                         boolean repeat)
Deprecated. 
Start a new cell.

Specified by:
startCell in class BaseFormatter
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.

endCell

protected void endCell()
Deprecated. 
End a cell.

Specified by:
endCell in class BaseFormatter

writeShapes

protected void writeShapes(PageLayout.Shape[] shapes)
Deprecated. 
Write the pagelayout shapes specifications.

Specified by:
writeShapes in class BaseFormatter

init

protected void init(ReportSheet report)
Deprecated. 
Initialize the report.

Overrides:
init in class BaseFormatter

prolog

public void prolog(ReportSheet sheetin)
Deprecated. 
Write the prolog of report.


startHeader

public void startHeader(int type)
Deprecated. 
Start a header section.

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

write

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

Specified by:
write in interface Formatter
Overrides:
write in class BaseFormatter
Parameters:
sheet - report to export.
Throws:
IOException

startHeader

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

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

endHeader

public void endHeader()
Deprecated. 
End a header section.


write

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


write

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


write

public void write(TextElement elem0)
Deprecated. 
Write the text element.


writeText

protected void writeText(TextElement elem0)
Deprecated. 
Write the text element.


write

public void write(SectionElement elem0)
           throws IOException
Deprecated. 
Write the section element.

Throws:
IOException

writeSectionBand

protected void writeSectionBand(SectionBand band)
                         throws IOException
Deprecated. 
Print one band.

Specified by:
writeSectionBand in class BaseFormatter
Throws:
IOException

writeWarnings

protected void writeWarnings(ReportElement elem,
                             ReportSheet sheet)
Deprecated. 
Write warning messages.

Overrides:
writeWarnings in class BaseFormatter

write

public void write(TableElement elem0)
Deprecated. 
Write the table element.


write

public void write(FormElement elem)
Deprecated. 
Write the form element.


write

public void write(PainterElement elem)
Deprecated. 
Defer the writing of PainterElement to the left|center|right vector

Parameters:
elem -

writePainter

public void writePainter(PainterElement elem0)
Deprecated. 
Write the painter element.


write

public void write(ChartElement elem)
Deprecated. 
Write the chart element.


write

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

Throws:
IOException

write

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

Throws:
IOException

write

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

Throws:
IOException

write

public void write(TextBoxElement elem0)
Deprecated. 
Write the textbox element.


write

public void write(TabElement elem)
Deprecated. 
Write the tab element.


write

public void write(NewlineElement elem)
Deprecated. 
Write the newline element.


write

public void write(AreaBreakElement elem)
Deprecated. 
Write the areabreak element.


write

public void write(PageBreakElement elem)
Deprecated. 
Write the pagebreak element.


write

public void write(PageLayoutElement elem)
Deprecated. 
Write the page layout element.


write

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


write

public void write(SpaceElement elem)
Deprecated. 
Write the space element.


write

public void write(SeparatorElement elem)
Deprecated. 
Write the separator element.


end

public void end()
Deprecated. 
Write the end of report.

Specified by:
end in interface Formatter
Specified by:
end in class BaseFormatter

getFontName

protected String getFontName(Font font)
Deprecated. 
Get the real font name.


getLineProperty

protected String getLineProperty(int line)
Deprecated. 
Get line style property string option.


writeColorTable

protected void writeColorTable(Color c)
Deprecated. 
Write color table entry.


writeParagraph

protected void writeParagraph(String hlink,
                              Object obj,
                              Font font,
                              Color fg,
                              Color bg)
Deprecated. 
Write text paragraph.

Parameters:
hlink - the Hyperlink string, which can be a url or another report

writeFont

protected String writeFont(Font font,
                           boolean underline)
Deprecated. 

writeAlignment

protected void writeAlignment(int align)
Deprecated. 
Write horizontal alignment option.


writeWrapSpace

protected void writeWrapSpace(Insets space)
Deprecated. 
Write the painter external space.


writePainter

protected void writePainter(String hlink,
                            Painter painter,
                            Size size,
                            Color fg,
                            Color bg)
Deprecated. 
Write a painter paragraph.

Parameters:
hlink - the Hyperlink string, which can be a url or another report

writePainter

protected void writePainter(String hlink,
                            Painter painter,
                            Size size,
                            Color fg,
                            Color bg,
                            String target)
Deprecated. 
Write a painter paragraph.

Parameters:
hlink - the Hyperlink string, which can be a url or another report

write

protected void write(OutputStream out,
                     int val,
                     int bytes)
Deprecated. 
Write value in reverse byte order.


flushElements

protected void flushElements()
Deprecated. 
Write out the buffered paragraphs.


writeCell

protected void writeCell(Vector para,
                         int align)
Deprecated. 

addElement

protected void addElement(ReportElement elem)
Deprecated. 
Add element to the list.


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