Package com.lowagie.text.rtf.headerfooter

Class RtfHeaderFooterGroup

  • All Implemented Interfaces:
    com.lowagie.text.Element, RtfBasicElement, com.lowagie.text.RtfElementInterface
    public class RtfHeaderFooterGroup
extends com.lowagie.text.HeaderFooter
implements RtfBasicElement
    The RtfHeaderFooterGroup holds 0 - 3 RtfHeaderFooters that create a group of headers or footers.
    Version:
    $Id: RtfHeaderFooterGroup.java 3373 2008-05-12 16:21:24Z xlv $
    Author:
    Mark Hall (Mark.Hall@mail.room3b.eu), Thomas Bickel (tmb99@inode.at)

    • Field Summary

      • Fields inherited from class com.lowagie.text.Rectangle

        backgroundColor, border, borderColor, borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderWidth, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop, BOTTOM, BOX, LEFT, llx, lly, NO_BORDER, RIGHT, rotation, TOP, UNDEFINED, urx, ury, useVariableBorders

      • 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, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected RtfHeaderFooter getHeaderAll()
      Gets the RtfHeaderFooter for all pages
      protected RtfHeaderFooter getHeaderFirst()
      Gets the RtfHeaderFooter for the title page
      protected RtfHeaderFooter getHeaderLeft()
      Gets the RtfHeaderFooter for all left hand pages
      protected RtfHeaderFooter getHeaderRight()
      Gets the RtfHeaderFooter for all right hand pages
      protected int getMode()
      Gets the mode of this RtfHeaderFooterGroup
      boolean hasFacingPages()
      Get whether this RtfHeaderFooterGroup has facing pages
      boolean hasTitlePage()
      Get whether this RtfHeaderFooterGroup has a titlepage
      void setHasFacingPages()
      Set that this RtfHeaderFooterGroup should have facing pages.
      void setHasTitlePage()
      Set that this RtfHeaderFooterGroup should have a title page.
      void setHeaderFooter​(com.lowagie.text.HeaderFooter headerFooter, int displayAt)
      Set a HeaderFooter to be displayed at a certain position
      void setHeaderFooter​(RtfHeaderFooter headerFooter, int displayAt)
      Set a RtfHeaderFooter to be displayed at a certain position
      void setInHeader​(boolean inHeader)
      Unused
      void setInTable​(boolean inTable)
      Unused
      void setRtfDocument​(RtfDocument doc)
      Sets the RtfDocument this RtfElement belongs to
      void setType​(int type)
      Set the type of this RtfHeaderFooterGroup.
      void writeContent​(java.io.OutputStream result)
      Write the content of this RtfHeaderFooterGroup.

      • Methods inherited from class com.lowagie.text.HeaderFooter

        alignment, getAfter, getBefore, isNumbered, paragraph, setAlignment, setPageNumber

      • Methods inherited from class com.lowagie.text.Rectangle

        cloneNonPositionParameters, disableBorderSide, enableBorderSide, getBackgroundColor, getBorder, getBorderColor, getBorderColorBottom, getBorderColorLeft, getBorderColorRight, getBorderColorTop, getBorderWidth, getBorderWidthBottom, getBorderWidthLeft, getBorderWidthRight, getBorderWidthTop, getBottom, getBottom, getChunks, getGrayFill, getHeight, getLeft, getLeft, getRight, getRight, getRotation, getTop, getTop, getWidth, hasBorder, hasBorders, isContent, isNestable, isUseVariableBorders, normalize, process, rectangle, rotate, setBackgroundColor, setBorder, setBorderColor, setBorderColorBottom, setBorderColorLeft, setBorderColorRight, setBorderColorTop, setBorderWidth, setBorderWidthBottom, setBorderWidthLeft, setBorderWidthRight, setBorderWidthTop, setBottom, setGrayFill, setLeft, setRight, setRotation, setTop, setUseVariableBorders, softCloneNonPositionParameters, toString, type

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • RtfHeaderFooterGroup

        public RtfHeaderFooterGroup()
        Constructs a RtfHeaderGroup to which you add headers/footers using via the setHeaderFooter method.

      • RtfHeaderFooterGroup

        public RtfHeaderFooterGroup​(RtfDocument doc,
                            int type)
        Constructs a certain type of RtfHeaderFooterGroup. RtfHeaderFooter.TYPE_HEADER and RtfHeaderFooter.TYPE_FOOTER are valid values for type.
        Parameters:
        doc - The RtfDocument this RtfHeaderFooter belongs to
        type - The type of RtfHeaderFooterGroup to create

      • RtfHeaderFooterGroup

        public RtfHeaderFooterGroup​(RtfDocument doc,
                            RtfHeaderFooterGroup headerFooter,
                            int type)
        Constructs a RtfHeaderFooterGroup by copying the content of the original RtfHeaderFooterGroup
        Parameters:
        doc - The RtfDocument this RtfHeaderFooter belongs to
        headerFooter - The RtfHeaderFooterGroup to copy
        type - The type of RtfHeaderFooterGroup to create

      • RtfHeaderFooterGroup

        public RtfHeaderFooterGroup​(RtfDocument doc,
                            RtfHeaderFooter headerFooter,
                            int type)
        Constructs a RtfHeaderFooterGroup for a certain RtfHeaderFooter.
        Parameters:
        doc - The RtfDocument this RtfHeaderFooter belongs to
        headerFooter - The RtfHeaderFooter to display
        type - The type of RtfHeaderFooterGroup to create

      • RtfHeaderFooterGroup

        public RtfHeaderFooterGroup​(RtfDocument doc,
                            com.lowagie.text.HeaderFooter headerFooter,
                            int type)
        Constructs a RtfHeaderGroup for a certain HeaderFooter
        Parameters:
        doc - The RtfDocument this RtfHeaderFooter belongs to
        headerFooter - The HeaderFooter to display
        type - The type of RtfHeaderFooterGroup to create

    • Method Detail

      • setRtfDocument

        public void setRtfDocument​(RtfDocument doc)
        Sets the RtfDocument this RtfElement belongs to
        Specified by:
        setRtfDocument in interface RtfBasicElement
        Parameters:
        doc - The RtfDocument to use

      • writeContent

        public void writeContent​(java.io.OutputStream result)
                  throws java.io.IOException
        Write the content of this RtfHeaderFooterGroup.
        Specified by:
        writeContent in interface RtfBasicElement
        Parameters:
        result - The OutputStream to write the content to
        Throws:
        java.io.IOException

      • setHeaderFooter

        public void setHeaderFooter​(RtfHeaderFooter headerFooter,
                            int displayAt)
        Set a RtfHeaderFooter to be displayed at a certain position
        Parameters:
        headerFooter - The RtfHeaderFooter to display
        displayAt - The display location to use

      • setHeaderFooter

        public void setHeaderFooter​(com.lowagie.text.HeaderFooter headerFooter,
                            int displayAt)
        Set a HeaderFooter to be displayed at a certain position
        Parameters:
        headerFooter - The HeaderFooter to set
        displayAt - The display location to use

      • setHasTitlePage

        public void setHasTitlePage()
        Set that this RtfHeaderFooterGroup should have a title page. If only a header / footer for all pages exists, then it will be copied to the first page as well.

      • setHasFacingPages

        public void setHasFacingPages()
        Set that this RtfHeaderFooterGroup should have facing pages. If only a header / footer for all pages exists, then it will be copied to the left and right pages as well.

      • hasTitlePage

        public boolean hasTitlePage()
        Get whether this RtfHeaderFooterGroup has a titlepage
        Returns:
        Whether this RtfHeaderFooterGroup has a titlepage

      • hasFacingPages

        public boolean hasFacingPages()
        Get whether this RtfHeaderFooterGroup has facing pages
        Returns:
        Whether this RtfHeaderFooterGroup has facing pages

      • setInTable

        public void setInTable​(boolean inTable)
        Unused
        Specified by:
        setInTable in interface RtfBasicElement
        Parameters:
        inTable -

      • setInHeader

        public void setInHeader​(boolean inHeader)
        Unused
        Specified by:
        setInHeader in interface RtfBasicElement
        Parameters:
        inHeader -

      • setType

        public void setType​(int type)
        Set the type of this RtfHeaderFooterGroup. RtfHeaderFooter.TYPE_HEADER or RtfHeaderFooter.TYPE_FOOTER. Also sets the type for all RtfHeaderFooters of this RtfHeaderFooterGroup.
        Parameters:
        type - The type to use

      • getMode

        protected int getMode()
        Gets the mode of this RtfHeaderFooterGroup
        Returns:
        The mode of this RtfHeaderFooterGroup

      • getHeaderAll

        protected RtfHeaderFooter getHeaderAll()
        Gets the RtfHeaderFooter for all pages
        Returns:
        The RtfHeaderFooter for all pages

      • getHeaderFirst

        protected RtfHeaderFooter getHeaderFirst()
        Gets the RtfHeaderFooter for the title page
        Returns:
        The RtfHeaderFooter for the title page

      • getHeaderLeft

        protected RtfHeaderFooter getHeaderLeft()
        Gets the RtfHeaderFooter for all left hand pages
        Returns:
        The RtfHeaderFooter for all left hand pages

      • getHeaderRight

        protected RtfHeaderFooter getHeaderRight()
        Gets the RtfHeaderFooter for all right hand pages
        Returns:
        The RtfHeaderFooter for all right hand pages