com.gnostice.pdfone

Interface PdfCustomPlaceholderHandler

public interface PdfCustomPlaceholderHandler

This interface defines a run-time event that can be used to track/modify custom placeholders in text rendered on a document. User classes can implements this interface to provide values for custom placeholders used in strings rendered on the document with methods such as PdfDocument.writeText(String).

Method Summary

Modifier and Type	Method and Description
String	onCustomPlaceHolder(String variable, PdfDocument d, int pagenumber) Called by a method such as PdfDocument.writeText(String) that tries to render a string containing a custom placeholder on a page.

Method Detail

onCustomPlaceHolder

String onCustomPlaceHolder(String variable,
                           PdfDocument d,
                           int pagenumber)

Called by a method such as PdfDocument.writeText(String) that tries to render a string containing a custom placeholder on a page. User classes implementing this interface can handle this event to provide values for the specified custom placeholders at run time.

Parameters:

variable - custom placeholder in the string

d - document where the string will be rendered

pagenumber - number of the page where the string will be rendered

Returns:

modified string containing the value (if any) of the custom placeholder

Example

See example.