com.mgz.afp.ptoca.controlSequence

Class PTOCAControlSequence.TRN_TransparentData

java.lang.Object

com.mgz.afp.ptoca.controlSequence.PTOCAControlSequence

com.mgz.afp.ptoca.controlSequence.PTOCAControlSequence.TRN_TransparentData

All Implemented Interfaces:

IAFPDecodeableWriteable

Enclosing class:

PTOCAControlSequence

public static class PTOCAControlSequence.TRN_TransparentData
extends PTOCAControlSequence

Nested Class Summary

Nested classes/interfaces inherited from class com.mgz.afp.ptoca.controlSequence.PTOCAControlSequence

PTOCAControlSequence.AMB_AbsoluteMoveBaseline, PTOCAControlSequence.AMI_AbsoluteMoveInline, PTOCAControlSequence.BLN_BeginLine, PTOCAControlSequence.BSU_BeginSuppression, PTOCAControlSequence.ControlSequenceFunctionType, PTOCAControlSequence.ControlSequenceIntroducer, PTOCAControlSequence.DBR_DrawBaxisRule, PTOCAControlSequence.DIR_DrawIaxisRule, PTOCAControlSequence.ESU_EndSuppression, PTOCAControlSequence.NOP_NoOperation, PTOCAControlSequence.OVS_Overstrike, PTOCAControlSequence.PTOCA_BypassFlag, PTOCAControlSequence.RMB_RelativeMoveBaseline, PTOCAControlSequence.RMI_RelativeMoveInline, PTOCAControlSequence.RPS_RepeatString, PTOCAControlSequence.SBI_SetBaselineIncrement, PTOCAControlSequence.SCFL_SetCodedFontLocal, PTOCAControlSequence.SEC_SetExtendedTextColor, PTOCAControlSequence.SIA_SetIntercharacterAdjustment, PTOCAControlSequence.SIM_SetInlineMargin, PTOCAControlSequence.STC_SetTextColor, PTOCAControlSequence.STO_SetTextOrientation, PTOCAControlSequence.SVI_SetVariableSpaceCharacterIncrement, PTOCAControlSequence.TBM_TemporaryBaselineMove, PTOCAControlSequence.TRN_TransparentData, PTOCAControlSequence.Undefined, PTOCAControlSequence.USC_Underscore

Constructor Summary

Constructors

Constructor and Description
TRN_TransparentData()

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	getTransparentData()
byte[]	getTransparentDataEBCDIC()
boolean	isUseEBCDICData() Returns true if the EBCDIC data is used in writeAFP(OutputStream, AFPParserConfiguration) without performing a encoding/decoding round trip.
void	setTransparentData(java.lang.String transparentData)
void	setTransparentDataEBCDIC(byte[] transparentDataEBCDIC)
void	setUseEBCDICData(boolean isUseEBCDICData) If given parameter is true the EBCDIC data is used in writeAFP(OutputStream, AFPParserConfiguration) without performing an encoding/decoding round trip. This might be usefull if problems occure with special code points (eg.
void	writeAFP(java.io.OutputStream os, AFPParserConfiguration config) If isUseEBCDICData() is set tot true the EBCDIC data is written out without performing an encoding/decoding round trip.

Methods inherited from class com.mgz.afp.ptoca.controlSequence.PTOCAControlSequence

getCsi, setCsi

Methods inherited from class java.lang.Object

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

Constructor Detail

TRN_TransparentData

public TRN_TransparentData()

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.

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

If isUseEBCDICData() is set tot true the EBCDIC data is written out without performing an encoding/decoding round trip. See setUseEBCDICData(boolean).

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.

getTransparentData

public java.lang.String getTransparentData()

setTransparentData

public void setTransparentData(java.lang.String transparentData)

getTransparentDataEBCDIC

public byte[] getTransparentDataEBCDIC()

setTransparentDataEBCDIC

public void setTransparentDataEBCDIC(byte[] transparentDataEBCDIC)

isUseEBCDICData

public boolean isUseEBCDICData()

Returns true if the EBCDIC data is used in writeAFP(OutputStream, AFPParserConfiguration) without performing a encoding/decoding round trip.

setUseEBCDICData

public void setUseEBCDICData(boolean isUseEBCDICData)

If given parameter is true the EBCDIC data is used in writeAFP(OutputStream, AFPParserConfiguration) without performing an encoding/decoding round trip.
This might be usefull if problems occure with special code points (eg. user defined characters, variable space character) that can't be properly mapped to Unicode characters and therefore, when encoded back to EBCDIC, may produce unwanted results.