Style Intelligence v12.0

inetsoft.report.pdf
Class PDF3Generator

java.lang.Object
  extended by inetsoft.report.io.AbstractGenerator
      extended by inetsoft.report.pdf.PDF3Generator
All Implemented Interfaces:
Generator
Direct Known Subclasses:
PDF4Generator

public class PDF3Generator
extends AbstractGenerator

PDF3Generator is a PDF generator that supports generation of Table Of Contents bookmarks in PDF. This class should not be created directly. Call getPDFGenerator() method to get an instance of this class.


Field Summary
 
Fields inherited from class inetsoft.report.io.AbstractGenerator
docInfo
 
Constructor Summary
PDF3Generator()
          Create a generator.
PDF3Generator(OutputStream out)
          Create a generator to the specified output.
 
Method Summary
 void cancel()
          Cancel the generation if one if on going.
 void generate(Enumeration pages)
          Generate PDF file from a collection of StylePage objects.
 void generate(ReportSheet report)
          Generate PDF file.
 void generate(ReportSheet sheet, Enumeration pages)
          Write a collection of pages to text.
 void generate(Vector pages)
          Generate PDF file.
protected  Graphics getGraphics()
          Get the graphics object for a new page.
protected  Dimension getPageDimension()
          Get the graphics object for a new page.
 Size getPageSize()
          Get the output page size.
static PDF3Generator getPDFGenerator(OutputStream output)
          Get an instance of a PDF generator.
 PDF3Printer getPrinter()
          Get the PDF3Printer used inside this generator.
 boolean isAccessible()
          Gets the flag that determines if an accessible PDF file is generated.
 boolean isPrintOnOpen()
          Determines if the print dialog should be displayed when the generated PDF is opened.
 boolean isSelectiveBookmarks()
          Indicates whether selective bookmarking is turned on
 void setAccessible(boolean accessible)
          Sets the flag that determines if an accessible PDF file is generated.
 void setPageSize(Size pgsize)
          Set the output page size.
 void setPrintOnOpen(boolean printOnOpen)
          Sets whether the print dialog should be displayed when the generated PDF is opened.
 void setReportID(String id)
          Sets the print report ID when the generated PDF is opened.
 void setSelectiveBookmarks(boolean selectiveBookmarks)
           
 
Methods inherited from class inetsoft.report.io.AbstractGenerator
addProgressListener, fireProgressEvent, getCachePages, getOutput, getReportCache, getReportId, removeProgressListener, setDocumentInfo, setOutput, setReportCache, setReportId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PDF3Generator

public PDF3Generator()
Create a generator. The setOutput() method must be called before generating the PDF.


PDF3Generator

public PDF3Generator(OutputStream out)
Create a generator to the specified output.

Method Detail

getPDFGenerator

public static PDF3Generator getPDFGenerator(OutputStream output)
Get an instance of a PDF generator.


generate

public void generate(ReportSheet sheet,
                     Enumeration pages)
              throws IOException
Write a collection of pages to text.

Throws:
IOException

generate

public void generate(Vector pages)
Generate PDF file.

Parameters:
pages - report pages, StylePage.

generate

public void generate(ReportSheet report)
Generate PDF file.

Parameters:
report - report object.

generate

public void generate(Enumeration pages)
Generate PDF file from a collection of StylePage objects.


cancel

public void cancel()
Cancel the generation if one if on going.


getPrinter

public PDF3Printer getPrinter()
Get the PDF3Printer used inside this generator.


getGraphics

protected Graphics getGraphics()
Get the graphics object for a new page.


getPageDimension

protected Dimension getPageDimension()
Get the graphics object for a new page.


setPageSize

public void setPageSize(Size pgsize)
Set the output page size.

Parameters:
pgsize - page size in inches.

getPageSize

public Size getPageSize()
Get the output page size.


setSelectiveBookmarks

public void setSelectiveBookmarks(boolean selectiveBookmarks)

isSelectiveBookmarks

public boolean isSelectiveBookmarks()
Indicates whether selective bookmarking is turned on


setPrintOnOpen

public void setPrintOnOpen(boolean printOnOpen)
Sets whether the print dialog should be displayed when the generated PDF is opened.

Parameters:
printOnOpen - true to print when opened.

setReportID

public void setReportID(String id)
Sets the print report ID when the generated PDF is opened.

Parameters:
id - to print when opened.

isPrintOnOpen

public boolean isPrintOnOpen()
Determines if the print dialog should be displayed when the generated PDF is opened.

Returns:
true to print when opened.

isAccessible

public boolean isAccessible()
Gets the flag that determines if an accessible PDF file is generated. By default, this option is disabled.

Accessible PDF files will be larger and may take longer to generate.

Returns:
true to generate an accessible PDF; false otherwise.

setAccessible

public void setAccessible(boolean accessible)
Sets the flag that determines if an accessible PDF file is generated. By default, this option is disabled.

Accessible PDF files will be larger and may take longer to generate.

Parameters:
accessible - true to generate an accessible PDF; false otherwise.

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