/*
* 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.interactive.annotation;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSStream;
import org.apache.pdfbox.pdmodel.common.COSObjectable;
import org.apache.pdfbox.pdmodel.common.PDStream;
import org.apache.pdfbox.pdmodel.graphics.color.PDGamma;
import org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject;
/**
* This class represents an appearance characteristics dictionary.
*
* @version $Revision: 1.0 $
*
*/
public class PDAppearanceCharacteristicsDictionary implements COSObjectable
{
private COSDictionary dictionary;
/**
* Constructor.
*
* @param dict dictionary
*/
public PDAppearanceCharacteristicsDictionary(COSDictionary dict)
{
this.dictionary = dict;
}
/**
* returns the dictionary.
* @return the dictionary
*/
public COSDictionary getDictionary()
{
return this.dictionary;
}
/**
* {@inheritDoc}
*
*/
public COSBase getCOSObject()
{
return this.dictionary;
}
/**
* This will retrieve the rotation of the annotation widget.
* It must be a multiple of 90. Default is 0
* @return the rotation
*/
public int getRotation()
{
return this.getDictionary().getInt(COSName.R, 0);
}
/**
* This will set the rotation.
*
* @param rotation the rotation as a multiple of 90
*/
public void setRotation(int rotation)
{
this.getDictionary().setInt(COSName.R, rotation);
}
/**
* This will retrieve the border color.
*
* @return the border color.
*/
public PDGamma getBorderColour()
{
COSBase c = this.getDictionary().getItem(COSName.getPDFName("BC"));
if (c instanceof COSArray)
{
return new PDGamma((COSArray) c);
}
return null;
}
/**
* This will set the border color.
*
* @param c the border color
*/
public void setBorderColour(PDGamma c)
{
this.getDictionary().setItem("BC", c);
}
/**
* This will retrieve the background color.
*
* @return the background color.
*/
public PDGamma getBackground()
{
COSBase c = this.getDictionary().getItem(COSName.getPDFName("BG"));
if (c instanceof COSArray)
{
return new PDGamma((COSArray) c);
}
return null;
}
/**
* This will set the background color.
*
* @param c the background color
*/
public void setBackground(PDGamma c)
{
this.getDictionary().setItem("BG", c);
}
/**
* This will retrieve the normal caption.
*
* @return the normal caption.
*/
public String getNormalCaption()
{
return this.getDictionary().getString("CA");
}
/**
* This will set the normal caption.
*
* @param caption the normal caption
*/
public void setNormalCaption(String caption)
{
this.getDictionary().setString("CA", caption);
}
/**
* This will retrieve the rollover caption.
*
* @return the rollover caption.
*/
public String getRolloverCaption()
{
return this.getDictionary().getString("RC");
}
/**
* This will set the rollover caption.
*
* @param caption the rollover caption
*/
public void setRolloverCaption(String caption)
{
this.getDictionary().setString("RC", caption);
}
/**
* This will retrieve the alternate caption.
*
* @return the alternate caption.
*/
public String getAlternateCaption()
{
return this.getDictionary().getString("AC");
}
/**
* This will set the alternate caption.
*
* @param caption the alternate caption
*/
public void setAlternateCaption(String caption)
{
this.getDictionary().setString("AC", caption);
}
/**
* This will retrieve the normal icon.
*
* @return the normal icon.
*/
public PDFormXObject getNormalIcon()
{
COSBase i = this.getDictionary().getDictionaryObject("I");
if (i instanceof COSStream)
{
return new PDFormXObject(new PDStream((COSStream) i), "I");
}
return null;
}
/**
* This will retrieve the rollover icon.
*
* @return the rollover icon
*/
public PDFormXObject getRolloverIcon()
{
COSBase i = this.getDictionary().getDictionaryObject("RI");
if (i instanceof COSStream)
{
return new PDFormXObject(new PDStream((COSStream) i), "RI");
}
return null;
}
/**
* This will retrieve the alternate icon.
*
* @return the alternate icon.
*/
public PDFormXObject getAlternateIcon()
{
COSBase i = this.getDictionary().getDictionaryObject("IX");
if (i instanceof COSStream)
{
return new PDFormXObject(new PDStream((COSStream) i), "IX");
}
return null;
}
}