public class PDFRoot extends PDFDictionary
| Modifier and Type | Field and Description |
|---|---|
static int |
PAGEMODE_FULLSCREEN
Full screen page mode
|
static int |
PAGEMODE_USENONE
Use no page mode setting, default
|
static int |
PAGEMODE_USEOUTLINES
Use outlines page mode to show bookmarks
|
static int |
PAGEMODE_USETHUMBS
Use thumbs page mode to show thumbnail images
|
entries, order| Constructor and Description |
|---|
PDFRoot(PDFDocument document,
PDFPages pages)
create a Root (/Catalog) object.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addAF(PDFFileSpec fileSpec) |
void |
addOutputIntent(PDFOutputIntent outputIntent)
Adds an OutputIntent to the PDF
|
void |
addPage(PDFPage page)
add a /Page object to the root /Pages object
|
PDFDPartRoot |
getDPartRoot() |
String |
getLanguage()
Returns the language identifier of the document.
|
PDFDictionary |
getMarkInfo()
Returns the MarkInfo dictionary.
|
PDFMetadata |
getMetadata()
Returns the /Metadata object
|
PDFNames |
getNames()
Returns the /Names object.
|
PDFArray |
getOutputIntents()
Returns the /OutputIntents array.
|
PDFPageLabels |
getPageLabels()
Returns the /PageLabels object.
|
int |
getPageMode()
Returns the currently active /PageMode.
|
PDFOutline |
getRootOutline()
Get the root PDF outline for the document.
|
PDFPages |
getRootPages()
Returns the /PageLabels object.
|
PDFStructTreeRoot |
getStructTreeRoot()
Returns the StructTreeRoot object.
|
void |
makeTagged()
Marks this document as conforming to the Tagged PDF conventions.
|
int |
output(OutputStream stream)
Write the PDF represention of this object
|
void |
setLanguage(Locale locale)
Sets the locale of the document.
|
void |
setMetadata(PDFMetadata meta)
Set the optional Metadata object.
|
void |
setNames(PDFNames names)
Set the /Names object.
|
void |
setPageLabels(PDFPageLabels pageLabels)
Sets the /PageLabels object.
|
void |
setPageMode(int mode)
Set the page mode for the PDF document.
|
void |
setRootOutline(PDFOutline out)
Set the root outline for the PDF document.
|
void |
setRootPages(PDFPages pages)
set the root /Pages object
|
void |
setStructTreeRoot(PDFStructTreeRoot structTreeRoot)
Sets the StructTreeRoot object.
|
containsKey, get, getChildren, getChildren, keySet, put, put, remove, writeDictionarycontentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, outputInline, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, toPDF, toPDFStringpublic static final int PAGEMODE_USENONE
public static final int PAGEMODE_USEOUTLINES
public static final int PAGEMODE_USETHUMBS
public static final int PAGEMODE_FULLSCREEN
public PDFRoot(PDFDocument document, PDFPages pages)
document - TODOpages - the PDFPages objectpublic int output(OutputStream stream) throws IOException
output in class PDFDictionarystream - the stream to write the PDF toIOException - if there is an error writing to the streampublic void setPageMode(int mode)
mode - the page mode (one of PAGEMODE_*)public int getPageMode()
public void addPage(PDFPage page)
page - the /Page object to addpublic void setRootPages(PDFPages pages)
pages - the /Pages object to set as rootpublic PDFPages getRootPages()
public void setPageLabels(PDFPageLabels pageLabels)
pageLabels - the /PageLabels objectpublic PDFPageLabels getPageLabels()
public void setRootOutline(PDFOutline out)
out - the root PDF Outlinepublic PDFOutline getRootOutline()
public void setNames(PDFNames names)
names - the Names objectpublic PDFNames getNames()
public void setMetadata(PDFMetadata meta)
meta - the Metadata objectpublic PDFMetadata getMetadata()
public PDFArray getOutputIntents()
public void addOutputIntent(PDFOutputIntent outputIntent)
outputIntent - the OutputIntent dictionarypublic String getLanguage()
public void setLanguage(Locale locale)
locale - the locale of the document.public void setStructTreeRoot(PDFStructTreeRoot structTreeRoot)
structTreeRoot - of this documentpublic PDFStructTreeRoot getStructTreeRoot()
public void makeTagged()
public PDFDictionary getMarkInfo()
public PDFDPartRoot getDPartRoot()
public void addAF(PDFFileSpec fileSpec)
Copyright © 2023 Apache Software Foundation. All rights reserved.