com.mgz.afp.modca

Class IPS_IncludePageSegment

java.lang.Object

com.mgz.afp.base.StructuredField

com.mgz.afp.base.StructuredFieldBaseTriplets

com.mgz.afp.modca.IPS_IncludePageSegment

All Implemented Interfaces:

IHasTriplets, IAFPDecodeableWriteable

public class IPS_IncludePageSegment
extends StructuredFieldBaseTriplets

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

The Include Page Segment structured field references a page segment resource object that is to be positioned on the page or overlay. For line-mode or mixed-mode applications only, a value of X'FFFFFF' may be used for either the xOrigin, the yOrigin, or both.

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.

Field Summary

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

triplets

Constructor Summary

Constructors

Constructor and Description
IPS_IncludePageSegment()

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	getPageSegmentName()
int	getxOrigin()
int	getyOrigin()
void	setPageSegmentName(java.lang.String pageSegmentName)
void	setxOrigin(int xOrigin)
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

IPS_IncludePageSegment

public IPS_IncludePageSegment()

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.

getPageSegmentName

public java.lang.String getPageSegmentName()

setPageSegmentName

public void setPageSegmentName(java.lang.String pageSegmentName)

getxOrigin

public int getxOrigin()

setxOrigin

public void setxOrigin(int xOrigin)

getyOrigin

public int getyOrigin()

setyOrigin

public void setyOrigin(int yOrigin)