org.icepdf.core.pobjects

Class OptionalContentGroup

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.OptionalContentGroup

All Implemented Interfaces:

OptionalContents

public class OptionalContentGroup
extends Dictionary
implements OptionalContents

An optional content group is a dictionary representing a collection of graphics that can be made visible or invisible dynamically by users of conforming readers. The graphics belonging to such a group may reside anywhere in the document: they need not be consecutive in drawing order, nor even belong to the same content stream.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field and Description
static Name	NAME_KEY
static Name	TYPE
static Name	USAGE_KEY

Fields inherited from class org.icepdf.core.pobjects.Dictionary

entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

Constructors

Constructor and Description
OptionalContentGroup(Library library, java.util.HashMap entries)
OptionalContentGroup(java.lang.String name, boolean visible)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
java.util.HashMap	getUsage()
boolean	isOCG()
boolean	isVisible()
void	setVisible(boolean visible)

Methods inherited from class org.icepdf.core.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, isDeleted, isNew, setDeleted, setNew, setPObjectReference, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.icepdf.core.pobjects.OptionalContents

init

Field Detail

TYPE

public static final Name TYPE

NAME_KEY

public static final Name NAME_KEY

USAGE_KEY

public static final Name USAGE_KEY

Constructor Detail

OptionalContentGroup

public OptionalContentGroup(java.lang.String name,
                            boolean visible)

OptionalContentGroup

public OptionalContentGroup(Library library,
                            java.util.HashMap entries)

Method Detail

isOCG

public boolean isOCG()

Specified by:

isOCG in interface OptionalContents

getName

public java.lang.String getName()

getUsage

public java.util.HashMap getUsage()

isVisible

public boolean isVisible()

Specified by:

isVisible in interface OptionalContents

setVisible

public void setVisible(boolean visible)