com.lizardtech.djvu
Class JB2Dict

java.lang.Object
  com.lizardtech.djvu.DjVuObject
      com.lizardtech.djvu.JB2Dict

All Implemented Interfaces:

Codec, DjVuInterface, java.lang.Cloneable

Direct Known Subclasses:

JB2Image

public class JB2Dict
extends DjVuObject
implements java.lang.Cloneable, Codec

DOCUMENT ME!

Version:

$Revision: 1.6 $

Author:

$author$

Field Summary

java.lang.String

comment Comment string coded by JB2 file.

Fields inherited from class com.lizardtech.djvu.DjVuObject

hasReferences

Constructor Summary

JB2Dict()
Creates a new JB2Dict object.

Method Summary

int	add_shape(com.lizardtech.djvu.JB2Shape shape) DOCUMENT ME!
java.lang.Object	clone() DOCUMENT ME!
static JB2Dict	createJB2Dict(DjVuInterface ref) Creates an instance of JB2Dict with the options interherited from the specified reference.
void	decode(CachedInputStream pool) DOCUMENT ME!
void	decode(java.io.InputStream gbs, JB2Dict zdict) DOCUMENT ME!
JB2Dict	get_inherited_dict() Returns the inherited dictionary.
int	get_inherited_shapes() Returns the number of inherited shapes.
int	get_shape_count() DOCUMENT ME!
com.lizardtech.djvu.JB2Shape	get_shape(int shapeno) DOCUMENT ME!
void	init() DOCUMENT ME!
boolean	isImageData() Query if this is image data.
void	set_inherited_dict(JB2Dict dict) DOCUMENT ME!
void	set_inherited_dict(JB2Dict dict, boolean force) Sets the inherited dictionary.

Methods inherited from class com.lizardtech.djvu.DjVuObject

checkLockTime, create, create, createSoftReference, createWeakReference, getDjVuOptions, getFromReference, invoke, logError, printStackTrace, setDjVuOptions, verbose

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.lizardtech.djvu.DjVuInterface

getDjVuOptions, setDjVuOptions

Field Detail

comment

public java.lang.String comment

Comment string coded by JB2 file.

Constructor Detail

JB2Dict

public JB2Dict()

Creates a new JB2Dict object.

Method Detail

isImageData

public boolean isImageData()

Query if this is image data. Note that even though this data effects rendering, the effect is indirect. This class itself does not produce an image, so the return value is false.

Specified by:

isImageData in interface Codec

Returns:

false

createJB2Dict

public static JB2Dict createJB2Dict(DjVuInterface ref)

Creates an instance of JB2Dict with the options interherited from the specified reference.

Parameters:

ref - Object to interherit DjVuOptions from.

Returns:

a new instance of JB2Dict.

clone

public java.lang.Object clone()

DOCUMENT ME!

Overrides:

clone in class java.lang.Object

Returns:

DOCUMENT ME!

get_inherited_dict

public final JB2Dict get_inherited_dict()

Returns the inherited dictionary.

Returns:

DOCUMENT ME!

get_inherited_shapes

public final int get_inherited_shapes()

Returns the number of inherited shapes.

Returns:

DOCUMENT ME!

get_shape_count

public final int get_shape_count()

DOCUMENT ME!

Returns:

DOCUMENT ME!

add_shape

public int add_shape(com.lizardtech.djvu.JB2Shape shape)

DOCUMENT ME!

Parameters:

shape - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

java.lang.IllegalArgumentException - DOCUMENT ME!

decode

public final void decode(CachedInputStream pool)
                  throws java.io.IOException

DOCUMENT ME!

Specified by:

decode in interface Codec

Parameters:

pool - DOCUMENT ME!

Throws:

java.io.IOException - DOCUMENT ME!

decode

public void decode(java.io.InputStream gbs,
                   JB2Dict zdict)
            throws java.io.IOException

DOCUMENT ME!

Parameters:

gbs - DOCUMENT ME!

zdict - DOCUMENT ME!

Throws:

java.io.IOException - DOCUMENT ME!

get_shape

public com.lizardtech.djvu.JB2Shape get_shape(int shapeno)

DOCUMENT ME!

Parameters:

shapeno - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

java.lang.IllegalStateException - DOCUMENT ME!

init

public void init()

DOCUMENT ME!

set_inherited_dict

public void set_inherited_dict(JB2Dict dict)

DOCUMENT ME!

Parameters:

dict - DOCUMENT ME!

set_inherited_dict

public void set_inherited_dict(JB2Dict dict,
                               boolean force)

Sets the inherited dictionary.

Parameters:

dict - DOCUMENT ME!

force - DOCUMENT ME!

Throws:

java.lang.IllegalStateException - DOCUMENT ME!