Content Class Documentation

classContent

Namespace:com::datalogics::PDFL

Detailed Description

Class that represents the collection of elements on a PDF page. A content object represents a collection of elements that make up a page in a PDF file. A content object is more convenient to use than directly parsing or working with a page content stream. This is because a page can include a large collection of individual stream objects. Working with a content object, you can avoid focusing on this level of detail. The content converts individual stream items to a structured form, making it unnecessary to parse the individual syntax for each one. A content object can be associated with a large amount of unmanaged memory in APDFL and should be deleted when the object is no longer in use.

The index associated with Content is 0-based, so 0 is the first element.

Referenced by

ContainerFormGroupPage

Constructor & Destructor Documentation

Content

Content()

Create content

Content

Content(ElementfirstElem)

Parameters

firstElem: Element

The Element which is to be added to the beginning of the new Content object.

Create content with a first Element.

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

addElement

voidaddElement(ElementNewElem)

Parameters

NewElem: Element

The Element which is to be added to the end of the existing Content object.

Returns:

void

Adds an existing Element at the end of the content object.

addElement

voidaddElement(ElementNewElem, intaddAfterIndex)

Parameters

NewElem: Element

The Element which is to be added to the end of the existing Content object.

addAfterIndex: int

The position after which to insert the new Element, the index is 0-based so 0 is the first element. To insert a new element as the first element use the Content.BeforeFirst constant.

Returns:

void

Adds an existing Element at the given index of the content object.

addPage

voidaddPage(intinsertAfterIndex, DocumentcontainerDoc, PagesrcPage, MatrixdstMatrix, java.util.List< String >annotTypes, java.util.EnumSet< AddPageFlags >flags, Rectbbox)

Parameters

insertAfterIndex: int

The index indicates the location after which the specified element is to be added. The index should be BeforeFirst to add to the beginning of the display list.

containerDoc: Document

The Document in which the page is contained.

srcPage: Page

The page that will be inserted at insertAfterIndex in theContent.

dstMatrix: Matrix

(May be NULL) The matrix applied to the default matrix of the Page that is inserted into the Document.

annotTypes: java.util.List< String >

If the page contains annotations, the annotTypes list is used to determine which annotation types are pumped into the page contents of the CosDoc.

flags: java.util.EnumSet< AddPageFlags >

(May be 0) AllAnnotations specifies all annotation types. If this is not set, then the annotTypes list will be consulted.

bbox: Rect

(May be NULL) specifies the destination BBox for the page being inserted. If it is NULL, the new page's media box is used.

Returns:

void

Adds the specfied Page to the Content as a Form. It adds a reference to the Xobject form at the indicated index in the Content; the index may be less than 0, which indicates the object is to be appended to the content.

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

finalize

voidfinalize()

Returns:

void

flattenOptionalContent

booleanflattenOptionalContent(OptionalContentContextocc)

Parameters

occ: OptionalContentContext

The optional content context in which content is checked for visibility.

Returns:

true if the content was successfully flattened, false otherwise.

Flattens optional content within this Content object.

Removes elements that are not visible in the given optional content context and removes optional content information from any visible elements.

The optional content information formerly associated with this Content object will NOT be deleted from the document, as it is possible that content elsewhere in the document may be using the information.

getBoundingBox

RectgetBoundingBox()

Returns:

Rect

The bounding box for this content.

The bounding box is a rectangle that is at least large enough to contain the bounding boxes for all the elements in the Content.

getDefaultColorSpace

ColorSpacegetDefaultColorSpace(Stringname)

Parameters

name: String

The name of the color space to get. It must be one of DefaultRGB, DefaultCMYK, or DefaultGray.

Returns:

The color space used as the default. May return null if no default is set.

Get a default color space from a Content object.

getElement

ElementgetElement(intindex)

Parameters

index: int

Returns:

Element

Get the element specified by index.

getNumElements

intgetNumElements()

Returns:

int

The number of elements in the Content object.

removeElement

voidremoveElement(intindex)

Parameters

index: int

The position at which to remove the Element

Returns:

void

Removes the Element at the specified index.

setDefaultColorSpace

voidsetDefaultColorSpace(Stringname, ColorSpacecolorSpace)

Parameters

name: String

The name of the color space to set. It must be one of DefaultRGB, DefaultCMYK, or DefaultGray.

colorSpace: ColorSpace

The color space to set. It may not be a Lab, Indexed or Pattern color space.

Returns:

void

Set a default color space from a Content object.

toString

StringtoString()

Returns:

String