it.stefanochizzolini.clown.documents
Class Document

java.lang.Object
  it.stefanochizzolini.clown.objects.PdfObjectWrapper<PdfDictionary>
      it.stefanochizzolini.clown.documents.Document

public class Document
extends PdfObjectWrapper<PdfDictionary>

PDF document [PDF:1.6:3.6.1].

Version:

0.0.8

Author:

Stefano Chizzolini (http://www.stefanochizzolini.it)

Field Summary

Hashtable<PdfReference,Object>

cache For internal use only.

Constructor Summary

Document(File context)
For internal use only.

Document(PdfDirectObject baseObject)
For internal use only.

Method Summary

Document	clone(Document context) Gets a clone of the object, registered inside the given document context.
Collection<? extends PdfObjectWrapper<?>>	contextualize(Collection<? extends PdfObjectWrapper<?>> objects) Clones the collection's objects within this document context.
Object	contextualize(PdfObjectWrapper<?> object) Clones the object within this document context.
void	decontextualize(Collection<? extends PdfObjectWrapper<?>> objects) Drops the collection's objects from this document context.
void	decontextualize(PdfObjectWrapper<?> object) Drops the object from this document context.
DocumentActions	getActions() Gets the document's behavior in response to trigger events.
Bookmarks	getBookmarks() Gets the bookmark collection [PDF:1.6:8.2.2].
Form	getForm() Gets the interactive form (AcroForm) [PDF:1.6:8.6.1].
Information	getInformation() Gets the document information dictionary [PDF:1.6:10.2.1].
Names	getNames() Gets the name dictionary [PDF:1.6:3.6.3].
PageLayoutEnum	getPageLayout() Gets the page layout to be used when the document is opened.
PageModeEnum	getPageMode() Gets the page mode, that is how the document should be displayed when is opened.
Pages	getPages() Gets the page collection [PDF:1.6:3.6.2].
Dimension2D	getPageSize() Gets the default page size [PDF:1.6:3.6.2].
Resources	getResources() Gets the default resource collection [PDF:1.6:3.6.2].
Dimension2D	getSize() Gets the document size, that is the maximum page dimensions across the whole document.
String	getVersion() Gets the version of the PDF specification to which the document conforms [PDF:1.6:3.6.1].
ViewerPreferences	getViewerPreferences() Gets the way the document is to be presented [PDF:1.6:8.1].
static <T extends PdfObjectWrapper<?>> T	resolve(Class<T> type, PdfDirectObject baseObject, PdfIndirectObject container)
static <T extends PdfObjectWrapper<?>> T	resolveName(Class<T> type, PdfDirectObject namedBaseObject, PdfIndirectObject container) Forces a named base object to be expressed as its corresponding high-level representation.
void	setActions(DocumentActions value)
void	setBookmarks(Bookmarks value)
void	setForm(Form value)
void	setInformation(Information value)
void	setNames(Names value)
void	setPageLayout(PageLayoutEnum value)
void	setPageMode(PageModeEnum value)
void	setPages(Pages value)
void	setPageSize(Dimension2D value)
void	setResources(Resources value)
void	setVersion(String value)
void	setViewerPreferences(ViewerPreferences value)

Methods inherited from class it.stefanochizzolini.clown.objects.PdfObjectWrapper

delete, getBaseDataObject, getBaseObject, getContainer, getDocument, getFile, setBaseObject, setContainer, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cache

public Hashtable<PdfReference,Object> cache

For internal use only.

Constructor Detail

Document

public Document(File context)

For internal use only.

Document

public Document(PdfDirectObject baseObject)

For internal use only.

Method Detail

resolve

public static <T extends PdfObjectWrapper<?>> T resolve(Class<T> type,
                                                        PdfDirectObject baseObject,
                                                        PdfIndirectObject container)

resolveName

public static <T extends PdfObjectWrapper<?>> T resolveName(Class<T> type,
                                                            PdfDirectObject namedBaseObject,
                                                            PdfIndirectObject container)

Forces a named base object to be expressed as its corresponding high-level representation.

clone

public Document clone(Document context)

Description copied from class: PdfObjectWrapper

Gets a clone of the object, registered inside the given document context.

Specified by:

clone in class PdfObjectWrapper<PdfDictionary>

Parameters:

context - Which document the clone has to be registered in.

contextualize

public Object contextualize(PdfObjectWrapper<?> object)

Clones the object within this document context.

contextualize

public Collection<? extends PdfObjectWrapper<?>> contextualize(Collection<? extends PdfObjectWrapper<?>> objects)

Clones the collection's objects within this document context.

decontextualize

public void decontextualize(PdfObjectWrapper<?> object)

Drops the object from this document context.

decontextualize

public void decontextualize(Collection<? extends PdfObjectWrapper<?>> objects)

Drops the collection's objects from this document context.

getActions

public DocumentActions getActions()

Gets the document's behavior in response to trigger events.

Since:

0.0.7

getBookmarks

public Bookmarks getBookmarks()

Gets the bookmark collection [PDF:1.6:8.2.2].

getForm

public Form getForm()

Gets the interactive form (AcroForm) [PDF:1.6:8.6.1].

Since:

0.0.7

getInformation

public Information getInformation()

Gets the document information dictionary [PDF:1.6:10.2.1].

getNames

public Names getNames()

Gets the name dictionary [PDF:1.6:3.6.3].

getPageLayout

public PageLayoutEnum getPageLayout()

Gets the page layout to be used when the document is opened.

getPageMode

public PageModeEnum getPageMode()

Gets the page mode, that is how the document should be displayed when is opened.

getPages

public Pages getPages()

Gets the page collection [PDF:1.6:3.6.2].

getPageSize

public Dimension2D getPageSize()

Gets the default page size [PDF:1.6:3.6.2].

getResources

public Resources getResources()

Gets the default resource collection [PDF:1.6:3.6.2].

Remarks

The default resource collection is used as last resort by every page that doesn't reference one explicitly (and doesn't reference an intermediate one implicitly).

getSize

public Dimension2D getSize()

Gets the document size, that is the maximum page dimensions across the whole document.

getVersion

public String getVersion()

Gets the version of the PDF specification to which the document conforms [PDF:1.6:3.6.1].

getViewerPreferences

public ViewerPreferences getViewerPreferences()

Gets the way the document is to be presented [PDF:1.6:8.1].

setActions

public void setActions(DocumentActions value)

See Also:

getActions()

setBookmarks

public void setBookmarks(Bookmarks value)

See Also:

getBookmarks()

setForm

public void setForm(Form value)

Since:

0.0.7

See Also:

getForm()

setInformation

public void setInformation(Information value)

See Also:

getInformation()

setNames

public void setNames(Names value)

Since:

0.0.4

See Also:

getNames()

setPageLayout

public void setPageLayout(PageLayoutEnum value)

See Also:

getPageLayout()

setPageMode

public void setPageMode(PageModeEnum value)

See Also:

getPageMode()

setPages

public void setPages(Pages value)

See Also:

getPages()

setPageSize

public void setPageSize(Dimension2D value)

See Also:

getPageSize()

setResources

public void setResources(Resources value)

See Also:

getResources()

setVersion

public void setVersion(String value)

See Also:

getVersion()

setViewerPreferences

public void setViewerPreferences(ViewerPreferences value)

See Also:

getViewerPreferences()