com.mgz.afp.modca

Class IPO_IncludePageOverlay

java.lang.Object

com.mgz.afp.base.StructuredField

com.mgz.afp.base.StructuredFieldBaseTriplets

com.mgz.afp.modca.IPO_IncludePageOverlay

All Implemented Interfaces:

IHasTriplets, IAFPDecodeableWriteable

public class IPO_IncludePageOverlay
extends StructuredFieldBaseTriplets

MO:DCA, page 217.
andProgramming Guide and Line Data Reference(ha3l3r04.pdf), page 101.

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. The current environment of the page that included the overlay is restored when the Include Page Overlay has been completed.

The Include Page Overlay structured field references an overlay resource object that is to be positioned on the page. The overlay contains its own Active Environment Group. For line-mode and mixed-mode applications only, a value of X'FFFFFF' may be used for either the xOrigin, the yOrigin, or both.

Field Summary

Fields inherited from class com.mgz.afp.base.StructuredFieldBaseTriplets

triplets

Constructor Summary

Constructors

Constructor and Description
IPO_IncludePageOverlay()

Method Summary

Modifier and Type	Method and Description
void	decodeAFP(byte[] sfData, int offset, int length, AFPParserConfiguration config) Decodes the given AFP data. Parameter length specifies the length in bytes of the data to be decoded, beginning with position offset.
java.lang.String	getOverlayName()
int	getxOrigin()
AFPOrientation	getxRotation()
int	getyOrigin()
void	setOverlayName(java.lang.String overlayName)
void	setxOrigin(int xOrigin)
void	setxRotation(AFPOrientation xRotation)
void	setyOrigin(int yOrigin)
void	writeAFP(java.io.OutputStream os, AFPParserConfiguration config) Writes the object to the given os encoded as AFP data.

Methods inherited from class com.mgz.afp.base.StructuredFieldBaseTriplets

addTriplet, getTriplets, removeTriplet, setTriplets

Methods inherited from class com.mgz.afp.base.StructuredField

checkDataLength, getActualLength, getPadding, getStructuredFieldIntroducer, isBeginSF, isEndSF, isShallow, setPadding, setStructuredFieldIntroducer, toString, writeFullStructuredField

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IPO_IncludePageOverlay

public IPO_IncludePageOverlay()

Method Detail

decodeAFP

public void decodeAFP(byte[] sfData,
                      int offset,
                      int length,
                      AFPParserConfiguration config)
               throws AFPParserException

Description copied from interface: IAFPDecodeableWriteable

Decodes the given AFP data.
Parameter length specifies the length in bytes of the data to be decoded, beginning with position offset. If parameter length has a value of -1, the given data array is decoded up to the end of the array.

Specified by:

decodeAFP in interface IAFPDecodeableWriteable

Overrides:

decodeAFP in class StructuredFieldBaseTriplets

Parameters:

sfData - contains the AFP data to decode.

offset - the byte index position where the decoding should start.

length - the length in bytes of the data to be decoded, beginning with position offset.

config - contains parameter used for decoding.

Throws:

AFPParserException - if the given AFP data are invalid.

writeAFP

public void writeAFP(java.io.OutputStream os,
                     AFPParserConfiguration config)
              throws java.io.IOException

Description copied from interface: IAFPDecodeableWriteable

Writes the object to the given os encoded as AFP data.

Specified by:

writeAFP in interface IAFPDecodeableWriteable

Overrides:

writeAFP in class StructuredFieldBaseTriplets

Parameters:

os - OutputStream to write to.

config - contains parameter used for encoding.

Throws:

java.io.IOException - if a problem occurs while writing to the given OutputStream.

getOverlayName

public java.lang.String getOverlayName()

setOverlayName

public void setOverlayName(java.lang.String overlayName)

getxOrigin

public int getxOrigin()

setxOrigin

public void setxOrigin(int xOrigin)

getyOrigin

public int getyOrigin()

setyOrigin

public void setyOrigin(int yOrigin)

getxRotation

public AFPOrientation getxRotation()

setxRotation

public void setxRotation(AFPOrientation xRotation)