Class TextHeaderFooter

    • Constructor Detail

      • TextHeaderFooter

        public TextHeaderFooter​(String leftText,
                                String centerText,
                                String rightText)
        Creates a text based PDF Header and Footer.
        Parameters:
        leftText - the left text. Default is null.
        centerText - the center text. Default is null.
        rightText - the right text. Default is null.
    • Method Detail

      • getCenterText

        public String getCenterText()
        Gets center text. The centered header text for the PDF document.

        Merge meta-data into your header using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}

        Returns:
        the center text
      • setCenterText

        public void setCenterText​(String value)
        Sets center text. The centered header text for the PDF document.

        Merge meta-data into your header using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}

        Parameters:
        value - the value
      • isDrawDividerLine

        public boolean isDrawDividerLine()
        Is draw divider line boolean. A horizontal line divider between the header / footer and the page content on every page of the PDF document.
        Returns:
        the boolean
      • setDrawDividerLine

        public void setDrawDividerLine​(boolean value)
        Sets draw divider line. A horizontal line divider between the header / footer and the page content on every page of the PDF document.
        Parameters:
        value - the value
      • getFont

        public FontTypes getFont()
        Gets font.
        Returns:
        the font
      • setFont

        public void setFont​(FontTypes value)
        Sets font.
        Parameters:
        value - the value
      • getFontSize

        public double getFontSize()
        Gets font size.
        Returns:
        the font size
      • setFontSize

        public void setFontSize​(double value)
        Sets font size.
        Parameters:
        value - the value
      • getLeftText

        public String getLeftText()
        Gets left text. The left hand side header text for the PDF document.

        Merge meta-data into your header using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}

        Returns:
        the left text
      • setLeftText

        public void setLeftText​(String value)
        Sets left text. The left hand side header text for the PDF document.

        Merge meta-data into your header using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}

        Parameters:
        value - the value
      • getRightText

        public String getRightText()
        Gets right text. The right hand side header text for the PDF document.

        Merge meta-data into your header using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}

        Returns:
        the right text
      • setRightText

        public void setRightText​(String value)
        Sets right text. The right hand side header text for the PDF document.

        Merge meta-data into your header using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}

        Parameters:
        value - the value
      • getSpacing

        public double getSpacing()
        Gets spacing.
        Returns:
        the spacing
      • setSpacing

        public void setSpacing​(double value)
        Sets spacing.
        Parameters:
        value - the value