Java Doc for PDDocumentCatalog.java in  » PDF » PDFBox-0.7.3 » org » pdfbox » pdmodel » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » PDF » PDFBox 0.7.3 » org.pdfbox.pdmodel   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.pdfbox.pdmodel.PDDocumentCatalog PDDocumentCatalog public class PDDocumentCatalog implements COSObjectable(Code) This class represents the acroform of a PDF document. author:    Ben Litchfield version:    $Revision: 1.21 $ Field Summary final public static  String PAGE_LAYOUT_ONE_COLUMN      Display the pages in one column. final public static  String PAGE_LAYOUT_SINGLE_PAGE      Display one page at a time. final public static  String PAGE_LAYOUT_TWO_COLUMN_LEFT      Display the pages in two columns, with odd numbered pagse on the left. final public static  String PAGE_LAYOUT_TWO_COLUMN_RIGHT      Display the pages in two columns, with odd numbered pagse on the right. final public static  String PAGE_LAYOUT_TWO_PAGE_LEFT      Display the pages two at a time, with odd-numbered pages on the left. final public static  String PAGE_LAYOUT_TWO_PAGE_RIGHT      Display the pages two at a time, with odd-numbered pages on the right. final public static  String PAGE_MODE_FULL_SCREEN      Full screen mode with no menu bar, window controls. final public static  String PAGE_MODE_USE_ATTACHMENTS      Attachments panel is visible. final public static  String PAGE_MODE_USE_NONE      Page mode where neither the outline nor the thumbnails are displayed. final public static  String PAGE_MODE_USE_OPTIONAL_CONTENT      Optional content group panel is visible when opened. final public static  String PAGE_MODE_USE_OUTLINES      Show bookmarks when pdf is opened. final public static  String PAGE_MODE_USE_THUMBS      Show thumbnails when pdf is opened. Constructor Summary public   PDDocumentCatalog(PDDocument doc)      Constructor. public   PDDocumentCatalog(PDDocument doc, COSDictionary rootDictionary)      Constructor. Method Summary public  PDAcroForm getAcroForm()      This will get the documents acroform. public  PDDocumentCatalogAdditionalActions getActions()      public  List getAllPages()      The PDF document contains a hierarchical structure of PDPageNode and PDPages, which is mostly just a way to store this information. public  COSDictionary getCOSDictionary()      Convert this standard java object to a COS object. public  COSBase getCOSObject()      Convert this standard java object to a COS object. public  PDDocumentOutline getDocumentOutline()      Get the outline associated with this document or null if it does not exist. public  String getLanguage()      The language for the document. public  PDMarkInfo getMarkInfo()      Get info about doc's usage of tagged features. public  PDMetadata getMetadata()      Get the metadata that is part of the document catalog. public  PDDocumentNameDictionary getNames()      public  PDDestinationOrAction getOpenAction()      Get the Document Open Action for this object. public  String getPageLayout()      Set the page layout, see the PAGE_LAYOUT_XXX constants. public  String getPageMode()      Set the page display mode, see the PAGE_MODE_XXX constants. public  PDPageNode getPages()      This will get the root node for the pages. public  PDStructureTreeRoot getStructureTreeRoot()      Get the document's structure tree root. public  List getThreads()      Get the list threads for this pdf document. public  PDActionURI getURI()      Document level information in the URI. public  PDViewerPreferences getViewerPreferences()      Get the viewer preferences associated with this document or null if they do not exist. public  void setAcroForm(PDAcroForm acro)      Set the acro form for this catalog. public  void setActions(PDDocumentCatalogAdditionalActions actions)      Set the additional actions for the document. public  void setDocumentOutline(PDDocumentOutline outlines)      Set the document outlines. public  void setLanguage(String language)      Set the Language for the document. public  void setMarkInfo(PDMarkInfo markInfo)      Set information about the doc's usage of tagged features. public  void setMetadata(PDMetadata meta)      Set the metadata for this object. public  void setNames(PDDocumentNameDictionary names)      Set the names dictionary for the document. public  void setOpenAction(PDDestinationOrAction action)      Set the Document Open Action for this object. public  void setPageLayout(String layout)      Set the page layout. public  void setPageMode(String mode)      Set the page mode. public  void setStructureTreeRoot(PDStructureTreeRoot treeRoot)      Set the document's structure tree root. public  void setThreads(List threads)      Set the list of threads for this pdf document. public  void setURI(PDActionURI uri)      Set the document level uri. public  void setViewerPreferences(PDViewerPreferences prefs)      Set the viewer preferences. Field Detail PAGE_LAYOUT_ONE_COLUMN final public static String PAGE_LAYOUT_ONE_COLUMN(Code) Display the pages in one column. PAGE_LAYOUT_SINGLE_PAGE final public static String PAGE_LAYOUT_SINGLE_PAGE(Code) Display one page at a time. PAGE_LAYOUT_TWO_COLUMN_LEFT final public static String PAGE_LAYOUT_TWO_COLUMN_LEFT(Code) Display the pages in two columns, with odd numbered pagse on the left. PAGE_LAYOUT_TWO_COLUMN_RIGHT final public static String PAGE_LAYOUT_TWO_COLUMN_RIGHT(Code) Display the pages in two columns, with odd numbered pagse on the right. PAGE_LAYOUT_TWO_PAGE_LEFT final public static String PAGE_LAYOUT_TWO_PAGE_LEFT(Code) Display the pages two at a time, with odd-numbered pages on the left. since:    PDF Version 1.5 PAGE_LAYOUT_TWO_PAGE_RIGHT final public static String PAGE_LAYOUT_TWO_PAGE_RIGHT(Code) Display the pages two at a time, with odd-numbered pages on the right. since:    PDF Version 1.5 PAGE_MODE_FULL_SCREEN final public static String PAGE_MODE_FULL_SCREEN(Code) Full screen mode with no menu bar, window controls. PAGE_MODE_USE_ATTACHMENTS final public static String PAGE_MODE_USE_ATTACHMENTS(Code) Attachments panel is visible. PAGE_MODE_USE_NONE final public static String PAGE_MODE_USE_NONE(Code) Page mode where neither the outline nor the thumbnails are displayed. PAGE_MODE_USE_OPTIONAL_CONTENT final public static String PAGE_MODE_USE_OPTIONAL_CONTENT(Code) Optional content group panel is visible when opened. PAGE_MODE_USE_OUTLINES final public static String PAGE_MODE_USE_OUTLINES(Code) Show bookmarks when pdf is opened. PAGE_MODE_USE_THUMBS final public static String PAGE_MODE_USE_THUMBS(Code) Show thumbnails when pdf is opened. Constructor Detail PDDocumentCatalog public PDDocumentCatalog(PDDocument doc)(Code) Constructor. Parameters:   doc - The document that this catalog is part of. PDDocumentCatalog public PDDocumentCatalog(PDDocument doc, COSDictionary rootDictionary)(Code) Constructor. Parameters:   doc - The document that this catalog is part of. Parameters:   rootDictionary - The root dictionary that this object wraps. Method Detail getAcroForm public PDAcroForm getAcroForm()(Code) This will get the documents acroform. This will return null if no acroform is part of the document. The documents acroform. getActions public PDDocumentCatalogAdditionalActions getActions()(Code) The Additional Actions for this Document getAllPages public List getAllPages()(Code) The PDF document contains a hierarchical structure of PDPageNode and PDPages, which is mostly just a way to store this information. This method will return a flat list of all PDPage objects in this document. A list of PDPage objects. getCOSDictionary public COSDictionary getCOSDictionary()(Code) Convert this standard java object to a COS object. The cos object that matches this Java object. getCOSObject public COSBase getCOSObject()(Code) Convert this standard java object to a COS object. The cos object that matches this Java object. getDocumentOutline public PDDocumentOutline getDocumentOutline()(Code) Get the outline associated with this document or null if it does not exist. The document's outline. getLanguage public String getLanguage()(Code) The language for the document. The language for the document. getMarkInfo public PDMarkInfo getMarkInfo()(Code) Get info about doc's usage of tagged features. This will return null if there is no information. The new mark info. getMetadata public PDMetadata getMetadata()(Code) Get the metadata that is part of the document catalog. This will return null if there is no meta data for this object. The metadata for this object. getNames public PDDocumentNameDictionary getNames()(Code) The names dictionary for this document or null if none exist. getOpenAction public PDDestinationOrAction getOpenAction() throws IOException(Code) Get the Document Open Action for this object. The action to perform when the document is opened. throws:   IOException - If there is an error creating the destinationor action. getPageLayout public String getPageLayout()(Code) Set the page layout, see the PAGE_LAYOUT_XXX constants. A string representing the page layout. getPageMode public String getPageMode()(Code) Set the page display mode, see the PAGE_MODE_XXX constants. A string representing the page mode. getPages public PDPageNode getPages()(Code) This will get the root node for the pages. The parent page node. getStructureTreeRoot public PDStructureTreeRoot getStructureTreeRoot()(Code) Get the document's structure tree root. The document's structure tree root or null if none exists. getThreads public List getThreads()(Code) Get the list threads for this pdf document. A list of PDThread objects. getURI public PDActionURI getURI()(Code) Document level information in the URI. Document level URI. getViewerPreferences public PDViewerPreferences getViewerPreferences()(Code) Get the viewer preferences associated with this document or null if they do not exist. The document's viewer preferences. setAcroForm public void setAcroForm(PDAcroForm acro)(Code) Set the acro form for this catalog. Parameters:   acro - The new acro form. setActions public void setActions(PDDocumentCatalogAdditionalActions actions)(Code) Set the additional actions for the document. Parameters:   actions - The actions that are associated with this document. setDocumentOutline public void setDocumentOutline(PDDocumentOutline outlines)(Code) Set the document outlines. Parameters:   outlines - The new document outlines. setLanguage public void setLanguage(String language)(Code) Set the Language for the document. Parameters:   language - The new document language. setMarkInfo public void setMarkInfo(PDMarkInfo markInfo)(Code) Set information about the doc's usage of tagged features. Parameters:   markInfo - The new MarkInfo data. setMetadata public void setMetadata(PDMetadata meta)(Code) Set the metadata for this object. This can be null. Parameters:   meta - The meta data for this object. setNames public void setNames(PDDocumentNameDictionary names)(Code) Set the names dictionary for the document. Parameters:   names - The names dictionary that is associated with this document. setOpenAction public void setOpenAction(PDDestinationOrAction action)(Code) Set the Document Open Action for this object. Parameters:   action - The action you want to perform. setPageLayout public void setPageLayout(String layout)(Code) Set the page layout. See the PAGE_LAYOUT_XXX constants for valid values. Parameters:   layout - The new page layout. setPageMode public void setPageMode(String mode)(Code) Set the page mode. See the PAGE_MODE_XXX constants for valid values. Parameters:   mode - The new page mode. setStructureTreeRoot public void setStructureTreeRoot(PDStructureTreeRoot treeRoot)(Code) Set the document's structure tree root. Parameters:   treeRoot - The new structure tree. setThreads public void setThreads(List threads)(Code) Set the list of threads for this pdf document. Parameters:   threads - The list of threads, or null to clear it. setURI public void setURI(PDActionURI uri)(Code) Set the document level uri. Parameters:   uri - The new document level uri. setViewerPreferences public void setViewerPreferences(PDViewerPreferences prefs)(Code) Set the viewer preferences. Parameters:   prefs - The new viewer preferences. Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)