ObjectAreaDescriptor (Apache FOP 2.4 API)

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

All Implemented Interfaces:

Streamable
```
public class ObjectAreaDescriptor
extends AbstractDescriptor
```
The Object Area Descriptor structured field specifies the size and attributes of an object area presentation space.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject
  AbstractAFPObject.Category, AbstractAFPObject.Type

Field Summary
- Fields inherited from class org.apache.fop.afp.modca.AbstractDescriptor
  height, heightRes, width, widthRes
- 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
`ObjectAreaDescriptor(int width, int height, int widthRes, int heightRes)`	Construct an object area descriptor for the specified object width and object height.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`writeToStream(java.io.OutputStream os)`	DataStream objects must implement the writeToStream() method to write its data to the given OutputStream

Methods inherited from class org.apache.fop.afp.modca.AbstractDescriptor
getHeight, getWidth, toString

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
writeContent, writeEnd, writeStart

Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, copySF, truncate, writeChunksToStream, writeObjects

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ObjectAreaDescriptor
```
public ObjectAreaDescriptor(int width,
                            int height,
                            int widthRes,
                            int heightRes)
```
    Construct an object area descriptor for the specified object width and object height.
    
    Parameters:
    
    width - the object width.
    
    height - the object height.
    
    widthRes - the object width resolution.
    
    heightRes - the object height resolution.
- Method Detail
  - writeToStream
```
public void writeToStream(java.io.OutputStream os)
                   throws java.io.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:
    
    java.io.IOException - an I/O exception of some sort has occurred.