Package com.stimulsoft.report.engine.engineV2

Class StiPageNumberHelper

java.lang.Object

com.stimulsoft.report.engine.engineV2.StiPageNumberHelper

public class StiPageNumberHelper
extends Object

A class helps to work with page numbers.

Field Summary

Fields

Modifier and Type	Field	Description
StiEngine	engine

Constructor Summary

Constructors

Constructor	Description
StiPageNumberHelper(StiEngine engine)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

engine

public StiEngine engine

Constructor Details

StiPageNumberHelper

public StiPageNumberHelper(StiEngine engine)

Method Details

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()