fllogosm
 Main
 User's Guide
 Developer's Guide
 Admin's Guide
 FAQ
 License Info
 Feedback
 PageSettings

The PageSettings object

Constructor:

PageSettings()
        A simple constructor.

Methods:

getBottomMargin()
        Gets the bottom margin (int, in pixels) value.
getFooterAlign()
        Gets the footer alignment (int) value.
getFooterBG()
        Gets the footer background (java.awt.Color) value.
getFooterFG()
        Gets the footer foreground (java.awt.Color) value.
getFooterFont()
        Gets the footer font (java.awt.Font) value.
getFooterHeight()
        Gets the footer height (int, in pixels) value.
getFooterText()
        Gets the footer text (java.lang.String) value.
getHeaderAlign()
        Gets the header alignment (int) value.
getHeaderBG()
        Gets the header background (java.awt.Color) value.
getHeaderFG()
        Gets the header foreground (java.awt.Color) value.
getHeaderFont()
        Gets the header font (java.awt.Font) value.
getHeaderHeight()
        Gets the header height (int, in pixels) value.
getHeaderText()
        Gets the header text (java.lang.String) value.
getImageAlign()
        Gets the image alignment (int) value.
getImagePath()
        Gets the image path and file name (java.lang.String) value.
getLeftMargin()
        Gets the left margin (int, in pixels) value.
getPageAlign()
        Gets the page alignment (int) value.
getPageBG()
        Gets the page background (java.awt.Color) value.
getPageFG()
        Gets the page foreground (java.awt.Color) value.
getRightMargin()
        Gets the right margin (int, in pixels) value.
getTopMargin()
        Gets the top margin (int, in pixels) value.
setBottomMargin(int)
        Sets the bottom margin (int, in pixels) value.
setFooterAlign(int)
        Sets the footer alignment (int) value.
setFooterBG(Color)
        Sets the footer background (java.awt.Color) value.
setFooterFG(Color)
        Sets the footer foreground (java.awt.Color) value.
setFooterFont(Font)
        Sets the footer font (java.awt.Font) value.
setFooterHeight(int)
        Sets the footer height (int, in pixels) value.
setFooterText(String)
        Sets the footer text (java.lang.String) value.
setHeaderAlign(int)
        Sets the header alignment (int) value.
setHeaderBG(Color)
        Sets the header background (java.awt.Color) value.
setHeaderFG(Color)
        Sets the header foreground (java.awt.Color) value.
setHeaderFont(Font)
        Sets the header font (java.awt.Font) value.
setHeaderHeight(int)
        Sets the header height (int, in pixels) value.
setHeaderText(String)
        Sets the header text (java.lang.String) value.
setImageAlign(int)
        Sets the image alignment (int) value.
setImagePath(String)
        Sets the image path and file name (java.lang.String) value.
setLeftMargin(int)
        Sets the left margin (int, in pixels) value.
setPageAlign(int)
        Sets the page alignment (int) value.
setPageBG(Color)
        Sets the page background (java.awt.Color) value.
setPageFG(Color)
        Sets the page foreground (java.awt.Color) value.
setRightMargin(int)
        Sets the right margin (int, in pixels) value.
setTopMargin(int)
        Sets the top margin (int, in pixels) value.

Constructor:

PageSettings


 public PageSettings()
 


        A simple constructor.

Methods:

getBottomMargin


 public int getBottomMargin()
 


        Gets the bottom margin, in pixels.
       

    Returns:
                    The bottomMargin property value. See Also:
                   
    setBottomMargin

getFooterAlign


 public int getFooterAlign()
 


        Gets the footerAlign property (int) value.

Values can be:

  • 0 (zero), meaning right-aligned.
  • 1 (one), meaning left-aligned.
  • 2 (two), meaning centered.


        Returns:
        The footerAlign property value.
        See Also:
       
setFooterAlign

getFooterBG


 public Color getFooterBG()
 


        Gets the footerBG property (java.awt.Color) value.
       

    Returns:
                    The footerBG property value. See Also:
                   
    setFooterBG

getFooterFG


 public Color getFooterFG()
 


        Gets the footerFG property (java.awt.Color) value.
       

    Returns:
                    The footerFG property value. See Also:
                   
    setFooterFG

getFooterFont


 public Font getFooterFont()
 


        Gets the footerFont property (java.awt.Font) value.
       

    Returns:
                    The footerFont property value. See Also:
                   
    setFooterFont

getFooterHeight


 public int getFooterHeight()
 


        Gets the footerHeight property (int) value (units: pixels).
        Returns:


                    The footerHeight property value. See Also:
                   
    setFooterHeight

getFooterText


 public String getFooterText()
 


        Gets the footerText property (java.lang.String) value.
        You can embed the following macros in the text:

    • $D will expand into current date and time.
    • $P will expand into current page.
    • $T will expand into total number of pages.

    Returns:
                    The footerText property value. See Also:
                   
    setFooterText

getHeaderAlign


 public int getHeaderAlign()
 


        Gets the headerAlign property (int) value.

Values can be:

  • 0 (zero), meaning right-aligned.
  • 1 (one), meaning left-aligned.
  • 2 (two), meaning centered.


       

    Returns:
                    The headerAlign property value. See Also:
                   
    setHeaderAlign

getHeaderBG


 public Color getHeaderBG()
 


        Gets the headerBG property (java.awt.Color) value.
       

    Returns:
                    The headerBG property value. See Also:
                   
    setHeaderBG

getHeaderFG


 public Color getHeaderFG()
 


        Gets the headerFG property (java.awt.Color) value.
       

    Returns:
                    The headerFG property value. See Also:
                   
    setHeaderFG

getHeaderFont


 public Font getHeaderFont()
 


        Gets the headerFont property (java.awt.Font) value.
       

    Returns:
                    The headerFont property value. See Also:
                   
    setHeaderFont

getHeaderHeight


 public int getHeaderHeight()
 


        Gets the headerHeight property (int) value (units: pixels).
       

    Returns:
                    The headerHeight property value. See Also:
                   
    setHeaderHeight

getHeaderText


 public String getHeaderText()
 


        Gets the headerText property (java.lang.String) value.
        You can embed the following macros in the text:

    • $D will expand into current date and time.
    • $P will expand into current page.
    • $T will expand into total number of pages.

    Returns:
                    The headerText property value. See Also:
                   
    setHeaderText

     

getImageAlign


 public int getImageAlign()
 


        Gets the image alignment value (how the image will be
        laid out in the page).  
        Values can be:

    • 0 (zero), meaning "centered".
    • 1 (one), meaning "maximized" (retaining aspect).
    • 2 (two), meaning "tiled".

    Returns:


                    The imageAlign property value. See Also:
                   
    setImageAlign

getImagePath


 public String getImagePath()
 


        Gets the background image path and file name (String).
       

    Returns:
                    The imagePath property value. See Also:
                   
    setImagePath

getLeftMargin


 public int getLeftMargin()
 


        Gets the left margin, in pixels.
       

    Returns:
                    The leftMargin property value. See Also:
                   
    setLeftMargin

getPageAlign


 public int getPageAlign()
 


        Gets the pageAlign property (int) value.
        Values can be:

    • 0 (zero), meaning right-aligned.
    • 1 (one), meaning left-aligned.
    • 2 (two), meaning centered.

    Returns:
                    The pageAlign property value. See Also:
                   
    setPageAlign

getPageBG


 public Color getPageBG()
 


        Gets the pageBG property (java.awt.Color) value.
       

    Returns:
                    The pageBG property value. See Also:
                   
    setPageBG

getPageFG


 public Color getPageFG()
 


        Gets the pageFG property (java.awt.Color) value.
       

    Returns:
                    The pageFG property value. See Also:
                   
    setPageFG

getRightMargin


 public int getRightMargin()
 


        Gets the right margin, in pixels.
       

    Returns:
                    The rightMargin property value. See Also:
                   
    setRightMargin

getTopMargin


 public int getTopMargin()
 


        Gets the top margin, in pixels.
       

    Returns:
                    The topMargin property value. See Also:
                   
    setTopMargin

setBottomMargin


 public void setBottomMargin(int bottomMargin)
 


        Sets the bottom margin, in pixels.
       

    Parameters:
                    bottomMargin - The new value for the property. See Also:
                   
    getBottomMargin

setFooterAlign


 public void setFooterAlign(int footerAlign)
 


        Sets the footerAlign property (int) value.
        Values can be:

    • 0 (zero), meaning right-aligned.
    • 1 (one), meaning left-aligned.
    • 2 (two), meaning centered.

    Parameters:
                    footerAlign - The new value for the property. See Also:
                   
    getFooterAlign

setFooterBG


 public void setFooterBG(Color footerBG)
 


        Sets the footerBG property (java.awt.Color) value.
       

    Parameters:
                    footerBG - The new value for the property. See Also:
                   
    getFooterBG

setFooterFG


 public void setFooterFG(Color footerFG)
 


        Sets the footerFG property (java.awt.Color) value.
       

    Parameters:
                    footerFG - The new value for the property. See Also:
                   
    getFooterFG

setFooterFont


 public void setFooterFont(Font footerFont)
 


        Sets the footerFont property (java.awt.Font) value.
       

    Parameters:
                    footerFont - The new value for the property. See Also:
                   
    getFooterFont

setFooterHeight


 public void setFooterHeight(int footerHeight)
 


        Sets the footerHeight property (int) value (units: pixels).
       

    Parameters:
                    footerHeight - The new value for the property. See Also:
                   
    getFooterHeight

setFooterText


 public void setFooterText(String footerText)
 


        Sets the footerText property (java.lang.String) value.
        You can embed the following macros in the text:

    • $D will expand into current date and time.
    • $P will expand into current page.
    • $T will expand into total number of pages.

    Parameters:
                    footerText - The new value for the property. See Also:
                   
    getFooterText

setHeaderAlign


 public void setHeaderAlign(int headerAlign)
 


        Sets the headerAlign property (int) value.
        Values can be:

    • 0 (zero), meaning right-aligned.
    • 1 (one), meaning left-aligned.
    • 2 (two), meaning centered.

    Parameters:
                    headerAlign - The new value for the property. See Also:
                   
    getHeaderAlign

setHeaderBG


 public void setHeaderBG(Color headerBG)
 


        Sets the headerBG property (java.awt.Color) value.
       

    Parameters:
                    headerBG - The new value for the property. See Also:
                   
    getHeaderBG

setHeaderFG


 public void setHeaderFG(Color headerFG)
 


        Sets the headerFG property (java.awt.Color) value.
       

    Parameters:
                    headerFG - The new value for the property. See Also:
                   
    getHeaderFG

setHeaderFont


 public void setHeaderFont(Font headerFont)
 


        Sets the headerFont property (java.awt.Font) value.
       

    Parameters:
                    headerFont - The new value for the property. See Also:
                   
    getHeaderFont

setHeaderHeight


 public void setHeaderHeight(int headerHeight)
 


        Sets the headerHeight property (int) value (units: pixels).
       

    Parameters:
                    headerHeight - The new value for the property. See Also:
                   
    getHeaderHeight

setHeaderText


 public void setHeaderText(String headerText)
 


        Sets the headerText property (java.lang.String) value.
        You can embed the following macros in the text:

    • $D will expand into current date and time.
    • $P will expand into current page.
    • $T will expand into total number of pages.

    Parameters:
                    headerText - The new value for the property. See Also:
                   
    getHeaderText

setImageAlign


 public void setImageAlign(int imageAlign)
 


        Sets the image alignment value (how the image will be
        laid out in the page).  
        Values can be:

    • 0 (zero), meaning "centered".
    • 1 (one), meaning "maximized" (retaining aspect).
    • 2 (two), meaning "tiled".

    Parameters:


                    imageAlign - The new value for the property. See Also:
                   
    getImageAlign

setImagePath


 public void setImagePath(String imagePath)
 


        Sets the background image path and file name (String).
       

    Parameters:
                    imagePath - The new value for the property. See Also:
                   
    getImagePath

setLeftMargin


 public void setLeftMargin(int leftMargin)
 


        Sets the left margin, in pixels.
       

    Parameters:
                    leftMargin - The new value for the property. See Also:
                   
    getLeftMargin

setPageAlign


 public void setPageAlign(int pageAlign)
 


        Sets the pageAlign property (int) value.
        Values can be:

    • 0 (zero), meaning right-aligned.
    • 1 (one), meaning left-aligned.
    • 2 (two), meaning centered.

    Parameters:
                    pageAlign - The new value for the property. See Also:
                   
    getPageAlign

setPageBG


 public void setPageBG(Color pageBG)
 


        Sets the pageBG property (java.awt.Color) value.
       

    Parameters:
                    pageBG - The new value for the property. See Also:
                   
    getPageBG

setPageFG


 public void setPageFG(Color pageFG)
 


        Sets the pageFG property (java.awt.Color) value.
       

    Parameters:
                    pageFG - The new value for the property. See Also:
                   
    getPageFG

setRightMargin


 public void setRightMargin(int rightMargin)
 


        Sets the right margin, in pixels.
       

    Parameters:
                    rightMargin - The new value for the property. See Also:
                   
    getRightMargin

setTopMargin


 public void setTopMargin(int topMargin)
 


        Sets the top margin, in pixels.
       

    Parameters:
                    topMargin - The new value for the property. See Also:
                   
    getTopMargin