pdftron.PDF.OCG
Class OCMD

java.lang.Object
  pdftron.PDF.OCG.OCMD

public class OCMD
extends java.lang.Object

The OCMD object represents an Optional Content Membership Dictionary (OCMD) that allows the visibility of optional content to depend on the states in a set of optional-content groups (OCG::Group). The object directly corresponds to the OCMD dictionary (Section 4.10.1 'Optional Content Groups' in PDF Reference).

An OCMD collects a set of OCGs. It sets a visibility policy, so that content in the member groups is visible only when all groups are ON or OFF, or when any of the groups is ON or OFF. This makes it possible to set up complex dependencies among groups. For example, an object can be visible only if some other conditions are met (such as if another layer is visible).

Field Summary

static int	e_AllOff The Constant e_AllOff.
static int	e_AllOn Visibility Policy Type.
static int	e_AnyOff The Constant e_AnyOff.
static int	e_AnyOn The Constant e_AnyOn.

Constructor Summary

OCMD(Obj ocmd)
Creates a new optional-content group (OCG) object from an existing SDF/Cos object.

Method Summary

static OCMD	__Create(long impl, java.lang.Object ref)
static OCMD	create(PDFDoc doc, Obj ocgs, int vis_policy) Creates a new optional-content membership dictionary (OCMD) object in the given document for the given groups and visibility policy.
Obj	getOCGs() Get the optional-content groups listed under 'OCGs' entry in the object dictionary.
Obj	getSDFObj() Get the SDFObj.
Obj	getVisibilityExpression() Get the visibility expression.
int	getVisibilityPolicy() Get the optional-content membership dictionary's visibility policy, which determines the visibility of content with respect to the ON-OFF state of OCGs listed in the dictionary.
boolean	isValid() Determine whether OCMD is valid
void	setVisibilityPolicy(int vis_policy) Set the optional-content membership dictionary's visibility policy, which determines the visibility of content with respect to the ON-OFF state of OCGs listed in the dictionary.

Methods inherited from class java.lang.Object

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

Field Detail

e_AllOn

public static final int e_AllOn

Visibility Policy Type. A Visibility Policy is used to determine whether an PDF::Element is visible in a given OCG::Context, depending on whether all groups in OCGs array are "ON" or "OFF", or when any of the groups is "ON" or "OFF".

See Also:

Constant Field Values

e_AnyOn

public static final int e_AnyOn

The Constant e_AnyOn.

See Also:

Constant Field Values

e_AnyOff

public static final int e_AnyOff

The Constant e_AnyOff.

See Also:

Constant Field Values

e_AllOff

public static final int e_AllOff

The Constant e_AllOff.

See Also:

Constant Field Values

Constructor Detail

OCMD

public OCMD(Obj ocmd)

Creates a new optional-content group (OCG) object from an existing SDF/Cos object.

Parameters:

ocmd - the ocmd

Method Detail

create

public static OCMD create(PDFDoc doc,
                          Obj ocgs,
                          int vis_policy)
                   throws PDFNetException

Creates a new optional-content membership dictionary (OCMD) object in the given document for the given groups and visibility policy.

Parameters:

doc - The document in which the new OCMD will be created.

ocgs - An array of optional-content groups (OCGs) to be members of the dictionary.

vis_policy - the vis_policy

Returns:

The newly created OCG::OCMD object.

Throws:

PDFNetException

isValid

public boolean isValid()
                throws PDFNetException

Determine whether OCMD is valid

Returns:

True if this is a valid (non-null) OCG, false otherwise.

Throws:

PDFNetException

getOCGs

public Obj getOCGs()
            throws PDFNetException

Get the optional-content groups listed under 'OCGs' entry in the object dictionary.

Returns:

An SDF::Obj array or OCG::Group objects or NULL is the array is not present.

Throws:

PDFNetException

getVisibilityPolicy

public int getVisibilityPolicy()
                        throws PDFNetException

Get the optional-content membership dictionary's visibility policy, which determines the visibility of content with respect to the ON-OFF state of OCGs listed in the dictionary.

Returns:

The visibility policy.

Throws:

PDFNetException

setVisibilityPolicy

public void setVisibilityPolicy(int vis_policy)
                         throws PDFNetException

Set the optional-content membership dictionary's visibility policy, which determines the visibility of content with respect to the ON-OFF state of OCGs listed in the dictionary.

Parameters:

vis_policy - New visibility policy.

Throws:

PDFNetException

getVisibilityExpression

public Obj getVisibilityExpression()
                            throws PDFNetException

Get the visibility expression.

Returns:

If the PDOCMD has a visibility expression entry, return the SDF::Obj array object representing the expression, otherwise returns NULL.

Throws:

PDFNetException

getSDFObj

public Obj getSDFObj()
              throws PDFNetException

Get the SDFObj.

Returns:

Pointer to the underlying SDF/Cos object.

Throws:

PDFNetException

__Create

public static OCMD __Create(long impl,
                            java.lang.Object ref)