Package org.apache.fop.render.pcl

Class PCLPageDefinition

  • public class PCLPageDefinition
extends java.lang.Object
    This class represents a page format with PCL-specific properties.

    • Constructor Detail

      • PCLPageDefinition

        public PCLPageDefinition​(java.lang.String name,
                         int selector,
                         java.awt.Dimension physicalPageSize,
                         java.awt.Rectangle logicalPageRect,
                         boolean landscape)
        Main constructor
        Parameters:
        name - the name of the page definition
        selector - the selector used by the <ESC> command (page size)
        physicalPageSize - the physical page size
        logicalPageRect - the rectangle defining the logical page
        landscape - true if it is a landscape format

    • Method Detail

      • getName

        public java.lang.String getName()
        Returns:
        the name of the page definition

      • getSelector

        public int getSelector()
        Returns:
        the selector used by the <ESC> command (page size)

      • isLandscapeFormat

        public boolean isLandscapeFormat()
        Returns:
        true if it is a landscape format

      • getPhysicalPageSize

        public java.awt.Dimension getPhysicalPageSize()
        Returns:
        the physical page size

      • getLogicalPageRect

        public java.awt.Rectangle getLogicalPageRect()
        Returns:
        the rectangle defining the logical page

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getPageDefinition

        public static PCLPageDefinition getPageDefinition​(long width,
                                                  long height,
                                                  int errorMargin)
        Tries to determine a matching page definition.
        Parameters:
        width - the physical page width (in mpt)
        height - the physical page height (in mpt)
        errorMargin - the error margin for detecting the right page definition
        Returns:
        the page definition or null if no match was found

      • getPageDefinition

        public static PCLPageDefinition getPageDefinition​(java.lang.String name)
        Returns a page definition based on a page format.
        Parameters:
        name - the name of the page format (ex. "A4" or "Letter")
        Returns:
        the page definition or null if no match was found

      • getDefaultPageDefinition

        public static PCLPageDefinition getDefaultPageDefinition()
        Returns:
        the default page definition (letter)