Package org.apache.fop.afp.modca
Class PresentationTextObject
- java.lang.Object
-
- org.apache.fop.afp.modca.AbstractAFPObject
-
- org.apache.fop.afp.modca.AbstractStructuredObject
-
- org.apache.fop.afp.modca.AbstractTripletStructuredObject
-
- org.apache.fop.afp.modca.AbstractNamedAFPObject
-
- org.apache.fop.afp.modca.PresentationTextObject
-
- All Implemented Interfaces:
Streamable
public class PresentationTextObject extends AbstractNamedAFPObject
The Presentation Text object is the data object used in document processing environments for representing text which has been prepared for presentation. Text, as used here, means an ordered string of characters, such as graphic symbols, numbers, and letters, that are suitable for the specific purpose of representing coherent information. Text which has been prepared for presentation has been reduced to a primitive form through explicit specification of the characters and their placement in the presentation space. Control sequences which designate specific control functions may be embedded within the text. These functions extend the primitive form by applying specific characteristics to the text when it is presented. The collection of the graphic characters and control codes is called Presentation Text, and the object that contains the Presentation Text is called the PresentationText object.The content for this object can be created using
PtocaBuilder
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private class
PresentationTextObject.DefaultBuilder
-
Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject
AbstractAFPObject.Category, AbstractAFPObject.Type
-
-
Field Summary
Fields Modifier and Type Field Description private PresentationTextObject.DefaultBuilder
builder
private PresentationTextData
currentPresentationTextData
The current presentation text dataprivate java.util.List<PresentationTextData>
presentationTextDataList
The presentation text data list-
Fields inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject
name
-
Fields inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
triplets
-
Fields inherited from class org.apache.fop.afp.modca.AbstractAFPObject
LOG, SF_CLASS, SF_HEADER_LENGTH
-
-
Constructor Summary
Constructors Constructor Description PresentationTextObject(java.lang.String name)
Construct a new PresentationTextObject for the specified name argument, the name should be an 8 character identifier.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
createControlSequences(PtocaProducer producer)
Creates a chain of control sequences using a producer.boolean
createLineData(AFPLineDataInfo lineDataInfo)
Drawing of lines using the starting and ending coordinates, thickness and orientation arguments.void
createTextData(AFPTextDataInfo textDataInfo)
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.private void
endPresentationTextData()
Helper method to mark the end of the presentation text datajava.lang.Integer
getBytesAvailable()
private int
getSize(PtocaProducer producer)
private void
handleUnexpectedIOError(java.io.IOException ioe)
private void
startPresentationTextData()
Helper method to mark the start of the presentation text datajava.lang.String
toString()
protected void
writeContent(java.io.OutputStream os)
Helper method to write the contents of the Object.protected void
writeEnd(java.io.OutputStream os)
Helper method to write the end of the Object.protected void
writeStart(java.io.OutputStream os)
Helper method to write the start of the Object.-
Methods inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject
copySF, getName, getNameBytes, getNameLength, setName
-
Methods inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setFullyQualifiedName, setObjectClassification, writeTriplets
-
Methods inherited from class org.apache.fop.afp.modca.AbstractStructuredObject
writeToStream
-
Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, truncate, writeChunksToStream, writeObjects
-
-
-
-
Field Detail
-
currentPresentationTextData
private PresentationTextData currentPresentationTextData
The current presentation text data
-
presentationTextDataList
private java.util.List<PresentationTextData> presentationTextDataList
The presentation text data list
-
builder
private PresentationTextObject.DefaultBuilder builder
-
-
Method Detail
-
createTextData
public void createTextData(AFPTextDataInfo textDataInfo) throws java.io.UnsupportedEncodingException
Create the presentation text data for the byte array of data.- Parameters:
textDataInfo
- The afp text data- Throws:
java.io.UnsupportedEncodingException
- thrown if character encoding is not supported
-
createControlSequences
public boolean createControlSequences(PtocaProducer producer) throws java.io.UnsupportedEncodingException
Creates a chain of control sequences using a producer.- Parameters:
producer
- the producer- Throws:
java.io.UnsupportedEncodingException
- thrown if character encoding is not supported
-
getSize
private int getSize(PtocaProducer producer) throws java.io.IOException
- Throws:
java.io.IOException
-
createLineData
public boolean createLineData(AFPLineDataInfo lineDataInfo)
Drawing of lines using the starting and ending coordinates, thickness and orientation arguments.- Parameters:
lineDataInfo
- the line data information.
-
startPresentationTextData
private void startPresentationTextData()
Helper method to mark the start of the presentation text data
-
endPresentationTextData
private void endPresentationTextData()
Helper method to mark the end of the presentation text data
-
writeStart
protected void writeStart(java.io.OutputStream os) throws java.io.IOException
Helper method to write the start of the Object.- Overrides:
writeStart
in classAbstractStructuredObject
- Parameters:
os
- The stream to write to- Throws:
java.io.IOException
- throws an I/O exception if one occurred
-
writeContent
protected void writeContent(java.io.OutputStream os) throws java.io.IOException
Helper method to write the contents of the Object.- Overrides:
writeContent
in classAbstractStructuredObject
- Parameters:
os
- The stream to write to- Throws:
java.io.IOException
- throws an I/O exception if one occurred
-
writeEnd
protected void writeEnd(java.io.OutputStream os) throws java.io.IOException
Helper method to write the end of the Object.- Overrides:
writeEnd
in classAbstractStructuredObject
- Parameters:
os
- The stream to write to- Throws:
java.io.IOException
- an I/O exception if one occurred
-
endControlSequence
public void endControlSequence()
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.
-
handleUnexpectedIOError
private void handleUnexpectedIOError(java.io.IOException ioe)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classAbstractNamedAFPObject
-
getBytesAvailable
public java.lang.Integer getBytesAvailable()
-
-