org.apache.fop.render.afp.modca

Class IncludePageSegment


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 Summary

Fields inherited from class org.apache.fop.render.afp.modca.AbstractNamedAFPObject

name, nameBytes

Fields inherited from class org.apache.fop.render.afp.modca.AbstractAFPObject

log

Constructor Summary

IncludePageSegment(String name, int x, int y)
Constructor for the Include Page Segment

Method Summary

void
writeDataStream(OutputStream os)
Accessor method to write the AFP datastream for the Include Page Segment

Methods inherited from class org.apache.fop.render.afp.modca.AbstractAFPObject

writeDataStream, writeObjectList

Constructor Details

IncludePageSegment

public IncludePageSegment(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 Details

writeDataStream

public void writeDataStream(OutputStream os)
            throws IOException
Accessor method to write the AFP datastream for the Include Page Segment
Overrides:
writeDataStream in interface AbstractAFPObject
Parameters:
os - The stream to write to

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.