Class RtfPageNumber

  • All Implemented Interfaces:
    com.lowagie.text.Element, RtfBasicElement, com.lowagie.text.RtfElementInterface

    public class RtfPageNumber
    extends RtfField
    The RtfPageNumber provides the page number field in rtf documents.
    Version:
    $Id: RtfPageNumber.java 3580 2008-08-06 15:52:00Z howard_s $
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static byte[] PAGE_NUMBER
      Constant for the page number
      • Fields inherited from class com.lowagie.text.Chunk

        ACTION, attributes, BACKGROUND, CHAR_SPACING, COLOR, content, ENCODING, GENERICTAG, HSCALE, HYPHENATION, IMAGE, LOCALDESTINATION, LOCALGOTO, NEWLINE, NEWPAGE, NEXTPAGE, OBJECT_REPLACEMENT_CHARACTER, PDFANNOTATION, REMOTEGOTO, SEPARATOR, SKEW, SPLITCHARACTER, SUBSUPSCRIPT, TAB, TEXTRENDERMODE, UNDERLINE
      • Fields inherited from interface com.lowagie.text.Element

        ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, FOOTNOTE, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MODIFICATIONDATE, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK
    • Constructor Summary

      Constructors 
      Constructor Description
      RtfPageNumber()
      Constructs a RtfPageNumber.
      RtfPageNumber​(com.lowagie.text.Font font)
      Constructs a RtfPageNumber with a specified Font.
      RtfPageNumber​(RtfDocument doc)
      Constructs a RtfPageNumber object.
      RtfPageNumber​(RtfDocument doc, com.lowagie.text.Font font)
      Constructs a RtfPageNumber object with a specific font.
    • Field Detail

      • PAGE_NUMBER

        private static final byte[] PAGE_NUMBER
        Constant for the page number
    • Constructor Detail

      • RtfPageNumber

        public RtfPageNumber()
        Constructs a RtfPageNumber. This can be added anywhere to add a page number field.
      • RtfPageNumber

        public RtfPageNumber​(com.lowagie.text.Font font)
        Constructs a RtfPageNumber with a specified Font. This can be added anywhere to add a page number field.
        Parameters:
        font -
      • RtfPageNumber

        public RtfPageNumber​(RtfDocument doc)
        Constructs a RtfPageNumber object.
        Parameters:
        doc - The RtfDocument this RtfPageNumber belongs to
      • RtfPageNumber

        public RtfPageNumber​(RtfDocument doc,
                             com.lowagie.text.Font font)
        Constructs a RtfPageNumber object with a specific font.
        Parameters:
        doc - The RtfDocument this RtfPageNumber belongs to
        font - The Font to use
    • Method Detail

      • writeFieldInstContent

        protected void writeFieldInstContent​(java.io.OutputStream result)
                                      throws java.io.IOException
        Writes the field instruction content
        Specified by:
        writeFieldInstContent in class RtfField
        Parameters:
        result - The OutputStream to write to.
        Throws:
        java.io.IOException - on i/o errors.
      • writeFieldResultContent

        protected void writeFieldResultContent​(java.io.OutputStream result)
                                        throws java.io.IOException
        Writes the field result content
        Specified by:
        writeFieldResultContent in class RtfField
        Parameters:
        result - The OutputStream to write to.
        Throws:
        java.io.IOException - on i/o errors.