CPDFGeneration.layout

Class CDocument

java.lang.Object

CPDFGeneration.layout.CDocument

public class CDocument
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
long	elementPtr Native document pointer/handle.

Constructor Summary

Constructors

Constructor and Description
CDocument() Create a document instance.

Method Summary

Modifier and Type	Method and Description
CPage	createPage(float width, float height) Create a page in this document.
CStyle	createStyle() Create a style object associated with this document.
java.util.ArrayList<CPage>	getPages() Get all pages in the document.
CElementType	getType() Get element type.
void	release() Release the native document resources held by this object.
java.lang.String	render() Render the document.
void	saveToFile(java.io.OutputStream outputStream) Save the rendered result to an output stream.
void	saveToFile(java.lang.String outputPath) Save the rendered result to a file.
void	setFontProvider(CFontProvider fontProvider) Set the font provider.

Methods inherited from class java.lang.Object

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

Field Detail

elementPtr

public long elementPtr

Native document pointer/handle.

Constructor Detail

CDocument

public CDocument()

Create a document instance.

This constructor allocates/creates the underlying native document object.

Method Detail

release

public void release()

Release the native document resources held by this object.

After calling this method, the current instance should not be used anymore.

getType

public CElementType getType()

Get element type.

Returns:

CElementType.ELEMENT_DOCUMENT.

createPage

public CPage createPage(float width,
                        float height)

Create a page in this document.

Parameters:

width - Page width (unit is implementation-defined; commonly points).

height - Page height (unit is implementation-defined; commonly points).

Returns:

Created CPage instance.

createStyle

public CStyle createStyle()

Create a style object associated with this document.

Returns:

Created CStyle instance.

render

public java.lang.String render()

Render the document.

Returns:

Render result string (format is implementation-defined, e.g. JSON/HTML/path).

getPages

public java.util.ArrayList<CPage> getPages()

Get all pages in the document.

Returns:

List of CPage objects.

saveToFile

public void saveToFile(java.lang.String outputPath)

Save the rendered result to a file.

Parameters:

outputPath - Output file path.

saveToFile

public void saveToFile(java.io.OutputStream outputStream)

Save the rendered result to an output stream.

Parameters:

outputStream - Target OutputStream.

setFontProvider

public void setFontProvider(CFontProvider fontProvider)

Set the font provider.

Parameters:

fontProvider - Font provider.