GraphicsImage (Apache FOP 2.4 API)

java.lang.Object
- org.apache.fop.afp.modca.AbstractAFPObject
- - org.apache.fop.afp.goca.AbstractGraphicsDrawingOrder
  - - org.apache.fop.afp.goca.GraphicsImage

All Implemented Interfaces:: Streamable, StructuredData

public class GraphicsImage
extends AbstractGraphicsDrawingOrder

A GOCA Image

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

Field Summary

Fields
Modifier and Type Field Description

static short MAX_DATA_LEN
the maximum image data length
- Fields inherited from class org.apache.fop.afp.modca.AbstractAFPObject
  LOG, SF_CLASS, SF_HEADER_LENGTH

Constructor Summary

Constructors
Constructor Description

GraphicsImage(int x, int y, int width, int height, byte[] imageData)
Main constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getDataLength()`	Returns the data length of this structured field
`java.lang.String`	`toString()`
`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.goca.AbstractGraphicsDrawingOrder
getName

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

- Field Detail
  - MAX_DATA_LEN
```
public static final short MAX_DATA_LEN
```
    the maximum image data length
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GraphicsImage
```
public GraphicsImage(int x,
                     int y,
                     int width,
                     int height,
                     byte[] imageData)
```
    Main constructor
    
    Parameters:
    
    x - the x coordinate of the image
    
    y - the y coordinate of the image
    
    width - the image width
    
    height - the image height
    
    imageData - the image data
- Method Detail
  - getDataLength
```
public int getDataLength()
```
    Returns the data length of this structured field
    
    Returns:
    
    the data length of this structured field
  - 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
    
    Parameters:
    
    os - the outputsteam stream
    
    Throws:
    
    java.io.IOException - an I/O exception of some sort has occurred.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object