com.helger.pdflayout.render

Class RenderPageIndex

java.lang.Object

com.helger.pdflayout.render.RenderPageIndex

public class RenderPageIndex
extends Object

This class describes the index of the current page.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLACEHOLDER_PAGESET_INDEX
static String	PLACEHOLDER_PAGESET_PAGE_COUNT
static String	PLACEHOLDER_PAGESET_PAGE_INDEX
static String	PLACEHOLDER_PAGESET_PAGE_NUMBER
static String	PLACEHOLDER_TOTAL_PAGE_COUNT
static String	PLACEHOLDER_TOTAL_PAGE_INDEX
static String	PLACEHOLDER_TOTAL_PAGE_NUMBER

Constructor Summary

Constructors

Constructor and Description
RenderPageIndex(int nPageSetIndex, int nPageSetPageIndex, int nPageSetPageCount, int nTotalPageIndex, int nTotalPageCount)

Method Summary

Modifier and Type	Method and Description
int	getPageSetIndex()
int	getPageSetPageCount()
int	getPageSetPageIndex()
int	getPageSetPageNumber()
int	getTotalPageCount()
int	getTotalPageIndex()
int	getTotalPageNumber()
void	setPlaceholdersInRenderingContext(RenderingContext aRC)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PLACEHOLDER_PAGESET_INDEX

public static final String PLACEHOLDER_PAGESET_INDEX

See Also:

Constant Field Values

PLACEHOLDER_PAGESET_PAGE_INDEX

public static final String PLACEHOLDER_PAGESET_PAGE_INDEX

See Also:

Constant Field Values

PLACEHOLDER_PAGESET_PAGE_NUMBER

public static final String PLACEHOLDER_PAGESET_PAGE_NUMBER

See Also:

Constant Field Values

PLACEHOLDER_PAGESET_PAGE_COUNT

public static final String PLACEHOLDER_PAGESET_PAGE_COUNT

See Also:

Constant Field Values

PLACEHOLDER_TOTAL_PAGE_INDEX

public static final String PLACEHOLDER_TOTAL_PAGE_INDEX

See Also:

Constant Field Values

PLACEHOLDER_TOTAL_PAGE_NUMBER

public static final String PLACEHOLDER_TOTAL_PAGE_NUMBER

See Also:

Constant Field Values

PLACEHOLDER_TOTAL_PAGE_COUNT

public static final String PLACEHOLDER_TOTAL_PAGE_COUNT

See Also:

Constant Field Values

Constructor Detail

RenderPageIndex

public RenderPageIndex(@Nonnegative
                       int nPageSetIndex,
                       @Nonnegative
                       int nPageSetPageIndex,
                       @Nonnegative
                       int nPageSetPageCount,
                       @Nonnegative
                       int nTotalPageIndex,
                       @Nonnegative
                       int nTotalPageCount)

Method Detail

getPageSetIndex

@Nonnegative
public int getPageSetIndex()

Returns:

The index of the current page set. 0-based. Always ≥ 0.

getPageSetPageIndex

@Nonnegative
public int getPageSetPageIndex()

Returns:

The index of the page in the current page set. 0-based. Always ≥ 0.

getPageSetPageNumber

@Nonnegative
public int getPageSetPageNumber()

Returns:

The number of the page in the current page set. 1-based. Always ≥ 1.

getPageSetPageCount

@Nonnegative
public int getPageSetPageCount()

Returns:

The total number of pages in the current page set. Always ≥ 0.

getTotalPageIndex

@Nonnegative
public int getTotalPageIndex()

Returns:

The index of the page over all page sets. 0-based. Always ≥ 0.

getTotalPageNumber

@Nonnegative
public int getTotalPageNumber()

Returns:

The number of the page over all page sets. 1-based. Always ≥ 1.

getTotalPageCount

@Nonnegative
public int getTotalPageCount()

Returns:

The overall number of pages. Always ≥ 0.

setPlaceholdersInRenderingContext

public void setPlaceholdersInRenderingContext(@Nonnull
                                              RenderingContext aRC)

toString

public String toString()

Overrides:

toString in class Object