Class RtfTotalPageNumber

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

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

      Fields 
      Modifier and Type Field Description
      private static byte[] ARABIC_TOTAL_PAGES
      Constant for arabic total page numbers.
      • 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
    • Field Detail

      • ARABIC_TOTAL_PAGES

        private static final byte[] ARABIC_TOTAL_PAGES
        Constant for arabic total page numbers.
    • Constructor Detail

      • RtfTotalPageNumber

        public RtfTotalPageNumber()
        Constructs a RtfTotalPageNumber. This can be added anywhere to add a total number of pages field.
      • RtfTotalPageNumber

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

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

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

      • writeFieldInstContent

        protected void writeFieldInstContent​(java.io.OutputStream result)
                                      throws java.io.IOException
        Writes the field NUMPAGES instruction with Arabic format: "NUMPAGES \\\\* Arabic".
        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 out)
                                        throws java.io.IOException
        Writes the field result content "1".
        Specified by:
        writeFieldResultContent in class RtfField
        Parameters:
        out - The OutputStream to write to.
        Throws:
        java.io.IOException - on i/o errors.