ElegantJ PDF Library Java API Specification v1.1

com.elegantj.pdf
Class Catalog

java.lang.Object
  extended bycom.elegantj.pdf.PDFObject
      extended bycom.elegantj.pdf.Catalog

public class Catalog
extends PDFObject

The Catalog is a dictionary that is the root node of the document. It contains a reference to the tree of pages contained in the document, a reference to the tree of objects representing the documentís outline, etc.


Field Summary
static int FULLSCREEN
          This page mode indicates that when the document is opened, it is displayed in full-screen-mode.
static int USENONE
          This page mode indicates that the document should be opened just with the page visible
static int USEOUTLINES
          This page mode indicates that the Outlines should also be displayed when the document is opened
static int USETHUMBS
          This page mode indicates that the Thumbnails should be visible when the document first opens
 
Constructor Summary
Catalog(Pages pages, int pageMode)
          Constructs a Catalog object with specified pages and page mode
 
Method Summary
 void setOutlines(Outlines outlines)
          Method which sets the outline for the PDF document
 
Methods inherited from class com.elegantj.pdf.PDFObject
getPDFObjectID, getPDFObjectRefStr, getPDFObjectType, setPDFObjectID, setPDFObjectType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

USENONE

public static final int USENONE
This page mode indicates that the document should be opened just with the page visible

See Also:
Constant Field Values

USEOUTLINES

public static final int USEOUTLINES
This page mode indicates that the Outlines should also be displayed when the document is opened

See Also:
Constant Field Values

USETHUMBS

public static final int USETHUMBS
This page mode indicates that the Thumbnails should be visible when the document first opens

See Also:
Constant Field Values

FULLSCREEN

public static final int FULLSCREEN
This page mode indicates that when the document is opened, it is displayed in full-screen-mode. There is no menu bar, window controls nor any other window present.

See Also:
Constant Field Values
Constructor Detail

Catalog

public Catalog(Pages pages,
               int pageMode)
Constructs a Catalog object with specified pages and page mode

Parameters:
pages - The Pages object
Method Detail

setOutlines

public void setOutlines(Outlines outlines)
Method which sets the outline for the PDF document

Parameters:
outlines - The outline for the PDF document

ElegantJ PDF Library Java API Specification v1.1

For any feedback, suggestion, or query, please revert back to support@elegantjpdf.com

Copyright(c)
Elegant Microweb Technologies Pvt. Ltd.
www.elegantmicroweb.com
www.elegantjpdf.com
All Rights Reserved.