com.mgz.afp.lineData

Class LND_LineDescriptor

java.lang.Object

com.mgz.afp.base.StructuredField

com.mgz.afp.base.StructuredFieldBaseTriplets

com.mgz.afp.lineData.LND_LineDescriptor

All Implemented Interfaces:

IHasTriplets, IAFPDecodeableWriteable

public class LND_LineDescriptor
extends StructuredFieldBaseTriplets

Programming Guide and Line Data Reference(ha3l3r04.pdf), page 104.

The Line Descriptor structured field contains information, such as line position, text orientation, font selection, field selection, and conditional processing identification, used to format line data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LND_LineDescriptor.LND_Flag

Field Summary

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

triplets

Constructor Summary

Constructors

Constructor and Description
LND_LineDescriptor()

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.
AFPOrientation	getBaselineOrientation()
int	getBaselinePosition()
int	getCcpIdentifier()
byte	getChannelCode()
int	getDataLength()
int	getDataStartPosition()
java.util.EnumSet<LND_LineDescriptor.LND_Flag>	getFlags()
AFPOrientation	getInlineOrientation()
int	getInlinePosition()
int	getNextLNDIfConditionalProcessing()
int	getNextLNDIfReusingData()
int	getNextLNDIfSkipping()
int	getNextLNDIfSpacing()
short	getPrimaryFontLocalId()
byte	getShiftOutLocalFontID()
short	getSubpageID()
java.lang.String	getSuppressionTokenName()
AFPColorValue	getTextColor()
void	setBaselineOrientation(AFPOrientation baselineOrientation)
void	setBaselinePosition(int baselinePosition)
void	setCcpIdentifier(int ccpIdentifier)
void	setChannelCode(byte channelCode)
void	setDataLength(int dataLength)
void	setDataStartPosition(int dataStartPosition)
void	setFlags(java.util.EnumSet<LND_LineDescriptor.LND_Flag> flags)
void	setInlineOrientation(AFPOrientation inlineOrientation)
void	setInlinePosition(int inlinePosition)
void	setNextLNDIfConditionalProcessing(int nextLNDIfConditionalProcessing)
void	setNextLNDIfReusingData(int nextLNDIfReusingData)
void	setNextLNDIfSkipping(int nextLNDIfSkipping)
void	setNextLNDIfSpacing(int nextLNDIfSpacing)
void	setPrimaryFontLocalId(short primaryFontLocalId)
void	setShiftOutLocalFontID(byte shiftOutLocalFontID)
void	setSubpageID(short subpageID)
void	setSuppressionTokenName(java.lang.String suppressionTokenName)
void	setTextColor(AFPColorValue textColor)
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

LND_LineDescriptor

public LND_LineDescriptor()

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.

getFlags

public java.util.EnumSet<LND_LineDescriptor.LND_Flag> getFlags()

setFlags

public void setFlags(java.util.EnumSet<LND_LineDescriptor.LND_Flag> flags)

getInlinePosition

public int getInlinePosition()

setInlinePosition

public void setInlinePosition(int inlinePosition)

getBaselinePosition

public int getBaselinePosition()

setBaselinePosition

public void setBaselinePosition(int baselinePosition)

getPrimaryFontLocalId

public short getPrimaryFontLocalId()

setPrimaryFontLocalId

public void setPrimaryFontLocalId(short primaryFontLocalId)

getChannelCode

public byte getChannelCode()

setChannelCode

public void setChannelCode(byte channelCode)

getNextLNDIfSkipping

public int getNextLNDIfSkipping()

setNextLNDIfSkipping

public void setNextLNDIfSkipping(int nextLNDIfSkipping)

getNextLNDIfSpacing

public int getNextLNDIfSpacing()

setNextLNDIfSpacing

public void setNextLNDIfSpacing(int nextLNDIfSpacing)

getNextLNDIfReusingData

public int getNextLNDIfReusingData()

setNextLNDIfReusingData

public void setNextLNDIfReusingData(int nextLNDIfReusingData)

getSuppressionTokenName

public java.lang.String getSuppressionTokenName()

setSuppressionTokenName

public void setSuppressionTokenName(java.lang.String suppressionTokenName)

getShiftOutLocalFontID

public byte getShiftOutLocalFontID()

setShiftOutLocalFontID

public void setShiftOutLocalFontID(byte shiftOutLocalFontID)

getDataStartPosition

public int getDataStartPosition()

setDataStartPosition

public void setDataStartPosition(int dataStartPosition)

getDataLength

public int getDataLength()

setDataLength

public void setDataLength(int dataLength)

getTextColor

public AFPColorValue getTextColor()

setTextColor

public void setTextColor(AFPColorValue textColor)

getNextLNDIfConditionalProcessing

public int getNextLNDIfConditionalProcessing()

setNextLNDIfConditionalProcessing

public void setNextLNDIfConditionalProcessing(int nextLNDIfConditionalProcessing)

getSubpageID

public short getSubpageID()

setSubpageID

public void setSubpageID(short subpageID)

getCcpIdentifier

public int getCcpIdentifier()

setCcpIdentifier

public void setCcpIdentifier(int ccpIdentifier)

getInlineOrientation

public AFPOrientation getInlineOrientation()

setInlineOrientation

public void setInlineOrientation(AFPOrientation inlineOrientation)

getBaselineOrientation

public AFPOrientation getBaselineOrientation()

setBaselineOrientation

public void setBaselineOrientation(AFPOrientation baselineOrientation)