fop 1.0

org.apache.fop.afp.modca
Class ObjectContainer

java.lang.Object
  extended by org.apache.fop.afp.modca.AbstractAFPObject
      extended by org.apache.fop.afp.modca.AbstractStructuredObject
          extended by org.apache.fop.afp.modca.AbstractTripletStructuredObject
              extended by org.apache.fop.afp.modca.AbstractNamedAFPObject
                  extended by org.apache.fop.afp.modca.AbstractDataObject
                      extended by org.apache.fop.afp.modca.ObjectContainer
All Implemented Interfaces:
Completable, Startable, Streamable

public class ObjectContainer
extends AbstractDataObject

Object containers are MO:DCA objects that envelop and carry object data.


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.AbstractDataObject
factory, objectEnvironmentGroup
 
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
 
Constructor Summary
ObjectContainer(Factory factory, java.lang.String name)
          Main constructor
 
Method Summary
 void setData(byte[] data)
          Sets the inputstream for the the object container data
 void setViewport(AFPDataObjectInfo dataObjectInfo)
          Sets the object view port (area position and size).
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.AbstractDataObject
getObjectEnvironmentGroup, isComplete, isStarted, setComplete, setStarted
 
Methods inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject
copySF, getName, getNameBytes, getNameLength, setName, toString
 
Methods inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setObjectClassification, writeTriplets
 
Methods inherited from class org.apache.fop.afp.modca.AbstractStructuredObject
writeToStream
 
Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copyChunks, copySF, truncate, writeChunksToStream, writeObjects
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ObjectContainer

public ObjectContainer(Factory factory,
                       java.lang.String name)
Main constructor

Parameters:
factory - the object factory
name - the name of this object container
Method Detail

writeStart

protected void writeStart(java.io.OutputStream os)
                   throws java.io.IOException
Helper method to write the start of the Object.

Overrides:
writeStart in class AbstractDataObject
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 class AbstractDataObject
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 class AbstractStructuredObject
Parameters:
os - The stream to write to
Throws:
java.io.IOException - an I/O exception if one occurred

setViewport

public void setViewport(AFPDataObjectInfo dataObjectInfo)
Sets the object view port (area position and size).

Overrides:
setViewport in class AbstractDataObject
Parameters:
dataObjectInfo - the object area info

setData

public void setData(byte[] data)
Sets the inputstream for the the object container data

Parameters:
inputStream - the inputstream for the object container data

fop 1.0

Copyright 1999-2010 The Apache Software Foundation. All Rights Reserved.