org.apache.fop.render.afp.modca
Class PresentationTextData

java.lang.Object
  org.apache.fop.render.afp.modca.AFPObject
      org.apache.fop.render.afp.modca.PresentationTextData

public class PresentationTextData

extends AFPObject

Presentation text data contains the graphic characters and the control sequences necessary to position the characters within the object space. The data consists of: - graphic characters to be presented - control sequences that position them - modal control sequences that adjust the positions by small amounts - other functions causing text to be presented with differences in appearance. The graphic characters are expected to conform to a coded font representation so that they can be translated from the code point in the object data to the character in the coded font. The units of measure for linear displacements are derived from the PresentationTextDescriptor or from the hierarchical defaults. In addition to graphic character code points, Presentation Text data can contain embedded control sequences. These are strings of two or more bytes which signal an alternate mode of processing for the content of the current Presentation Text data.

Field Summary

Fields inherited from class org.apache.fop.render.afp.modca.AFPObject

LOGGER

Constructor Summary

PresentationTextData()
Default constructor for the PresentationTextData.

PresentationTextData(boolean controlInd)
Constructor for the PresentationTextData, the boolean flag indicate whether the control sequence prefix should be set to indicate the start of a new control seq1uence.

Method Summary

void	createLineData(int x1, int y1, int x2, int y2, int thickness, int orientation) Drawing of lines using the starting and ending coordinates, thickness and colour arguments.
void	createTextData(int fontNumber, int x, int y, int orientation, byte[] data) Create the presentation text data for the byte array of data.
void	endControlSequence() A control sequence is a sequence of bytes that specifies a control function.
byte[]	getDataStream() Accessor method to obtain the byte array AFP datastream for the text data.

Methods inherited from class java.lang.Object

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

Constructor Detail

PresentationTextData

public PresentationTextData()

Default constructor for the PresentationTextData.

PresentationTextData

public PresentationTextData(boolean controlInd)

Constructor for the PresentationTextData, the boolean flag indicate whether the control sequence prefix should be set to indicate the start of a new control seq1uence.

Parameters:

controlInd - The control sequence indicator.

Method Detail

createTextData

public void createTextData(int fontNumber,
                           int x,
                           int y,
                           int orientation,
                           byte[] data)
                    throws MaximumSizeExceededException

Create the presentation text data for the byte array of data.

Parameters:

fontNumber - The font resource identifier.

x - The x coordinate for the text data.

y - The y coordinate for the text data.

orientation - The orientation of the text data.

data - The text data to be created.

Throws:

MaximumSizeExceededException

createLineData

public void createLineData(int x1,
                           int y1,
                           int x2,
                           int y2,
                           int thickness,
                           int orientation)
                    throws MaximumSizeExceededException

Drawing of lines using the starting and ending coordinates, thickness and colour arguments.

Parameters:

x1 - The starting X coorindate.

y1 - The starting Y coorindate.

x2 - The ending X coorindate.

y2 - The ending Y coorindate.

thickness - The line thickness.

Throws:

MaximumSizeExceededException

getDataStream

public byte[] getDataStream()

Accessor method to obtain the byte array AFP datastream for the text data.

Specified by:

getDataStream in class AFPObject

Returns:

data The afp data stream.

endControlSequence

public void endControlSequence()
                        throws MaximumSizeExceededException

A control sequence is a sequence of bytes that specifies a control function. A control sequence consists of a control sequence introducer and zero or more parameters. The control sequence can extend multiple presentation text data objects, but must eventually be terminated. This method terminates the control sequence.

Throws:

MaximumSizeExceededException