com.qoppa.pdf.actions

Class SetOCGState.Sequence

java.lang.Object

com.qoppa.pdf.actions.SetOCGState.Sequence

Enclosing class:

SetOCGState

public static class SetOCGState.Sequence
extends Object

Class that contains a list of layers and an action for that list. A SetOCGState action can toggle the visibility of many layers at once. The action takes a list of Sequence objects and each Sequence object takes a list of layers to turn off, turn on or toggle.

Author:

Qoppa Software

Constructor Summary

Constructors

Constructor and Description
Sequence(int ocgAction, Vector<Layer> layerList) Constructs a Sequence object with a list of layers and the action to do on those layers.

Method Summary

Modifier and Type	Method and Description
Vector<Layer>	getLayerList() Returns the list of layers.
int	getOCGAction() Returns the action that this sequence will do on the layers.

Methods inherited from class java.lang.Object

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

Constructor Detail

Sequence

public Sequence(int ocgAction,
                Vector<Layer> layerList)

Constructs a Sequence object with a list of layers and the action to do on those layers.

Parameters:

ocgAction - The action to be done on the layer. The possible values are the predefined constants SetOCGState.OCG_ACTION_OFF, SetOCGState.OCG_ACTION_ON or SetOCGState.OCG_ACTION_TOGGLE.

layerList - The list of layers.

Method Detail

getOCGAction

public int getOCGAction()

Returns the action that this sequence will do on the layers. The possible values are the predefined constants SetOCGState.OCG_ACTION_OFF, SetOCGState.OCG_ACTION_ON or SetOCGState.OCG_ACTION_TOGGLE.

Returns:

the action

getLayerList

public Vector<Layer> getLayerList()

Returns the list of layers.

Returns:

List of layers.