com.compdfkit.core.document

Class CPDFHeaderFooter

java.lang.Object

com.compdfkit.core.document.CPDFHeaderFooter

Direct Known Subclasses:

CPDFBates

public class CPDFHeaderFooter
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
void	clear() Removes the header & footer.
java.lang.String	getFontName(int index) Gets the font name of the header & footer at the specified index.
float	getFontSize(int index) Gets the font size of the header & footer at the specified index.
android.graphics.RectF	getMargin() Gets the margins of the header & footer.
int	getPageOffset() Gets the start page number of the header & footer.
java.lang.String	getPages() Gets the page range of the header & footer by string, such as "0,3 or 5-7".
int	getRules() Get rule value
java.lang.String	getText(int index) Gets the text of the header & footer at the specified index.
int	getTextColor(int index) Gets the font color of the header & footer at the specified index.
boolean	isValid() Whether CPDFHeaderFooter is valid.
void	release() Release CPDFHeaderFooter object
boolean	setFontName(int index, java.lang.String fontName) Sets the font name of the header & footer at the specified index.
boolean	setFontSize(int index, float fontSize) Sets the font size of the header & footer at the specified index.
boolean	setMargin(float left, float top, float right, float bottom) Sets the margins of the header & footer.
boolean	setPageOffset(int offset) Sets the start page number of the header & footer.
boolean	setPages(java.lang.String pages) Sets the page range of the header & footer by string, such as "0,3 or 5-7".
boolean	setRules(int rule) When setText setText(int, String), there are two kinds of rules.
boolean	setText(int index, java.lang.String text) Sets the text of the header & footer at the specified index.
boolean	setTextColor(int index, int color) Sets the font color of the header & footer at the specified index.
void	update() Updates the header & footer.

Methods inherited from class java.lang.Object

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

Method Detail

getText

public java.lang.String getText(int index)

Gets the text of the header & footer at the specified index.

Parameters:

index - The specified index

Returns:

The display text

setText

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

Sets the text of the header & footer at the specified index. The text is to "<<1>>", and the starting value of the page number is the set pageOffset. eg: When text is set to "<<1>>" and the value of pageOffset is 1, the text displayed on the first page is "1".

Parameters:

index - The specified index

text - The display text

Returns:

Whether the setting is successful

getFontName

public java.lang.String getFontName(int index)

Gets the font name of the header & footer at the specified index.

Parameters:

index - The specified index

Returns:

Returns font name.

setFontName

public boolean setFontName(int index,
                           java.lang.String fontName)

Sets the font name of the header & footer at the specified index.

Parameters:

index - The specified index

fontName - Font name.

Returns:

Whether the setting is successful

getFontSize

public float getFontSize(int index)

Gets the font size of the header & footer at the specified index.

Parameters:

index - The specified index

Returns:

Returns font size.

setFontSize

public boolean setFontSize(int index,
                           float fontSize)

Sets the font size of the header & footer at the specified index.

Parameters:

index - The specified index

fontSize - Font size.

Returns:

Whether the setting is successful

getTextColor

public int getTextColor(int index)

Gets the font color of the header & footer at the specified index.

Parameters:

index - The specified index

Returns:

Returns font color.

setTextColor

public boolean setTextColor(int index,
                            int color)

Sets the font color of the header & footer at the specified index.

Parameters:

index - The specified index

color - Color value (0x00000000~0xFFFFFFFF)

Returns:

Whether the setting is successful

getMargin

public android.graphics.RectF getMargin()

Gets the margins of the header & footer.

Returns:

Margin rect

setMargin

public boolean setMargin(float left,
                         float top,
                         float right,
                         float bottom)

Sets the margins of the header & footer.

Parameters:

left - Left margin

top - Top margin

right - Right margin

bottom - Bottom margin

Returns:

Whether the setting is successful

getPageOffset

public int getPageOffset()

Gets the start page number of the header & footer.

Returns:

page offset

setPageOffset

public boolean setPageOffset(int offset)

Sets the start page number of the header & footer.

Parameters:

offset - page offset

Returns:

Whether the setting is successful

update

public void update()

Updates the header & footer.

clear

public void clear()

Removes the header & footer.

getPages

public java.lang.String getPages()

Gets the page range of the header & footer by string, such as "0,3 or 5-7".

Returns:

page range

setPages

public boolean setPages(java.lang.String pages)

Sets the page range of the header & footer by string, such as "0,3 or 5-7".

Parameters:

pages - page range

Returns:

Whether the setting is successful

setRules

public boolean setRules(int rule)

When setText setText(int, String), there are two kinds of rules. When rule is 1, the set text is in the form of <> or <>, where 'i' is the starting value of the page number, and 'f' is the number of digits in the page number , if the actual page number is not enough, it will be automatically filled with 0 in front. When rule is 2, the set text is <<1>>, and the starting value of the page number is the set pageOffset

Parameters:

rule - rule ,default is 2

Returns:

Whether the setting is successful

getRules

public int getRules()

Get rule value

Returns:

rule value

isValid

public boolean isValid()

Whether CPDFHeaderFooter is valid.

Returns:

Returns whether CPDFHeaderFooter object are valid.

release

public void release()

Release CPDFHeaderFooter object