PDOptionalContentGroup (pdfbox-1.8.16 API)

java.lang.Object
- org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup

All Implemented Interfaces:

COSObjectable
```
public class PDOptionalContentGroup
extends java.lang.Object
implements COSObjectable
```
This class represents an optional content group (OCG).

Since:

PDF 1.5

Version:

$Revision$

Constructor Summary

Constructors
Constructor	Description
`PDOptionalContentGroup(java.lang.String name)`	Creates a new optional content group (OCG).
`PDOptionalContentGroup(COSDictionary dict)`	Creates a new instance based on a given `COSDictionary`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`COSBase`	`getCOSObject()`	Convert this standard java object to a COS object.
`java.lang.String`	`getName()`	Returns the name of the optional content group.
`void`	`setName(java.lang.String name)`	Sets the name of the optional content group.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PDOptionalContentGroup
```
public PDOptionalContentGroup(java.lang.String name)
```
    Creates a new optional content group (OCG).
    
    Parameters:
    
    name - the name of the content group
  - PDOptionalContentGroup
```
public PDOptionalContentGroup(COSDictionary dict)
```
    Creates a new instance based on a given COSDictionary.
    
    Parameters:
    
    dict - the dictionary
- Method Detail
  - getCOSObject
```
public COSBase getCOSObject()
```
    Convert this standard java object to a COS object.
    
    Specified by:
    
    getCOSObject in interface COSObjectable
    
    Returns:
    
    The cos object that matches this Java object.
  - getName
```
public java.lang.String getName()
```
    Returns the name of the optional content group.
    
    Returns:
    
    the name
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of the optional content group.
    
    Parameters:
    
    name - the name
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object