com.mgz.afp.modca

Class PGP_PagePosition_Format2

java.lang.Object

com.mgz.afp.base.StructuredField

com.mgz.afp.base.StructuredFieldBaseRepeatingGroups

com.mgz.afp.modca.PGP_PagePosition_Format2

All Implemented Interfaces:

IHasRepeatingGroups, IAFPDecodeableWriteable

public class PGP_PagePosition_Format2
extends StructuredFieldBaseRepeatingGroups

MO:DCA, page 312.

The Page Position structured field specifies the position and orientation of a page's presentation space on the medium presentation space for the physical medium. The PGP may be located in a medium map or in the document environment group of a form map. When present in the active medium map, it overrides a PGP in the document environment group of the form map. If N-up partitioning is specified by the Medium Modification Control structured field in the active medium map, the medium presentation spaces on the front and back sides of a sheet are divided into N partitions; and the Page Position structured field specifies the partition into which each page is mapped and with respect to which the page presentation space is positioned and oriented. The N-up page-to-partition mapping can be specified in two mutually exclusive ways:

• Default N-up page placement. Pages are processed in the order in which they appear in the data stream and are placed into consecutively-numbered partitions, that is, the first page is placed into partition 1, the second page is placed into partition 2, the third page is placed into partition 3, and the 4th page is placed into partition 4. Partition numbering for various media is shown in Figure 58 on page 320 to Figure 69 on page 326.
• Explicit N-up page placement. Pages are processed in the order in which they appear in the data stream and are placed into the partition that is explicitly specified by the repeating group for the page. Multiple pages may be placed into the same partition. If N-up simplex is specified, the Page Position structured field must contain N repeating groups, one for each page on the sheet-side. If N-up duplex is specified, the Page Position structured field must contain 2N repeating groups, one for each page on the sheet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PGP_PagePosition_Format2.PGP_RepeatingGroup

Field Summary

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

repeatingGroups

Constructor Summary

Constructors

Constructor and Description
PGP_PagePosition_Format2()

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.
byte	getConstant0()
void	setConstant0(byte constant0)
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.StructuredFieldBaseRepeatingGroups

addRepeatingGroup, getRepeatingGroups, removeRepeatingGroup, setRepeatingGroups

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

PGP_PagePosition_Format2

public PGP_PagePosition_Format2()

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

Specified by:

decodeAFP in class StructuredField

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

Specified by:

writeAFP in class StructuredField

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.

getConstant0

public byte getConstant0()

setConstant0

public void setConstant0(byte constant0)