PdfPageLabels.PdfPageLabelFormat (openpdf 1.3.33 API)

java.lang.Object
- com.lowagie.text.pdf.PdfPageLabels.PdfPageLabelFormat

Enclosing class:: PdfPageLabels

public static class PdfPageLabels.PdfPageLabelFormat
extends Object

Field Summary

Fields
Modifier and Type Field Description

int logicalPage

int numberStyle

int physicalPage

String prefix

Constructor Summary

Constructors
Constructor	Description
`PdfPageLabelFormat(int physicalPage, int numberStyle, String prefix, int logicalPage)`	Creates a page label format.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

String toString()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - physicalPage
```
public int physicalPage
```
  - numberStyle
```
public int numberStyle
```
  - prefix
```
public String prefix
```
  - logicalPage
```
public int logicalPage
```
- Constructor Detail
  - PdfPageLabelFormat
```
public PdfPageLabelFormat(int physicalPage,
                          int numberStyle,
                          String prefix,
                          int logicalPage)
```
    Creates a page label format.
    
    Parameters:
    
    physicalPage - the real page to start the numbering. First page is 1
    
    numberStyle - the numbering style such as LOWERCASE_ROMAN_NUMERALS
    
    prefix - the text to prefix the number. Can be null or empty
    
    logicalPage - the first logical page number
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object