Class IncludePageOverlay

  • All Implemented Interfaces:
    Streamable

    public class IncludePageOverlay
    extends AbstractNamedAFPObject
    The Include Page Overlay structured field references an overlay resource definition that is to be positioned on the page. A page overlay can be referenced at any time during the page state, but not during an object state. The overlay contains its own active environment group definition. Note: There is no need for the triplets, so I have ignored them. A real example of where this will be used is for static overlays, such as an address on the page.
    • Field Detail

      • x

        private int x
        The x coordinate
      • y

        private int y
        The y coordinate
      • orientation

        private int orientation
        The orientation
    • Constructor Detail

      • IncludePageOverlay

        public IncludePageOverlay​(java.lang.String overlayName,
                                  int x,
                                  int y,
                                  int orientation)
        Constructor for the Include Page Overlay
        Parameters:
        overlayName - Name of the page segment
        x - The x position
        y - The y position
        orientation - The orientation
    • Method Detail

      • setOrientation

        public void setOrientation​(int orientation)
        Sets the orientation to use for the overlay.
        Parameters:
        orientation - The orientation (0,90, 180, 270)
      • writeToStream

        public void writeToStream​(java.io.OutputStream os)
                           throws java.io.IOException
        DataStream objects must implement the writeToStream() method to write its data to the given OutputStream
        Specified by:
        writeToStream in interface Streamable
        Overrides:
        writeToStream in class AbstractStructuredObject
        Parameters:
        os - the outputsteam stream
        Throws:
        java.io.IOException - an I/O exception of some sort has occurred.