Class DefaultPageNumberFormat

java.lang.Object
org.eclipse.nebula.paperclips.core.page.DefaultPageNumberFormat
All Implemented Interfaces:
PageNumberFormat

public final class DefaultPageNumberFormat
extends java.lang.Object
implements PageNumberFormat
The default PageNumberFormat used by PageNumberPrints.

This class formats page numbers as "Page x of y".

  • Constructor Summary

    Constructors 
    Constructor Description
    DefaultPageNumberFormat()  
  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)  
    java.lang.String format​(PageNumber pageNumber)
    Returns a formatted String representing the pageNumber argument.
    int hashCode()  

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

  • Method Details

    • format

      public java.lang.String format​(PageNumber pageNumber)
      Description copied from interface: PageNumberFormat
      Returns a formatted String representing the pageNumber argument.
      Specified by:
      format in interface PageNumberFormat
      Parameters:
      pageNumber - the page number to be formatted into a String.
      Returns:
      a formatted String representing the pageNumber argument.
    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class java.lang.Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object