com.compdfkit.core.document

Class CPDFBates

java.lang.Object

com.compdfkit.core.document.CPDFHeaderFooter

com.compdfkit.core.document.CPDFBates

public class CPDFBates
extends CPDFHeaderFooter

Method Summary

Modifier and Type	Method and Description
boolean	setText(int index, java.lang.String text) The regular expressions that Text supports special formats are: <<#\d+#\d+#{0,1}[^#]*#{0,1}[^#]*>> The first # is followed by the minimum number of digits in the page number.

Methods inherited from class com.compdfkit.core.document.CPDFHeaderFooter

clear, getFontName, getFontSize, getMargin, getPageOffset, getPages, getRules, getText, getTextColor, isValid, release, setFontName, setFontSize, setMargin, setPageOffset, setPages, setRules, setTextColor, update

Methods inherited from class java.lang.Object

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

Method Detail

setText

public boolean setText(int index,
                       java.lang.String text)

The regular expressions that Text supports special formats are: <<#\d+#\d+#{0,1}[^#]*#{0,1}[^#]*>> The first # is followed by the minimum number of digits in the page number. If the number of page digits is not enough, 0 is added in front. The second # is followed by the starting value of the page number. The third # is followed by the Bates prefix The fourth # is followed by the Bates suffix eg: When text is set to "front<<#3#1#ab#cd>>back" and the value of pageOffset is 0, the text displayed on the first page is "frontab001cdback".

Overrides:

setText in class CPDFHeaderFooter

Parameters:

index - The specified index

text - The display text

Returns:

Whether the setting is successful