Collection Class Documentation

classCollection

Namespace:com::datalogics::PDFL

Detailed Description

Allows for manipulation of PDF collections, or portfolios. The class illustrates how to process a collection's schema. It also describes sorting of a portfolio.

Referenced by

Document

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

changeCollectionViewMode

voidchangeCollectionViewMode(CollectionViewTypeview, CollectionSplitTypesplit)

Parameters

view: CollectionViewType

one of the members of CollectionViewMode enum.

split: CollectionSplitType

enum of split mode (selector)

Returns:

void

SetCollectionView sets view mode value to the Collection.

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

finalize

voidfinalize()

Returns:

void

getSchema

CollectionSchemagetSchema()

Returns:

Schema object.

GetSchema allows to obtain Schema object for current Collection. The Schema object does not have constructor. Only Collection is able to create Schema.

getSort

java.util.List< CollectionSortItem >getSort()

Returns:

the list of CollectionSortItem, which contains field/fields name to sort Collection by and sort order.

GetSort gets sort parameters for the Collection.