Packageorg.purepdf.pdf
Classpublic class PdfPageLabels
InheritancePdfPageLabels Inheritance Object


Public Methods
 MethodDefined By
  
PdfPageLabels()
PdfPageLabels
  
addPageLabel(page:int, numberStyle:int, text:String = null, firstPage:int = 1):void
Add or replace a page label.
PdfPageLabels
  
getDictionary(writer:PdfWriter):PdfDictionary
Gets the page label dictionary to insert into the document.
PdfPageLabels
  
removePageLabel(page:int):Boolean
Remove a page label.
PdfPageLabels
Public Constants
 ConstantDefined By
  DECIMAL_ARABIC_NUMERALS : int = 0
[static]
PdfPageLabels
  EMPTY : int = 5
[static]
PdfPageLabels
  LOWERCASE_LETTERS : int = 4
[static]
PdfPageLabels
  LOWERCASE_ROMAN_NUMERALS : int = 2
[static]
PdfPageLabels
  UPPERCASE_LETTERS : int = 3
[static]
PdfPageLabels
  UPPERCASE_ROMAN_NUMERALS : int = 1
[static]
PdfPageLabels
Constructor Detail
PdfPageLabels()Constructor
public function PdfPageLabels()



Method Detail
addPageLabel()method
public function addPageLabel(page:int, numberStyle:int, text:String = null, firstPage:int = 1):void

Add or replace a page label.

Parameters

page:int — the real page to start the numbering. First page is 1
 
numberStyle:int — the numbering style such as LOWERCASE_ROMAN_NUMERALS
 
text:String (default = null) — the text to prefix the number. Can be null or empty
 
firstPage:int (default = 1) — the first logical page number


Throws
ArgumentError

See also

DECIMAL_ARABIC_NUMERALS
UPPERCASE_ROMAN_NUMERALS
LOWERCASE_ROMAN_NUMERALS
UPPERCASE_LETTERS
LOWERCASE_LETTERS
EMPTY
getDictionary()method 
public function getDictionary(writer:PdfWriter):PdfDictionary

Gets the page label dictionary to insert into the document.

Parameters

writer:PdfWriter

Returns
PdfDictionary — the page label dictionary

Throws
ConversionError
removePageLabel()method 
public function removePageLabel(page:int):Boolean

Remove a page label. The first page label can not be removed, only changed.

Parameters

page:int — the real page to remove

Returns
Boolean — true if page label has been removed
Constant Detail
DECIMAL_ARABIC_NUMERALSConstant
public static const DECIMAL_ARABIC_NUMERALS:int = 0

EMPTYConstant 
public static const EMPTY:int = 5

LOWERCASE_LETTERSConstant 
public static const LOWERCASE_LETTERS:int = 4

LOWERCASE_ROMAN_NUMERALSConstant 
public static const LOWERCASE_ROMAN_NUMERALS:int = 2

UPPERCASE_LETTERSConstant 
public static const UPPERCASE_LETTERS:int = 3

UPPERCASE_ROMAN_NUMERALSConstant 
public static const UPPERCASE_ROMAN_NUMERALS:int = 1





Thu May 27 2010, 07:51 AM +02:00