Class PageDescriptor

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.AbstractDescriptor

org.apache.fop.afp.modca.PageDescriptor

All Implemented Interfaces:

Streamable

public class PageDescriptor
extends AbstractDescriptor

The Page Descriptor structured field specifies the size and attributes of a page or overlay presentation space.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractAFPObject

AbstractAFPObject.Category, AbstractAFPObject.Type

Field Summary

Fields inherited from class AbstractDescriptor

height, heightRes, width, widthRes

Fields inherited from class AbstractTripletStructuredObject

triplets

Fields inherited from class AbstractAFPObject

LOG, SF_CLASS, SF_HEADER_LENGTH

Constructor Summary

Constructors

Constructor	Description
PageDescriptor(int width, int height, int widthRes, int heightRes)	Construct a page descriptor for the specified page width and page height.

Method Summary

Modifier and Type	Method	Description
void	writeToStream(OutputStream os)	DataStream objects must implement the writeToStream() method to write its data to the given OutputStream

Methods inherited from class AbstractDescriptor

getHeight, getWidth, toString

Methods inherited from class AbstractTripletStructuredObject

addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setFullyQualifiedName, setObjectClassification, writeTriplets

Methods inherited from class AbstractStructuredObject

writeContent, writeEnd, writeStart

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

Constructor Details

PageDescriptor

public PageDescriptor(int width,
 int height,
 int widthRes,
 int heightRes)

Construct a page descriptor for the specified page width and page height.

Parameters:

width - The page width.

height - The page height.

widthRes - The page width resolution

heightRes - The page height resolution

Method Details

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 AbstractStructuredObject

Parameters:

os - the outputsteam stream

Throws:

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