org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCircle Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pdfbox Show documentation
Show all versions of pdfbox Show documentation
The Apache PDFBox library is an open source Java tool for working with PDF documents.
/*
* 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.fdf;
import java.awt.Color;
import java.io.IOException;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.common.PDRectangle;
import org.w3c.dom.Element;
/**
* This represents a Circle FDF annotation.
*
* @author Ben Litchfield
*/
public class FDFAnnotationCircle extends FDFAnnotation
{
/**
* COS Model value for SubType entry.
*/
public static final String SUBTYPE = "Circle";
/**
* Default constructor.
*/
public FDFAnnotationCircle()
{
super();
annot.setName(COSName.SUBTYPE, SUBTYPE);
}
/**
* Constructor.
*
* @param a An existing FDF Annotation.
*/
public FDFAnnotationCircle(COSDictionary a)
{
super(a);
}
/**
* Constructor.
*
* @param element An XFDF element.
*
* @throws IOException If there is an error extracting information from the element.
*/
public FDFAnnotationCircle(Element element) throws IOException
{
super(element);
annot.setName(COSName.SUBTYPE, SUBTYPE);
String color = element.getAttribute("interior-color");
if (color != null && color.length() == 7 && color.charAt(0) == '#')
{
int colorValue = Integer.parseInt(color.substring(1, 7), 16);
setInteriorColor(new Color(colorValue));
}
initFringe(element);
}
private void initFringe(Element element) throws IOException
{
String fringe = element.getAttribute("fringe");
if (fringe != null && !fringe.isEmpty())
{
String[] fringeValues = fringe.split(",");
if (fringeValues.length != 4)
{
throw new IOException("Error: wrong amount of numbers in attribute 'fringe'");
}
PDRectangle rect = new PDRectangle();
rect.setLowerLeftX(Float.parseFloat(fringeValues[0]));
rect.setLowerLeftY(Float.parseFloat(fringeValues[1]));
rect.setUpperRightX(Float.parseFloat(fringeValues[2]));
rect.setUpperRightY(Float.parseFloat(fringeValues[3]));
setFringe(rect);
}
}
/**
* This will set interior color of the drawn area.
*
* @param color The interior color of the circle.
*/
public final void setInteriorColor(Color color)
{
COSArray array = null;
if (color != null)
{
float[] colors = color.getRGBColorComponents(null);
array = new COSArray();
array.setFloatArray(colors);
}
annot.setItem(COSName.IC, array);
}
/**
* This will retrieve the interior color of the drawn area.
*
* @return object representing the color.
*/
public Color getInteriorColor()
{
Color retval = null;
COSArray array = (COSArray) annot.getDictionaryObject(COSName.IC);
if (array != null)
{
float[] rgb = array.toFloatArray();
if (rgb.length >= 3)
{
retval = new Color(rgb[0], rgb[1], rgb[2]);
}
}
return retval;
}
/**
* This will set the fringe rectangle. Giving the difference between the annotations rectangle and where the drawing
* occurs. (To take account of any effects applied through the BE entry for example)
*
* @param fringe the fringe
*/
public final void setFringe(PDRectangle fringe)
{
annot.setItem(COSName.RD, fringe);
}
/**
* This will get the fringe. Giving the difference between the annotations rectangle and where the drawing occurs.
* (To take account of any effects applied through the BE entry for example)
*
* @return the rectangle difference
*/
public PDRectangle getFringe()
{
COSArray rd = (COSArray) annot.getDictionaryObject(COSName.RD);
if (rd != null)
{
return new PDRectangle(rd);
}
else
{
return null;
}
}
}