Class GraphicsCharacterString

java.lang.Object

org.apache.fop.afp.modca.AbstractAFPObject

org.apache.fop.afp.goca.AbstractGraphicsDrawingOrder

org.apache.fop.afp.goca.AbstractGraphicsCoord

org.apache.fop.afp.goca.GraphicsCharacterString

All Implemented Interfaces:

Streamable, StructuredData

public class GraphicsCharacterString
extends AbstractGraphicsCoord

A GOCA graphics string

Nested Class Summary

Nested classes/interfaces inherited from class AbstractAFPObject

AbstractAFPObject.Category, AbstractAFPObject.Type

Field Summary

Fields

Modifier and Type	Field	Description
private final CharacterSet	charSet	The character set encoding to use
protected static final int	MAX_STR_LEN	Up to 255 bytes of character data
private final String	str	the string to draw

Fields inherited from class AbstractGraphicsCoord

coords, relative

Fields inherited from class AbstractAFPObject

LOG, SF_CLASS, SF_HEADER_LENGTH

Constructor Summary

Constructors

Constructor	Description
GraphicsCharacterString(String str, int x, int y, CharacterSet charSet)	Constructor (absolute positioning)

Method Summary

Modifier and Type	Method	Description
int	getDataLength()	Returns the data length of this structured field
(package private) byte	getOrderCode()	Returns the order code of this structured field
private byte[]	getStringAsBytes()	Returns the text string as an encoded byte array
String	toString()
void	writeToStream(OutputStream os)	DataStream objects must implement the writeToStream() method to write its data to the given OutputStream

Methods inherited from class AbstractGraphicsCoord

addCoords, getCoordinateDataStartIndex, getData, isRelative

Methods inherited from class AbstractGraphicsDrawingOrder

getName

Methods inherited from class AbstractAFPObject

copySF, copySF, truncate, writeChunksToStream, writeObjects

Methods inherited from class Object

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

Field Details

MAX_STR_LEN

protected static final int MAX_STR_LEN

Up to 255 bytes of character data

See Also:

• Constant Field Values

str

private final String str

the string to draw

charSet

private final CharacterSet charSet

The character set encoding to use

Constructor Details

GraphicsCharacterString

public GraphicsCharacterString(String str,
 int x,
 int y,
 CharacterSet charSet)

Constructor (absolute positioning)

Parameters:

str - the character string

x - the x coordinate

y - the y coordinate

charSet - the character set

Method Details

getOrderCode

byte getOrderCode()

Returns the order code of this structured field

Specified by:

getOrderCode in class AbstractGraphicsDrawingOrder

Returns:

the order code of this structured field

getDataLength

public int getDataLength()

Returns the data length of this structured field

Specified by:

getDataLength in interface StructuredData

Overrides:

getDataLength in class AbstractGraphicsCoord

Returns:

the data length of this structured field

writeToStream

public void writeToStream(OutputStream os)
                   throws IOException

DataStream objects must implement the writeToStream() method to write its data to the given OutputStream

Specified by:

writeToStream in interface Streamable

Overrides:

writeToStream in class AbstractGraphicsCoord

Parameters:

os - the outputsteam stream

Throws:

IOException - an I/O exception of some sort has occurred.

getStringAsBytes

private byte[] getStringAsBytes()
                         throws UnsupportedEncodingException,
CharacterCodingException

Returns the text string as an encoded byte array

Returns:

the text string as an encoded byte array

Throws:

UnsupportedEncodingException

CharacterCodingException

toString

public String toString()

Overrides:

toString in class AbstractGraphicsCoord