org.pdfclown.documents.contents
Interface IContentEntity

All Known Subinterfaces:

IContentContext

All Known Implementing Classes:

Barcode, EAN13Barcode, Entity, FormXObject, Image, JpegImage, Page

public interface IContentEntity

Generic content entity.

It provides common ways to convert any content into content stream objects.

Since:

0.0.5

Version:

0.1.0

Author:

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

Method Summary

ContentObject	toInlineObject(PrimitiveComposer composer) Converts this entity to its equivalent inline (dependent) object representation [PDF:1.6:4.8.6].
XObject	toXObject(Document context) Converts this entity to its equivalent external (independent) object representation [PDF:1.6:4.7].

Method Detail

toInlineObject

ContentObject toInlineObject(PrimitiveComposer composer)

Converts this entity to its equivalent inline (dependent) object representation [PDF:1.6:4.8.6].

This method creates and shows an inline object within the target content context, returning it.

Due to its direct-content nature (opposite to the indirect-content nature of external objects (see toXObject(Document))), the resulting object should be shown only one time in order not to wastefully duplicate its data.

Parameters:

composer - Target content composer.

Returns:

The inline object representing the entity.

Since:

0.0.6

toXObject

XObject toXObject(Document context)

Converts this entity to its equivalent external (independent) object representation [PDF:1.6:4.7].

This method creates an external object within the target document, returning it. To show it in a content context (for example: a page), then it must be applied in an appropriate manner (see PrimitiveComposer object).

Parameters:

context - Target document.

Returns:

The external object representing the entity.

Since:

0.0.5