Package org.jpedal.tools

Class PdfMergeAttributes

java.lang.Object
org.jpedal.tools.PdfMergeAttributes
public class PdfMergeAttributes extends Object
Class to hold resource values to be used by the PdfMerge tool

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    PdfMergeAttributes.MergeAttributes
    Attribute names used on the command line These attributes control the appearance and features of the various Pdf Merge options

  • Constructor Summary

    Constructors
    Constructor
    Description
    PdfMergeAttributes()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFontName()
    Returns the name of the font to be used in newly created content from the PdfMerge MergeOptions.
    int
    getFontSize()
    Returns the size of the font to be used in newly created content from the PdfMerge MergeOptions.
    int
    getFooterHeight()
    Returns the height of the footer to be created in newly created content from the PdfMerge MergeOptions.
    String
    getFooterTemplate()
    Returns the template used by the ADD_FOOTER MergeOption, detailing what content to add to the newly created footer.
    float[]
    getTextColor()
    Returns the color of the text to be used in newly created content from the PdfMerge MergeOptions, as 3 values between 0 - 1 that represent an RGB color.
    void
    setFontName(String name)
    Specify the font to use for new content created by PdfMerge MergeOptions.
    void
    setFontSize(int size)
    Specify the font size to use for new content created by PdfMerge MergeOptions.
    void
    setFooterHeight(int height)
    Specify the height of any footer generate created by PdfMerge MergeOptions.
    void
    setFooterTemplate(String template)
    Specify a template to be used with the ADD_FOOTER MergeOption.
    void
    setTextColor(float[] color)
    Specify the text color to use for new content created by PdfMerge MergeOptions.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PdfMergeAttributes

      public PdfMergeAttributes()

  • Method Details

    • setFontName

      public void setFontName(String name)
      Specify the font to use for new content created by PdfMerge MergeOptions.
      Parameters:
      name - the name of the base font to use. See BaseFont

    • setFontSize

      public void setFontSize(int size)
      Specify the font size to use for new content created by PdfMerge MergeOptions.
      Parameters:
      size - the font size to use when creating text

    • setFooterHeight

      public void setFooterHeight(int height)
      Specify the height of any footer generate created by PdfMerge MergeOptions.
      Parameters:
      height - the height of the Footer in PDF coordinates

    • setFooterTemplate

      public void setFooterTemplate(String template)
      Specify a template to be used with the ADD_FOOTER MergeOption. The template has 2 dynamic variables that will be replaced with document and page specific values. %FILENAME - is replaced with the original files name. %PAGENUMBER - is replaced with the original page number of this page in the original file.
      Parameters:
      template - the template to be used when generating a footer

    • setTextColor

      public void setTextColor(float[] color)
      Specify the text color to use for new content created by PdfMerge MergeOptions.
      Parameters:
      color - the color for text content as an array of 3 values to represent an RGB color The values must be between 0 - 1.

    • getFontName

      public String getFontName()
      Returns the name of the font to be used in newly created content from the PdfMerge MergeOptions.
      Returns:
      the name of the font to be used in newly created content from the PdfMerge MergeOptions

    • getFontSize

      public int getFontSize()
      Returns the size of the font to be used in newly created content from the PdfMerge MergeOptions.
      Returns:
      the size of the font to be used in newly created content from the PdfMerge MergeOptions

    • getFooterHeight

      public int getFooterHeight()
      Returns the height of the footer to be created in newly created content from the PdfMerge MergeOptions.
      Returns:
      the height of the footer to be created in newly created content from the PdfMerge MergeOptions

    • getFooterTemplate

      public String getFooterTemplate()
      Returns the template used by the ADD_FOOTER MergeOption, detailing what content to add to the newly created footer.
      Returns:
      the template used by the ADD_FOOTER MergeOption, detailing what content to add to the newly created footer

    • getTextColor

      public float[] getTextColor()
      Returns the color of the text to be used in newly created content from the PdfMerge MergeOptions, as 3 values between 0 - 1 that represent an RGB color.
      Returns:
      the color of the text to be used in newly created content from the PdfMerge MergeOptions, as 3 values between 0 - 1 that represent an RGB color