com.cete.dynamicpdf
Class DocumentPackage

java.lang.Object
  com.cete.dynamicpdf.Resource
      com.cete.dynamicpdf.DocumentPackage

public class DocumentPackage
extends Resource

Represents a package PDF.

Licensing:
This class is a DynamicPDF Generator Professional Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Professional Edition
• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

Constructor Summary

DocumentPackage()
Initializes a new instance of the DocumentPackage class.

DocumentPackage(AttachmentLayout layout)
Initializes a new instance of the DocumentPackage class with the specified attachment layout type.

Method Summary

void	draw(DocumentWriter writer) Draws the resource to the given DocumentWriter object.
boolean	getAscendingOrder() Gets the boolean which specifies the ordering in ascending or descending.
AttachmentListingOrderBy	getOrderBy() Gets the listing order by using the specified AttachmentListingOrderBy enumeration element.
int	getRequiredPdfObjects() Gets the number of PDF objects required by the resource.
AttachmentLayout	getViewList() Gets the value for layout typeAttachmentLayout.
void	setAscendingOrder(boolean ascendingOrder) Sets the boolean which specifies the ordering in ascending or descending.
void	setOrderBy(AttachmentListingOrderBy listingOrderBy) Sets the value which specifies the listing order.
void	setViewList(AttachmentLayout layout) Sets the value for layout typeAttachmentLayout.

Methods inherited from class com.cete.dynamicpdf.Resource

getResourceType, getUid, newUid

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentPackage

public DocumentPackage()

Initializes a new instance of the DocumentPackage class.

DocumentPackage

public DocumentPackage(AttachmentLayout layout)

Initializes a new instance of the DocumentPackage class with the specified attachment layout type.

Parameters:

layout - the layout value which specifies the attachment layout type.

Method Detail

getViewList

public AttachmentLayout getViewList()

Gets the value for layout typeAttachmentLayout. Default is detailed layout.

Returns:

a value which specifies the attachment layout type.

setViewList

public void setViewList(AttachmentLayout layout)

Sets the value for layout typeAttachmentLayout.

Parameters:

layout - the value which specifies the attachment layout type.

getOrderBy

public AttachmentListingOrderBy getOrderBy()

Gets the listing order by using the specified AttachmentListingOrderBy enumeration element.

Returns:

a value which specifies listing order.

setOrderBy

public void setOrderBy(AttachmentListingOrderBy listingOrderBy)

Sets the value which specifies the listing order.

Parameters:

listingOrderBy - the value which specifies the listing order.

getAscendingOrder

public boolean getAscendingOrder()

Gets the boolean which specifies the ordering in ascending or descending. Default value is true(Ascending order).

Returns:

a value which specifies the ordering in ascending or descending.

setAscendingOrder

public void setAscendingOrder(boolean ascendingOrder)

Sets the boolean which specifies the ordering in ascending or descending.

Parameters:

ascendingOrder - the boolean which specifies the ordering in ascending or descending.

getRequiredPdfObjects

public int getRequiredPdfObjects()

Gets the number of PDF objects required by the resource.

Overrides:

getRequiredPdfObjects in class Resource

Returns:

the number of PDF objects required by the resource.

draw

public void draw(DocumentWriter writer)

Draws the resource to the given DocumentWriter object.

Specified by:

draw in class Resource

Parameters:

writer - DocumentWriter object to receive the resource's output.

See Also:

DocumentWriter