org.apache.fop.render.afp.modca
Class IncludePageOverlay

java.lang.Object
  extended byorg.apache.fop.render.afp.modca.AFPObject
      extended byorg.apache.fop.render.afp.modca.IncludePageOverlay

public class IncludePageOverlay
extends AFPObject

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. Further note: Although an IPO needs x, y coordinates in the MODCA standard due to the way IPO's are implemented over on the mainframe (being static) I have 'hardwired' the x+y to 0, as they do infact not get used. So the only thing that will be dynamic and controlled by the FO is the orientation.


Field Summary
 
Fields inherited from class org.apache.fop.render.afp.modca.AFPObject
LOGGER
 
Constructor Summary
IncludePageOverlay(java.lang.String overlayName)
           
 
Method Summary
 byte[] getDataStream()
          DataStream objects must implement the getDataStream() method to return a byte array of the AFP datastream.
 void setOrientation(int orientation)
          Sets the orienation to use for the overlay.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IncludePageOverlay

public IncludePageOverlay(java.lang.String overlayName)
Method Detail

setOrientation

public void setOrientation(int orientation)
Sets the orienation to use for the overlay.

Parameters:
orientation - The orientation (0,90, 180, 270)

getDataStream

public byte[] getDataStream()
Description copied from class: AFPObject
DataStream objects must implement the getDataStream() method to return a byte array of the AFP datastream.

Specified by:
getDataStream in class AFPObject
Returns:
byte[] The AFP data stream