Class IncludePageSegment

  • All Implemented Interfaces:
    Streamable

    public class IncludePageSegment
    extends AbstractNamedAFPObject
    The Include Page Segment structured field references a page segment resource object that is to be presented on the page or overlay presentation space. The IPS specifies a reference point on the including page or overlay coordinate system that may be used to position objects contained in the page segment. A page segment can be referenced at any time during page or overlay state, but not during an object state. The page segment inherits the active environment group definition of the including page or overlay. Note : No use for Triplets. A 'real' example for where this will be used is for the dynamic placing of overlay objects, such as signatures that may have to be placed at different positions on a document.
    • Field Detail

      • x

        private int x
        The x position where we need to put this object on the page
      • y

        private int y
        The y position where we need to put this object on the page
    • Constructor Detail

      • IncludePageSegment

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

      • 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.