com.lowagie.text.pdf: public class: PdfFormXObject

com.lowagie.text.pdf
public class: PdfFormXObject [javadoc | source]

java.lang.Object
   com.lowagie.text.pdf.PdfObject
      com.lowagie.text.pdf.PdfDictionary
         com.lowagie.text.pdf.PdfStream
            com.lowagie.text.pdf.PdfFormXObject

PdfFormObject is a type of XObject containing a template-object.

Field Summary
public static final PdfNumber	ZERO	This is a PdfNumber representing 0.
public static final PdfNumber	ONE	This is a PdfNumber representing 1.
public static final PdfLiteral	MATRIX	This is the 1 - matrix.

Fields inherited from com.lowagie.text.pdf.PdfStream:
DEFAULT_COMPRESSION, NO_COMPRESSION, BEST_SPEED, BEST_COMPRESSION, compressed, compressionLevel, streamBytes, inputStream, ref, inputStreamLength, writer, rawLength, STARTSTREAM, ENDSTREAM, SIZESTREAM

Fields inherited from com.lowagie.text.pdf.PdfDictionary:
FONT, OUTLINES, PAGE, PAGES, CATALOG, hashMap

Fields inherited from com.lowagie.text.pdf.PdfObject:
BOOLEAN, NUMBER, STRING, NAME, ARRAY, DICTIONARY, STREAM, NULL, INDIRECT, NOTHING, TEXT_PDFDOCENCODING, TEXT_UNICODE, bytes, type, indRef

Constructor:

Constructor:
PdfFormXObject(PdfTemplate template, int compressionLevel) { // throws BadPdfFormatException super(); put(PdfName.TYPE, PdfName.XOBJECT); put(PdfName.SUBTYPE, PdfName.FORM); put(PdfName.RESOURCES, template.getResources()); put(PdfName.BBOX, new PdfRectangle(template.getBoundingBox())); put(PdfName.FORMTYPE, ONE); if (template.getLayer() != null) put(PdfName.OC, template.getLayer().getRef()); if (template.getGroup() != null) put(PdfName.GROUP, template.getGroup()); PdfArray matrix = template.getMatrix(); if (matrix == null) put(PdfName.MATRIX, MATRIX); else put(PdfName.MATRIX, matrix); bytes = template.toPdf(null); put(PdfName.LENGTH, new PdfNumber(bytes.length)); flateCompress(compressionLevel); } Constructs a `PdfFormXObject`-object. Parameters: `template` - the template `compressionLevel` - the compression level for the stream since: `2.1.3` - (Replacing the existing constructor with param compressionLevel)

 PdfFormXObject(PdfTemplate template,
    int compressionLevel) {
    
        // throws BadPdfFormatException
        super();
        put(PdfName.TYPE, PdfName.XOBJECT);
        put(PdfName.SUBTYPE, PdfName.FORM);
        put(PdfName.RESOURCES, template.getResources());
        put(PdfName.BBOX, new PdfRectangle(template.getBoundingBox()));
        put(PdfName.FORMTYPE, ONE);
        if (template.getLayer() != null)
            put(PdfName.OC, template.getLayer().getRef());
        if (template.getGroup() != null)
            put(PdfName.GROUP, template.getGroup());
        PdfArray matrix = template.getMatrix();
        if (matrix == null)
            put(PdfName.MATRIX, MATRIX);
        else
            put(PdfName.MATRIX, matrix);
        bytes = template.toPdf(null);
        put(PdfName.LENGTH, new PdfNumber(bytes.length));
        flateCompress(compressionLevel);
}

PdfFormXObject

Parameters:

template - the template

compressionLevel - the compression level for the stream

since: 2.1.3 - (Replacing the existing constructor with param compressionLevel)

Methods from com.lowagie.text.pdf.PdfStream:
flateCompress, flateCompress, getRawLength, superToPdf, toPdf, toString, writeContent, writeLength

Methods from com.lowagie.text.pdf.PdfDictionary:
contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString

Methods from com.lowagie.text.pdf.PdfObject:
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, toPdf, toString, type

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait