Style Intelligence v12.0

inetsoft.report.pdf
Interface PDFDevice

All Superinterfaces:
Cloneable, inetsoft.report.internal.CustomGraphics, PrintGraphics, Serializable
All Known Implementing Classes:
PDF3Printer, PDF4Printer, PDF8Printer, PDFPrinter

public interface PDFDevice
extends PrintGraphics, Serializable, Cloneable, inetsoft.report.internal.CustomGraphics

PDFDevice defines the common API for all pdf generation classes.


Field Summary
 
Fields inherited from interface inetsoft.report.internal.CustomGraphics
G_DASH_LINE, JPEG_EXPORT
 
Method Summary
 boolean addField(inetsoft.report.internal.FieldPainterPaintable pt)
          Add a field to the current pdf document.
 void close()
          Close the pdf output stream.
 void endArtifact()
          Marks the end of a non-content artifact.
 void endFigure()
          Marks the end of a figure.
 void endHeading()
          Marks the end of a heading.
 void endParagraph()
          Marks the end of a paragraph of text.
 void endTable()
          Marks the end of a table.
 void endTableCell()
          Marks the end of a table data cell.
 void endTableHeader()
          Marks the end of a table header cell.
 String getFontName(Font font)
          Get the pdf font name corresponding to the Java font name.
 Size getPageSize()
          Get the current page size.
 PrintJob getPrintJob()
          Get the printjob object associated with this object, which contains the page size and resolution information.
 boolean isAsciiOnly()
          Check if the output is ascii only.
 boolean isCompressImage()
          Check if compression is on.
 boolean isCompressText()
          Check if compression is on.
 boolean isMapSymbols()
          Check if symbol mapping is enabled.
 void putFontName(String javaName, String psFontName)
          Add the mapping for the pdf font name corresponding to the Java font name.
 void setAsciiOnly(boolean ascii)
          Set whether the output should only contain 7 bits ascii code only.
 void setCompressImage(boolean comp)
          Set whether to compress the image object and streams in the PDF.
 void setCompressText(boolean comp)
          Set whether to compress the text object and streams in the PDF.
 void setMapSymbols(boolean map)
          Set whether to map unicode characters for greek and math symbols to symbol font characters.
 void setOrientation(int orient)
          Set page orientation.
 void setOutput(OutputStream o)
          Set the output stream for the PDF output.
 void setPageSize(Size size)
          Set the page size in inches.
 void startArtifact()
          Marks the start of a non-content artifact.
 void startFigure(String altText)
          Marks the beginning of a figure.
 void startHeading(int level)
          Marks the start of a heading.
 void startParagraph(Integer linkId)
          Marks the beginning of a paragraph of text.
 void startTable()
          Marks the beginning of a table.
 void startTableCell(Integer linkId)
          Marks the beginning of a table data cell.
 void startTableHeader(Integer linkId)
          Marks the beginning of a table header cell.
 void startTableRow()
          Marks the beginning of a table row.
 
Methods inherited from interface inetsoft.report.internal.CustomGraphics
isSupported
 

Method Detail

setOutput

void setOutput(OutputStream o)
Set the output stream for the PDF output.


setCompressText

void setCompressText(boolean comp)
Set whether to compress the text object and streams in the PDF. Currently only Zip compression is supported, as the consequence the output is only compatible with Acrobat 3.0 and later versions. By default this is true.

Parameters:
comp - compression option.

isCompressText

boolean isCompressText()
Check if compression is on.

Returns:
true if text objects are compressed.

setAsciiOnly

void setAsciiOnly(boolean ascii)
Set whether the output should only contain 7 bits ascii code only. It defaults to false.

Parameters:
ascii - output ascii only.

isAsciiOnly

boolean isAsciiOnly()
Check if the output is ascii only.

Returns:
true if ascii only.

setCompressImage

void setCompressImage(boolean comp)
Set whether to compress the image object and streams in the PDF. Currently only Zip compression is supported, as the consequence the output is only compatible with Acrobat 3.0 and later versions. By default this is true.

Parameters:
comp - compression option.

isCompressImage

boolean isCompressImage()
Check if compression is on.

Returns:
true if image objects are compressed.

setMapSymbols

void setMapSymbols(boolean map)
Set whether to map unicode characters for greek and math symbols to symbol font characters.


isMapSymbols

boolean isMapSymbols()
Check if symbol mapping is enabled.


getPageSize

Size getPageSize()
Get the current page size.


setPageSize

void setPageSize(Size size)
Set the page size in inches. Common paper sizes are defined as constants in StyleConstants.

Parameters:
size - Size object in inches.

setOrientation

void setOrientation(int orient)
Set page orientation.

Specified by:
setOrientation in interface inetsoft.report.internal.CustomGraphics
Parameters:
orient - orientation, StyleConstants.PORTRAIT or StyleConstants.LANDSCAPE.

getFontName

String getFontName(Font font)
Get the pdf font name corresponding to the Java font name.

Parameters:
font - Java font.
Returns:
pdf font name.

putFontName

void putFontName(String javaName,
                 String psFontName)
Add the mapping for the pdf font name corresponding to the Java font name.

Parameters:
javaName - Java font name.
psFontName - mapped font name.

getPrintJob

PrintJob getPrintJob()
Get the printjob object associated with this object, which contains the page size and resolution information.

Specified by:
getPrintJob in interface PrintGraphics
Returns:
print job object.

addField

boolean addField(inetsoft.report.internal.FieldPainterPaintable pt)
Add a field to the current pdf document.

Returns:
true if field is supported, false if the field is not supported and should be rendered as usual.

close

void close()
Close the pdf output stream. This MUST be called to complete the file.


startParagraph

void startParagraph(Integer linkId)
Marks the beginning of a paragraph of text. This method has no effect if an accessible PDF is not being generated.

Parameters:
linkId - the identifier of the link annotation associated with the paragraph.
Since:
11.4

endParagraph

void endParagraph()
Marks the end of a paragraph of text. This method has no effect if an accessible PDF is not being generated.

Since:
11.4

startHeading

void startHeading(int level)
Marks the start of a heading. This method has no effect if an accessible PDF is not being generated.

Parameters:
level - the heading level.
Since:
11.4

endHeading

void endHeading()
Marks the end of a heading. This method has no effect if an accessible PDF is not being generated.

Since:
11.4

startFigure

void startFigure(String altText)
Marks the beginning of a figure. This method has no effect if an accessible PDF is not being generated.

Parameters:
altText - the alternate text for the chart graphic.
Since:
11.4

endFigure

void endFigure()
Marks the end of a figure. This method has no effect if an accessible PDF is not being generated.

Since:
11.4

startTable

void startTable()
Marks the beginning of a table. This method has no effect if an accessible PDF is not being generated.

Since:
11.4

endTable

void endTable()
Marks the end of a table. This method has no effect if an accessible PDF is not being generated.

Since:
11.4

startTableRow

void startTableRow()
Marks the beginning of a table row. This method has no effect if an accessible PDF is not being generated.

Since:
11.4

startTableHeader

void startTableHeader(Integer linkId)
Marks the beginning of a table header cell. This method has no effect if an accessible PDF is not being generated.

Parameters:
linkId - the identifier of the link annotation associated with the paragraph.
Since:
11.4

endTableHeader

void endTableHeader()
Marks the end of a table header cell. This method has no effect if an accessible PDF is not being generated.

Since:
11.4

startTableCell

void startTableCell(Integer linkId)
Marks the beginning of a table data cell. This method has no effect if an accessible PDF is not being generated.

Parameters:
linkId - the identifier of the link annotation associated with the paragraph.
Since:
11.4

endTableCell

void endTableCell()
Marks the end of a table data cell. This method has no effect if an accessible PDF is not being generated.

Since:
11.4

startArtifact

void startArtifact()
Marks the start of a non-content artifact. This method has no effect if an accessible PDF is not being generated.

Since:
11.4

endArtifact

void endArtifact()
Marks the end of a non-content artifact. This method has no effect if an accessible PDF is not being generated.

Since:
11.4

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