Package com.itextpdf.kernel.pdf.action
Class PdfActionOcgState
- java.lang.Object
-
- com.itextpdf.kernel.pdf.action.PdfActionOcgState
-
public class PdfActionOcgState extends java.lang.Object
This is a helper class for optional content states use in Set-OCG-State actions. SeePdfAction.createSetOcgState(java.util.List<com.itextpdf.kernel.pdf.action.PdfActionOcgState>)
.
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<PdfDictionary>
ocgs
Optional content group dictionariesprivate PdfName
state
-
Constructor Summary
Constructors Constructor Description PdfActionOcgState(PdfName state, java.util.List<PdfDictionary> ocgs)
Constructs an optional content state object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<PdfObject>
getObjectList()
Gets a list ofPdfObject
that is describing this particular optional content group states.java.util.List<PdfDictionary>
getOcgs()
Gets a list of optional content groups that shall have the state changedPdfName
getState()
Gets the state the optional content groups should be switched to
-
-
-
Field Detail
-
state
private PdfName state
-
ocgs
private java.util.List<PdfDictionary> ocgs
Optional content group dictionaries
-
-
Constructor Detail
-
PdfActionOcgState
public PdfActionOcgState(PdfName state, java.util.List<PdfDictionary> ocgs)
Constructs an optional content state object.- Parameters:
state
- aPdfName
describing the state. Shall be one of the following:PdfName.OFF
,PdfName.ON
,PdfName.Toggle
ocgs
- a list of the OCG dictionaries
-
-
Method Detail
-
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 java.util.List<PdfDictionary> getOcgs()
Gets a list of optional content groups that shall have the state changed- Returns:
- the list of optional content groups
-
-