A self contained collection of IDocuments. More...

#include <jawsmako.h>

Inheritance diagram for JawsMako::IDocumentAssembly:

Public Member Functions
virtual uint32	getNumDocuments ()=0
	Return the number of documents in the assembly, if known. Note: For streaming inputs such as PCL/5, this will cause the input to block until the stream has been exhausted and the number of documents known. More...

virtual IDocumentPtr	getDocument (uint32 index=0)=0
	Get the IDocument from the assembly at the given index. More...

virtual bool	documentExists (uint32 index)=0
	Determine if a document with the given index exists in the assembly. More...

virtual void	insertDocument (const IDocumentPtr &document, uint32 index=0)=0
	Insert a document into the assembly at the given index. More...

virtual void	removeDocument (uint32 index)=0
	Remove the document at the given index. More...

virtual void	removeDocument (const IDocumentPtr &document)=0
	Remove the given document from the document. If the document is not present, an exception will be raised.

virtual void	appendDocument (const IDocumentPtr &document)=0
	Append a document to the assembly. More...

virtual IDOMJobTkPtr	getJobTicket () const =0
	Get the overall job ticket for the entire assembly, if present. More...

virtual void	setJobTicket (const IDOMJobTkPtr &jobTicket)=0
	Set the document job ticket.

virtual void	findTarget (DOMid targetId, uint32 &docNum, uint32 &pageNum)=0
	Find the page contatining the target with the given DOMid in the assembly, providing the index of the document and page within the assembly. Throws an IError if the target could not be found.

virtual IAnnotationPtr	findAnnotation (const IAnnotationReferencePtr &reference)=0
	Find the annotation with the given annotation reference within the document assembly. Throws an IError if the target could not be found.

virtual IAnnotationPtr	findAnnotation (const IAnnotationReferencePtr &reference, uint32 &docNum, uint32 &pageNum)=0
	Find the annotation with the given annotation reference within the document assembly, providing the index of the document and page that contains the annotation. Throws an IError if the target could not be found.

virtual IDocumentAssemblyPtr	clone ()=0
	Clone an IDocumentAssembly. Will also clone all the documents and pages in the assembly. More...

virtual IDOMMetadataPtr	getJobMetadata () const =0
	Get the job metadata, if present (ie the document properties). More...

virtual void	setJobMetadata (const IDOMMetadataPtr &metadata)=0
	Set the job metadata.

virtual IInputStreamPtr	getXmpPacket () const =0
	Get the PDF XMP packet, if present. More...

virtual void	setXmpPacket (const IInputStreamPtr &xmpPacket)=0
	Set the PDF XMP packet, if present. Note that the XMP packet in any PDF output will be modified to match the job metadata for compliance with specification. If NULL, the XMP packet will be reset.

virtual IDOMSecurityInfoPtr	getSecurityInfo () const =0
	Get the security information that applied to the source file/stream. Curently only relevant for PDF. More...

virtual IDOMImagePtr	getThumbnail () const =0
	Get the thumbnail image for the assembly. More...

virtual void	setThumbnail (const IDOMImagePtr &thumbnail)=0
	Sets a new thumbnail image for the document assembly. The image must be in either JPEG or PNG format. Setting thumbnail to NULL deletes the document assembly thumbnail. More...

Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.

virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to. More...

virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to. More...

Static Public Member Functions
static JAWSMAKO_API IDocumentAssemblyPtr	create (const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
	Create a new, empty document assembly. More...

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

A self contained collection of IDocuments.

Member Function Documentation

◆ appendDocument()

virtual void JawsMako::IDocumentAssembly::appendDocument ( const IDocumentPtr & document )

pure virtual

Append a document to the assembly.

Parameters

document smart pointer to the page to be appended.

◆ clone()

virtual IDocumentAssemblyPtr JawsMako::IDocumentAssembly::clone ( )

pure virtual

Clone an IDocumentAssembly. Will also clone all the documents and pages in the assembly.

Returns: IDocumentAssemblyPtr the clone.

◆ create()

static JAWSMAKO_API IDocumentAssemblyPtr JawsMako::IDocumentAssembly::create	(	const IJawsMakoPtr &	jawsMako,
		const IProgressMonitorPtr &	progressMonitor = `IProgressMonitorPtr()`
	)

static

Create a new, empty document assembly.

Parameters

jawsMako	The JawsMako instance.
progressMonitor	The progress monitor which allows aborting an operation or registering a progress callback.

Returns: IDocumentAssemblyPtr the new assembly.

◆ documentExists()

virtual bool JawsMako::IDocumentAssembly::documentExists ( uint32 index )

pure virtual

Determine if a document with the given index exists in the assembly.

Parameters

index The index of the document to check, 0 being the first document.

Returns: bool True if the assembly has a document with the given index.

◆ getDocument()

virtual IDocumentPtr JawsMako::IDocumentAssembly::getDocument ( uint32 index = 0 )

pure virtual

Get the IDocument from the assembly at the given index.

Returns: IDocumentPtr the requested document, 0 being the first document.

◆ getJobMetadata()

virtual IDOMMetadataPtr JawsMako::IDocumentAssembly::getJobMetadata ( ) const

pure virtual

Get the job metadata, if present (ie the document properties).

Returns: IDOMMetadataPtr. Returns NULL if no such information was provided by the input.

◆ getJobTicket()

virtual IDOMJobTkPtr JawsMako::IDocumentAssembly::getJobTicket ( ) const

pure virtual

Get the overall job ticket for the entire assembly, if present.

Returns: IDOMJobTkPtr the job ticket, or NULL if not present

◆ getNumDocuments()

virtual uint32 JawsMako::IDocumentAssembly::getNumDocuments ( )

pure virtual

Return the number of documents in the assembly, if known. Note: For streaming inputs such as PCL/5, this will cause the input to block until the stream has been exhausted and the number of documents known.

Returns: uint32 The number of pages in the assembly.

◆ getSecurityInfo()

virtual IDOMSecurityInfoPtr JawsMako::IDocumentAssembly::getSecurityInfo ( ) const

pure virtual

Get the security information that applied to the source file/stream. Curently only relevant for PDF.

Returns: IDOMPDFSecurityInfoPtr. Returns NULL if no security information was provided by the input.

◆ getThumbnail()

virtual IDOMImagePtr JawsMako::IDocumentAssembly::getThumbnail ( ) const

pure virtual

Get the thumbnail image for the assembly.

Returns: IDOMImagePtr. Returns NULL if no thumbnail image is present.

◆ getXmpPacket()

virtual IInputStreamPtr JawsMako::IDocumentAssembly::getXmpPacket ( ) const

pure virtual

Get the PDF XMP packet, if present.

Returns: IInputStreamPtr. Returns NULL if the XMP packet is not present.

◆ insertDocument()

virtual void JawsMako::IDocumentAssembly::insertDocument	(	const IDocumentPtr &	document,
		uint32	index = `0`
	)

pure virtual

Insert a document into the assembly at the given index.

Parameters

document	smart pointer to the document to be inserted.
index	The position in the assembly to insert the document, 0 being the first position.

◆ removeDocument()

virtual void JawsMako::IDocumentAssembly::removeDocument ( uint32 index )

pure virtual

Remove the document at the given index.

Parameters

index The index of the document to be removed (0 being the first document).

◆ setThumbnail()

virtual void JawsMako::IDocumentAssembly::setThumbnail ( const IDOMImagePtr & thumbnail )

pure virtual

Sets a new thumbnail image for the document assembly. The image must be in either JPEG or PNG format. Setting thumbnail to NULL deletes the document assembly thumbnail.

Parameters

thumbnail Smart pointer to new thumbnail image.

The documentation for this class was generated from the following file:

jawsmako.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ appendDocument()

◆ clone()

◆ create()

◆ documentExists()

◆ getDocument()

◆ getJobMetadata()

◆ getJobTicket()

◆ getNumDocuments()

◆ getSecurityInfo()

◆ getThumbnail()

◆ getXmpPacket()

◆ insertDocument()

◆ removeDocument()

◆ setThumbnail()