fop 1.1

## org.apache.fop.afp.ioca
Class ImageContent

    java.lang.Object
      org.apache.fop.afp.modca.AbstractAFPObject
          org.apache.fop.afp.modca.AbstractStructuredObject
              org.apache.fop.afp.ioca.ImageContent

All Implemented Interfaces:
  Streamable

    public class ImageContent

extends AbstractStructuredObject

An IOCA Image Content

Nested Class Summary

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

Field Summary
`static byte` `COMPID_G3_MH` The CCITT T.4 Group 3 Coding Standard (G3 MH-Modified Huffman) is a compression method standardized by the International Telegraph and Telephone Consultative Committee (CCITT) for facsimile.
`static byte` `COMPID_G3_MMR` The CCITT T.6 Group 4 Coding Standard (G4 MMR-Modified Modified READ) is a compression method standardized by the International Telegraph and Telephone Consultative Committee (CCITT) for facsimile.
`static byte` `COMPID_G3_MR` The CCITT T.4 Group 3 Coding Option (G3 MR-Modified READ) is a compression method standardized by the International Telegraph and Telephone Consultative Committee (CCITT) for facsimile.
`static byte` `COMPID_JPEG` JPEG algorithms (usually baseline DCT).

Fields inherited from class org.apache.fop.afp.modca.AbstractAFPObject
`LOG, SF_CLASS, SF_HEADER_LENGTH`

Constructor Summary
`ImageContent()` Main Constructor

Method Summary
`IDEStructureParameter` `getIDEStructureParameter()` Returns the (optional) IDE Structure parameter
`IDEStructureParameter` `needIDEStructureParameter()` Returns the (optional) IDE Structure parameter.
`void` `setIDEStructureParameter(IDEStructureParameter parameter)` Sets the IDE Structure parameter.
`void` `setImageCompression(byte comp)` Sets the image compression.
`void` `setImageData(byte[] imageData)` Set the image data (can be byte array or inputstream)
`void` `setImageEncoding(byte enc)` Sets the image encoding.
`void` `setImageIDEColorModel(byte color)` Deprecated. use `setIDEStructureParameter(IDEStructureParameter)` instead
`void` `setImageIDESize(byte s)` Sets the image IDE size.
`void` `setImageSizeParameter(ImageSizeParameter imageSizeParameter)` Sets the image size parameter
`void` `setSubtractive(boolean subtractive)` Deprecated. use `setIDEStructureParameter(IDEStructureParameter)` instead
`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.AbstractStructuredObject
`writeToStream`

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, toString, wait, wait, wait`

Field Detail

### COMPID_G3_MH

    public static final byte COMPID_G3_MH

  The CCITT T.4 Group 3 Coding Standard (G3 MH-Modified Huffman) is a compression method standardized by the International Telegraph and Telephone Consultative Committee (CCITT) for facsimile. It enables one-dimensional compression.

  See Also:
    Constant Field Values

### COMPID_G3_MR

    public static final byte COMPID_G3_MR

  The CCITT T.4 Group 3 Coding Option (G3 MR-Modified READ) is a compression method standardized by the International Telegraph and Telephone Consultative Committee (CCITT) for facsimile. It enables two-dimensional compression.

  See Also:
    Constant Field Values

### COMPID_G3_MMR

    public static final byte COMPID_G3_MMR

  The CCITT T.6 Group 4 Coding Standard (G4 MMR-Modified Modified READ) is a compression method standardized by the International Telegraph and Telephone Consultative Committee (CCITT) for facsimile. It enables two-dimensional compression.

  See Also:
    Constant Field Values

### COMPID_JPEG

    public static final byte COMPID_JPEG

  JPEG algorithms (usually baseline DCT).

  See Also:
    Constant Field Values

Constructor Detail

### ImageContent

    public ImageContent()

  Main Constructor

Method Detail

### setImageSizeParameter

    public void setImageSizeParameter(ImageSizeParameter imageSizeParameter)

  Sets the image size parameter

  Parameters:
    `imageSizeParameter` - the image size parameter.

### setIDEStructureParameter

    public void setIDEStructureParameter(IDEStructureParameter parameter)

  Sets the IDE Structure parameter.

  Parameters:
    `parameter` - the IDE Structure parameter

### getIDEStructureParameter

    public IDEStructureParameter getIDEStructureParameter()

  Returns the (optional) IDE Structure parameter

  Returns:
    the IDE Structure parameter or null if none is set

### needIDEStructureParameter

    public IDEStructureParameter needIDEStructureParameter()

  Returns the (optional) IDE Structure parameter. If none is set an instance is prepared with defaults for a bi-level image.

  Returns:
    the IDE Structure parameter

### setImageEncoding

    public void setImageEncoding(byte enc)

  Sets the image encoding.

  Parameters:
    `enc` - The image encoding.

### setImageCompression

    public void setImageCompression(byte comp)

  Sets the image compression.

  Parameters:
    `comp` - The image compression.

### setImageIDESize

    public void setImageIDESize(byte s)

  Sets the image IDE size.

  Parameters:
    `s` - The IDE size.

### setImageIDEColorModel

    @Deprecated
    public void setImageIDEColorModel(byte color)

  Deprecated. use `setIDEStructureParameter(IDEStructureParameter)` instead

  Sets the image IDE color model.

  Parameters:
    `color` - the IDE color model.

### setSubtractive

    @Deprecated
    public void setSubtractive(boolean subtractive)

  Deprecated. use `setIDEStructureParameter(IDEStructureParameter)` instead

  Set either additive or subtractive mode (used for ASFLAG).

  Parameters:
    `subtractive` - true for subtractive mode, false for additive mode

### setImageData

    public void setImageData(byte[] imageData)

  Set the image data (can be byte array or inputstream)

  Parameters:
    `imageData` - the image data

### 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 `AbstractStructuredObject`
  Parameters:
    `os` - The stream to write to
  Throws:
    `java.io.IOException` - throws an I/O exception if one occurred

### 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 `AbstractStructuredObject`
  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

fop 1.1

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