com.itextpdf.forms.form.renderer.SignatureAppearanceRenderer Maven / Gradle / Ivy
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2024 Apryse Group NV
Authors: Apryse Software.
This program is offered under a commercial and under the AGPL license.
For commercial licensing, contact us at https://itextpdf.com/sales. For AGPL licensing, see below.
AGPL licensing:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see properties = FormFieldRendererUtil.removeProperties(this.modelElement);
PdfPage page = doc.getPage(occupiedArea.getPageNumber());
Background background = this.getProperty(Property.BACKGROUND);
// Background is light gray by default, but can be set to null by user.
final Color backgroundColor = background == null ? null : background.getColor();
final float fontSizeValue = fontSize.getValue();
if (font == null) {
font = doc.getDefaultFont();
}
// Some properties are set to the HtmlDocumentRenderer, which is root renderer for this SigFieldRenderer, but
// in forms logic root renderer is CanvasRenderer, and these properties will have default values. So
// we get them from renderer and set these properties to model element, which will be passed to forms logic.
modelElement.setProperty(Property.FONT_PROVIDER, this.getProperty(Property.FONT_PROVIDER));
modelElement.setProperty(Property.RENDERING_MODE, this.getProperty(Property.RENDERING_MODE));
final PdfSignatureFormField sigField = new SignatureFormFieldBuilder(doc, name).setWidgetRectangle(area)
.setGenericConformanceLevel(getGenericConformanceLevel(doc))
.setFont(font)
.createSignature();
sigField.disableFieldRegeneration();
sigField.setFontSize(fontSizeValue);
sigField.getFirstFormAnnotation().setBackgroundColor(backgroundColor);
applyDefaultFieldProperties(sigField);
applyAccessibilityProperties(sigField,doc);
sigField.getFirstFormAnnotation().setFormFieldElement((SignatureFieldAppearance) modelElement);
sigField.enableFieldRegeneration();
PdfAcroForm forms = PdfFormCreator.getAcroForm(doc, true);
forms.addField(sigField, page);
FormFieldRendererUtil.reapplyProperties(modelElement, properties);
}
private void adjustChildrenLayout(RenderingMode renderingMode,
Rectangle signatureRect, Rectangle descriptionRect, int pageNum) {
switch (renderingMode) {
case NAME_AND_DESCRIPTION: {
ParagraphRenderer name = (ParagraphRenderer) flatRenderer.getChildRenderers().get(0);
relayoutParagraph(name, signatureRect, pageNum);
ParagraphRenderer description = (ParagraphRenderer) flatRenderer.getChildRenderers().get(1);
relayoutParagraph(description, descriptionRect, pageNum);
break;
}
case GRAPHIC_AND_DESCRIPTION: {
relayoutImage(signatureRect, pageNum);
ParagraphRenderer description = (ParagraphRenderer) flatRenderer.getChildRenderers().get(1);
relayoutParagraph(description, descriptionRect, pageNum);
break;
}
case GRAPHIC: {
relayoutImage(signatureRect, pageNum);
break;
}
default: {
ParagraphRenderer description = (ParagraphRenderer) flatRenderer.getChildRenderers().get(0);
relayoutParagraph(description, descriptionRect, pageNum);
break;
}
}
// Apply vertical alignment for children including floats.
VerticalAlignment verticalAlignment = this.getProperty(Property.VERTICAL_ALIGNMENT);
float multiplier = 0;
if (VerticalAlignment.MIDDLE == verticalAlignment) {
multiplier = 0.5f;
} else if (VerticalAlignment.BOTTOM == verticalAlignment) {
multiplier = 1;
}
float lowestChildBottom = getLowestChildBottom(flatRenderer, getInnerAreaBBox().getTop());
float deltaY = lowestChildBottom - getInnerAreaBBox().getY();
if (deltaY > 0) {
flatRenderer.move(0, -deltaY * multiplier);
}
}
private void relayoutImage(Rectangle signatureRect, int pageNum) {
ImageRenderer image = (ImageRenderer) flatRenderer.getChildRenderers().get(0);
Rectangle imageBBox = image.getOccupiedArea().getBBox();
float imgWidth = imageBBox.getWidth();
if (imgWidth < EPS) {
imgWidth = signatureRect.getWidth();
}
float imgHeight = imageBBox.getHeight();
if (imgHeight < EPS) {
imgHeight = signatureRect.getHeight();
}
float multiplierH = signatureRect.getWidth() / imgWidth;
float multiplierW = signatureRect.getHeight() / imgHeight;
float multiplier = Math.min(multiplierH, multiplierW);
imgWidth *= multiplier;
imgHeight *= multiplier;
float x = signatureRect.getLeft() + (signatureRect.getWidth() - imgWidth) / 2;
float y = signatureRect.getBottom() + (signatureRect.getHeight() - imgHeight) / 2;
// We need to re-layout image since signature was divided into 2 parts and bBox was changed.
LayoutContext layoutContext = new LayoutContext(
new LayoutArea(pageNum, new Rectangle(x, y, imgWidth, imgHeight)));
image.getModelElement().setProperty(Property.WIDTH, UnitValue.createPointValue(imgWidth));
image.getModelElement().setProperty(Property.HEIGHT, UnitValue.createPointValue(imgHeight));
image.layout(layoutContext);
}
private void relayoutParagraph(IRenderer renderer, Rectangle rect, int pageNum) {
UnitValue fontSizeAsUV = this.hasOwnProperty(Property.FONT_SIZE) ?
(UnitValue) this.getOwnProperty(Property.FONT_SIZE) :
(UnitValue) modelElement.getOwnProperty(Property.FONT_SIZE);
if (fontSizeAsUV == null || fontSizeAsUV.getValue() < EPS || isFontSizeApproximated) {
// Calculate font size.
IRenderer helper = ((Paragraph) renderer.getModelElement()).createRendererSubTree()
.setParent(renderer.getParent());
this.deleteProperty(Property.FONT_SIZE);
LayoutContext layoutContext = new LayoutContext(new LayoutArea(pageNum, rect));
float lFontSize = 0.1f, rFontSize = 100;
int numberOfIterations = 15;
// 15 iterations with lFontSize = 0.1 and rFontSize = 100 should result in ~0.003 precision.
float fontSize = calculateFittingFontSize(helper, lFontSize, rFontSize, layoutContext, numberOfIterations);
renderer.getModelElement().setProperty(Property.FONT_SIZE, UnitValue.createPointValue(fontSize));
}
// Relayout the element after font size was changed or signature was split into 2 parts.
LayoutContext layoutContext = new LayoutContext(new LayoutArea(pageNum, rect));
renderer.layout(layoutContext);
}
private float calculateAdditionalHeight() {
Rectangle dummy = new Rectangle(0, 0);
this.applyMargins(dummy, true);
this.applyBorderBox(dummy, true);
this.applyPaddings(dummy, true);
return dummy.getHeight();
}
private void approximateFontSizeToFitLayoutArea(LayoutContext layoutContext) {
if (this.hasOwnProperty(Property.FONT_SIZE) || modelElement.hasOwnProperty(Property.FONT_SIZE)) {
return;
}
if (RenderingMode.GRAPHIC == renderingMode || RenderingMode.GRAPHIC_AND_DESCRIPTION == renderingMode ||
RenderingMode.CUSTOM == renderingMode) {
// We can expect CLIP_ELEMENT log messages since the initial image size may be larger than the field height.
// But image size will be adjusted during its relayout in #adjustFieldLayout.
return;
}
float fontSize = approximateFontSize(layoutContext, 0.1f, AbstractPdfFormField.DEFAULT_FONT_SIZE);
if (fontSize > 0) {
isFontSizeApproximated = true;
modelElement.setProperty(Property.FONT_SIZE, UnitValue.createPointValue(fontSize));
}
}
private RenderingMode retrieveRenderingMode() {
List contentElements = ((SignatureFieldAppearance) modelElement).getContentElements();
if (contentElements.size() == 2 && contentElements.get(1) instanceof Paragraph) {
if (contentElements.get(0) instanceof Paragraph) {
return RenderingMode.NAME_AND_DESCRIPTION;
}
if (contentElements.get(0) instanceof Image) {
return RenderingMode.GRAPHIC_AND_DESCRIPTION;
}
}
if (contentElements.size() == 1) {
if (contentElements.get(0) instanceof Paragraph) {
return RenderingMode.DESCRIPTION;
}
if (contentElements.get(0) instanceof Image) {
return RenderingMode.GRAPHIC;
}
}
return RenderingMode.CUSTOM;
}
/**
* Signature rendering modes.
*/
private enum RenderingMode {
/**
* The rendering mode is just the description.
*/
DESCRIPTION,
/**
* The rendering mode is the name of the signer and the description.
*/
NAME_AND_DESCRIPTION,
/**
* The rendering mode is an image and the description.
*/
GRAPHIC_AND_DESCRIPTION,
/**
* The rendering mode is just an image.
*/
GRAPHIC,
/**
* The rendering mode is div.
*/
CUSTOM
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy