com.stimulsoft.report.engine.engineV2

Class StiPageNumberHelper

java.lang.Object

com.stimulsoft.report.engine.engineV2.StiPageNumberHelper

public class StiPageNumberHelper
extends java.lang.Object

A class helps to work with page numbers.

Field Summary

Fields

Modifier and Type	Field and Description
StiEngine	engine

Constructor Summary

Constructors

Constructor and Description
StiPageNumberHelper(StiEngine engine)

Method Summary

Methods

Modifier and Type	Method and Description
void	AddPageNumber(int pageIndex, int segmentPerWidth, int segmentPerHeight)
void	clear()
void	Clear()
void	ClearNotFixed()
boolean	getClearPageNumbersOnFinish()
int	GetPageNumber(int pageIndex)
int	GetPageNumber(StiPage page)
StiPageNumberCollection	getPageNumbers()
int	GetPageNumberThrough(int pageIndex)
int	GetPageNumberThrough(StiPage page)
int	GetTotalPageCount(int pageIndex)
int	GetTotalPageCountThrough(int pageIndex)
void	ProcessPageNumbers() Counts the PageNumber, TotalPageCount, PageNumberThrough, and TotalPageCountThrough values for every page.
void	ResetPageNumber()
void	ResetPageNumber(int pageIndex)
void	setClearPageNumbersOnFinish(boolean value)
void	setPageNumbers(StiPageNumberCollection value)

Methods inherited from class java.lang.Object

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

Field Detail

engine

public StiEngine engine

Constructor Detail

StiPageNumberHelper

public StiPageNumberHelper(StiEngine engine)

Method Detail

getClearPageNumbersOnFinish

public final boolean getClearPageNumbersOnFinish()

setClearPageNumbersOnFinish

public final void setClearPageNumbersOnFinish(boolean value)

getPageNumbers

public final StiPageNumberCollection getPageNumbers()

setPageNumbers

public final void setPageNumbers(StiPageNumberCollection value)

ResetPageNumber

public final void ResetPageNumber()

ResetPageNumber

public final void ResetPageNumber(int pageIndex)

AddPageNumber

public final void AddPageNumber(int pageIndex,
                 int segmentPerWidth,
                 int segmentPerHeight)

GetPageNumber

public final int GetPageNumber(int pageIndex)

GetPageNumber

public final int GetPageNumber(StiPage page)

GetTotalPageCount

public final int GetTotalPageCount(int pageIndex)

GetPageNumberThrough

public final int GetPageNumberThrough(int pageIndex)

GetPageNumberThrough

public final int GetPageNumberThrough(StiPage page)

GetTotalPageCountThrough

public final int GetTotalPageCountThrough(int pageIndex)

ProcessPageNumbers

public final void ProcessPageNumbers()

Counts the PageNumber, TotalPageCount, PageNumberThrough, and TotalPageCountThrough values for every page.

Clear

public final void Clear()

ClearNotFixed

public final void ClearNotFixed()

clear

public void clear()