Class PageIncludeFormat


  • public class PageIncludeFormat
    extends java.lang.Object

    Class that contains the format of a PDF page.

    Project:

    Library for the integration with the services of @Firma, eVisor and TS@.

    Version:
    1.0, 19/08/2020.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String BACK_LAYOUT
      Attribute that represents the constant used to indicate the layout is back.
      static java.lang.String FRONT_LAYOUT
      Attribute that represents the constant used to indicate the layout is front.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      double getHeight()
      Gets the page height.
      java.lang.String getLayout()
      Gets the value of the page layout.
      double getWidth()
      Gets the page width.
      double getXpos()
      Gets the X position.
      double getYpos()
      Gets the Y position.
      void setHeight​(double pageHeight)
      Sets the page height.
      void setLayout​(java.lang.String layer)
      Sets the value of the page layout.
      void setWidth​(double pageWidth)
      Sets the page width.
      void setXpos​(double pos)
      Sets the X position.
      void setYpos​(double pos)
      Sets the Y position in millimeters.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • FRONT_LAYOUT

        public static final java.lang.String FRONT_LAYOUT
        Attribute that represents the constant used to indicate the layout is front.
        See Also:
        Constant Field Values
      • BACK_LAYOUT

        public static final java.lang.String BACK_LAYOUT
        Attribute that represents the constant used to indicate the layout is back.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PageIncludeFormat

        public PageIncludeFormat()
    • Method Detail

      • getYpos

        public double getYpos()
        Gets the Y position.
        Returns:
        Position in millimeters.
      • getLayout

        public java.lang.String getLayout()
        Gets the value of the page layout.
        Returns:
        the value of the page layout.
      • setLayout

        public void setLayout​(java.lang.String layer)
        Sets the value of the page layout.
        Parameters:
        layer - The value for the page layout.
      • setYpos

        public void setYpos​(double pos)
        Sets the Y position in millimeters.
        Parameters:
        pos - Y position in millimeters.
      • getXpos

        public double getXpos()
        Gets the X position.
        Returns:
        Position in millimeters.
      • setXpos

        public void setXpos​(double pos)
        Sets the X position.
        Parameters:
        pos - Position in millimeters.
      • getWidth

        public double getWidth()
        Gets the page width.
        Returns:
        Width in millimeters.
      • setWidth

        public void setWidth​(double pageWidth)
        Sets the page width.
        Parameters:
        pageWidth - Width in millimeters.
      • getHeight

        public double getHeight()
        Gets the page height.
        Returns:
        Height in millimeters.
      • setHeight

        public void setHeight​(double pageHeight)
        Sets the page height.
        Parameters:
        pageHeight - Height in millimeters.