org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm 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.graphics.xobject;
import java.awt.geom.AffineTransform;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSFloat;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSNumber;
import org.apache.pdfbox.cos.COSStream;
import org.apache.pdfbox.pdmodel.PDResources;
import org.apache.pdfbox.pdmodel.common.PDRectangle;
import org.apache.pdfbox.pdmodel.common.PDStream;
import org.apache.pdfbox.util.Matrix;
/**
* A form xobject.
*
* @author Ben Litchfield
* @version $Revision: 1.6 $
*/
public class PDXObjectForm extends PDXObject
{
/**
* The XObject subtype.
*/
public static final String SUB_TYPE = "Form";
/**
* Standard constructor.
*
* @param formStream The XObject is passed as a COSStream.
*/
public PDXObjectForm(PDStream formStream)
{
super(formStream);
getCOSStream().setName(COSName.SUBTYPE, SUB_TYPE);
}
/**
* Standard constuctor.
*
* @param formStream The XObject is passed as a COSStream.
*/
public PDXObjectForm(COSStream formStream)
{
super(formStream);
getCOSStream().setName(COSName.SUBTYPE, SUB_TYPE);
}
/**
* This will get the form type, currently 1 is the only form type.
*
* @return The form type.
*/
public int getFormType()
{
return getCOSStream().getInt("FormType", 1);
}
/**
* Set the form type.
*
* @param formType The new form type.
*/
public void setFormType(int formType)
{
getCOSStream().setInt("FormType", formType);
}
/**
* This will get the resources at this page and not look up the hierarchy. This attribute is inheritable, and
* findResources() should probably used. This will return null if no resources are available at this level.
*
* @return The resources at this level in the hierarchy.
*/
public PDResources getResources()
{
PDResources retval = null;
COSDictionary resources = (COSDictionary) getCOSStream().getDictionaryObject(COSName.RESOURCES);
if (resources != null)
{
retval = new PDResources(resources);
}
return retval;
}
/**
* This will set the resources for this page.
*
* @param resources The new resources for this page.
*/
public void setResources(PDResources resources)
{
getCOSStream().setItem(COSName.RESOURCES, resources);
}
/**
* An array of four numbers in the form coordinate system (see below), giving the coordinates of the left, bottom,
* right, and top edges, respectively, of the form XObject's bounding box. These boundaries are used to clip the
* form XObject and to determine its size for caching.
*
* @return The BBox of the form.
*/
public PDRectangle getBBox()
{
PDRectangle retval = null;
COSArray array = (COSArray) getCOSStream().getDictionaryObject(COSName.BBOX);
if (array != null)
{
retval = new PDRectangle(array);
}
return retval;
}
/**
* This will set the BBox (bounding box) for this form.
*
* @param bbox The new BBox for this form.
*/
public void setBBox(PDRectangle bbox)
{
if (bbox == null)
{
getCOSStream().removeItem(COSName.BBOX);
}
else
{
getCOSStream().setItem(COSName.BBOX, bbox.getCOSArray());
}
}
/**
* This will get the optional Matrix of an XObjectForm. It maps the form space into the user space
*
* @return the form matrix
*/
public Matrix getMatrix()
{
Matrix retval = null;
COSBase base = getCOSStream().getDictionaryObject(COSName.MATRIX);
if (base instanceof COSArray && ((COSArray) base).size() >= 6)
{
COSArray array = (COSArray) base;
retval = new Matrix();
retval.setValue(0, 0, ((COSNumber) array.getObject(0)).floatValue());
retval.setValue(0, 1, ((COSNumber) array.getObject(1)).floatValue());
retval.setValue(1, 0, ((COSNumber) array.getObject(2)).floatValue());
retval.setValue(1, 1, ((COSNumber) array.getObject(3)).floatValue());
retval.setValue(2, 0, ((COSNumber) array.getObject(4)).floatValue());
retval.setValue(2, 1, ((COSNumber) array.getObject(5)).floatValue());
}
return retval;
}
/**
* Sets the optional Matrix entry for the form XObject.
*
* @param transform the transformation matrix
*/
public void setMatrix(AffineTransform transform)
{
COSArray matrix = new COSArray();
double[] values = new double[6];
transform.getMatrix(values);
for (double v : values)
{
matrix.add(new COSFloat((float) v));
}
getCOSStream().setItem(COSName.MATRIX, matrix);
}
/**
* This will get the key of this XObjectForm in the structural parent tree. Required if the form XObject contains
* marked-content sequences that are structural content items.
*
* @return the integer key of the XObjectForm's entry in the structural parent tree
*/
public int getStructParents()
{
return getCOSStream().getInt(COSName.STRUCT_PARENTS, 0);
}
/**
* This will set the key for this XObjectForm in the structural parent tree.
*
* @param structParent The new key for this XObjectForm.
*/
public void setStructParents(int structParent)
{
getCOSStream().setInt(COSName.STRUCT_PARENTS, structParent);
}
}