com.mgz.afp.modca

Class OBP_ObjectAreaPosition

java.lang.Object

com.mgz.afp.base.StructuredField

com.mgz.afp.modca.OBP_ObjectAreaPosition

All Implemented Interfaces:

IAFPDecodeableWriteable

public class OBP_ObjectAreaPosition
extends StructuredField

MO:DCA, page 298.

The Object Area Descriptor structured field specifies the size and attributes of an object area presentation space.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OBP_ObjectAreaPosition.OBP_RepeatingGroup

Constructor Summary

Constructors

Constructor and Description
OBP_ObjectAreaPosition()

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	getObjectAreaPositionID()
OBP_ObjectAreaPosition.OBP_RepeatingGroup	getRepeatingGroup()
void	setObjectAreaPositionID(byte objectAreaPositionID)
void	setRepeatingGroup(OBP_ObjectAreaPosition.OBP_RepeatingGroup repeatingGroup)
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.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

OBP_ObjectAreaPosition

public OBP_ObjectAreaPosition()

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.

getObjectAreaPositionID

public byte getObjectAreaPositionID()

setObjectAreaPositionID

public void setObjectAreaPositionID(byte objectAreaPositionID)

getRepeatingGroup

public OBP_ObjectAreaPosition.OBP_RepeatingGroup getRepeatingGroup()

setRepeatingGroup

public void setRepeatingGroup(OBP_ObjectAreaPosition.OBP_RepeatingGroup repeatingGroup)