Package com.itextpdf.kernel.pdf.action

Class PdfActionOcgState

java.lang.Object

com.itextpdf.kernel.pdf.action.PdfActionOcgState

 public class PdfActionOcgState extends Object 
      

This is a helper class for optional content states use in Set-OCG-State actions. See PdfAction.createSetOcgState(java.util.List).

Constructor Summary

Constructors

Constructor	Description
PdfActionOcgState(PdfName state, List<PdfDictionary> ocgs)	Constructs an optional content state object.

Method Summary

Modifier and Type	Method	Description
List<PdfObject>	getObjectList()	Gets a list of PdfObject that is describing this particular optional content group states.
List<PdfDictionary>	getOcgs()	Gets a list of optional content groups that shall have the state changed
PdfName	getState()	Gets the state the optional content groups should be switched to

Methods inherited from class java.lang.Object

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

Constructor Details

PdfActionOcgState

 public PdfActionOcgState 
             (PdfName state, List<PdfDictionary> ocgs) 
            

Constructs an optional content state object.

Parameters:

state - a PdfName describing the state. Shall be one of the following: PdfName.OFF, PdfName.ON, PdfName.Toggle

ocgs - a list of the OCG dictionaries

Method Details

getState

 public PdfName getState() 
            

Gets the state the optional content groups should be switched to

Returns:

the state, one of the following: PdfName.OFF, PdfName.ON, PdfName.Toggle

getOcgs

 public List<PdfDictionary> getOcgs() 
            

Gets a list of optional content groups that shall have the state changed

Returns:

the list of optional content groups

getObjectList

 public List<PdfObject> getObjectList() 
            

Gets a list of PdfObject that is describing this particular optional content group states.

Returns:

a list of PdfObject for construction of a PdfArray