com.mgz.afp.modca

Class IOB_IncludeObject

java.lang.Object

com.mgz.afp.base.StructuredField

com.mgz.afp.base.StructuredFieldBaseName

com.mgz.afp.modca.IOB_IncludeObject

All Implemented Interfaces:

IHasName, IAFPDecodeableWriteable

public class IOB_IncludeObject
extends StructuredFieldBaseName

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

An Include Object structured field references an object and optionally contains parameters that identify the object and that specify presentation parameters such as object position, size, orientation, mapping, and default color. Where the presentation parameters conflict with parameters specified in the object’s environment group (OEG), the parameters in the Include Object structured field override. If the referenced object is a page segment, the IOB parameters override the corresponding environment group parameters on all data objects in the page segment.

Field Summary

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

name

Constructor Summary

Constructors

Constructor and Description
IOB_IncludeObject()

Method Summary

Modifier and Type	Method and Description
void	addTriplet(Triplet triplet)
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.
AFPObjectType	getObjectType()
byte	getReferenceCoordinateSystem()
byte	getReserved8()
java.util.List<Triplet>	getTriplets()
int	getxOrigin()
int	getxOriginOfContent()
AFPOrientation	getxRotation()
int	getyOrigin()
int	getyOriginOfContent()
AFPOrientation	getyRotation()
void	removeTriplet(Triplet triplet)
void	setObjectType(AFPObjectType objectType)
void	setReferenceCoordinateSystem(byte referenceCoordinateSystem)
void	setReserved8(byte reserved8)
void	setTriplets(java.util.List<Triplet> triplets)
void	setxOrigin(int xOrigin)
void	setxOriginOfContent(int xOriginOfContent)
void	setxRotation(AFPOrientation xRotation)
void	setyOrigin(int yOrigin)
void	setyOriginOfContent(int yOriginOfContent)
void	setyRotation(AFPOrientation yRotation)
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.StructuredFieldBaseName

getName, setName

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

IOB_IncludeObject

public IOB_IncludeObject()

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 StructuredFieldBaseName

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 StructuredFieldBaseName

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.

getReserved8

public byte getReserved8()

setReserved8

public void setReserved8(byte reserved8)

getObjectType

public AFPObjectType getObjectType()

setObjectType

public void setObjectType(AFPObjectType objectType)

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)

getyRotation

public AFPOrientation getyRotation()

setyRotation

public void setyRotation(AFPOrientation yRotation)

getxOriginOfContent

public int getxOriginOfContent()

setxOriginOfContent

public void setxOriginOfContent(int xOriginOfContent)

getyOriginOfContent

public int getyOriginOfContent()

setyOriginOfContent

public void setyOriginOfContent(int yOriginOfContent)

getReferenceCoordinateSystem

public byte getReferenceCoordinateSystem()

setReferenceCoordinateSystem

public void setReferenceCoordinateSystem(byte referenceCoordinateSystem)

getTriplets

public java.util.List<Triplet> getTriplets()

setTriplets

public void setTriplets(java.util.List<Triplet> triplets)

addTriplet

public final void addTriplet(Triplet triplet)

removeTriplet

public final void removeTriplet(Triplet triplet)