/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.pdfbox.pdmodel.graphics.optionalcontent;
import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.common.COSObjectable;
/**
* This class represents an optional content group (OCG).
*
* @since PDF 1.5
* @version $Revision$
*/
public class PDOptionalContentGroup implements COSObjectable
{
private COSDictionary ocg;
/**
* Creates a new optional content group (OCG).
* @param name the name of the content group
*/
public PDOptionalContentGroup(String name)
{
this.ocg = new COSDictionary();
this.ocg.setItem(COSName.TYPE, COSName.OCG);
setName(name);
}
/**
* Creates a new instance based on a given {@link COSDictionary}.
* @param dict the dictionary
*/
public PDOptionalContentGroup(COSDictionary dict)
{
if (!dict.getItem(COSName.TYPE).equals(COSName.OCG))
{
throw new IllegalArgumentException(
"Provided dictionary is not of type '" + COSName.OCG + "'");
}
this.ocg = dict;
}
/** {@inheritDoc} */
public COSBase getCOSObject()
{
return this.ocg;
}
/**
* Returns the name of the optional content group.
* @return the name
*/
public String getName()
{
return this.ocg.getString(COSName.NAME);
}
/**
* Sets the name of the optional content group.
* @param name the name
*/
public void setName(String name)
{
this.ocg.setString(COSName.NAME, name);
}
//TODO Add support for "Intent" and "Usage"
/** {@inheritDoc} */
@Override
public String toString()
{
return super.toString() + " (" + getName() + ")";
}
}