com.itextpdf.html2pdf.attach.impl.layout.form.renderer.AbstractFormFieldRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of html2pdf Show documentation
Show all versions of html2pdf Show documentation
pdfHTML is an iText 7 add-on that lets you to parse (X)HTML snippets and the associated CSS and converts
them to PDF.
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2019 iText Group NV
Authors: Bruno Lowagie, Paulo Soares, et al.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License version 3
as published by the Free Software Foundation with the addition of the
following permission added to Section 15 as permitted in Section 7(a):
FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
OF THIRD PARTY RIGHTS
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 http://www.gnu.org/licenses or write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA, 02110-1301 USA, or download the license from the following URL:
http://itextpdf.com/terms-of-use/
The interactive user interfaces in modified source and object code versions
of this program must display Appropriate Legal Notices, as required under
Section 5 of the GNU Affero General Public License.
In accordance with Section 7(b) of the GNU Affero General Public License,
a covered work must retain the producer line in every PDF that is created
or manipulated using iText.
You can be released from the requirements of the license by purchasing
a commercial license. Buying such a license is mandatory as soon as you
develop commercial activities involving the iText software without
disclosing the source code of your own applications.
These activities include: offering paid services to customers as an ASP,
serving PDFs on the fly in a web application, shipping iText with a closed
source product.
For more information, please contact iText Software Corp. at this
address: [email protected]
*/
package com.itextpdf.html2pdf.attach.impl.layout.form.renderer;
import com.itextpdf.html2pdf.LogMessageConstant;
import com.itextpdf.html2pdf.attach.impl.layout.Html2PdfProperty;
import com.itextpdf.html2pdf.attach.impl.layout.form.element.IFormField;
import com.itextpdf.kernel.geom.Rectangle;
import com.itextpdf.layout.layout.LayoutContext;
import com.itextpdf.layout.layout.LayoutResult;
import com.itextpdf.layout.layout.MinMaxWidthLayoutResult;
import com.itextpdf.layout.minmaxwidth.MinMaxWidth;
import com.itextpdf.layout.property.FloatPropertyValue;
import com.itextpdf.layout.property.OverflowPropertyValue;
import com.itextpdf.layout.property.Property;
import com.itextpdf.layout.property.UnitValue;
import com.itextpdf.layout.renderer.BlockRenderer;
import com.itextpdf.layout.renderer.DrawContext;
import com.itextpdf.layout.renderer.ILeafElementRenderer;
import com.itextpdf.layout.renderer.IRenderer;
import org.slf4j.LoggerFactory;
/**
* Abstract {@link BlockRenderer} for form fields.
*/
public abstract class AbstractFormFieldRenderer extends BlockRenderer implements ILeafElementRenderer {
/**
* The flat renderer.
*/
protected IRenderer flatRenderer;
/**
* Creates a new {@link AbstractFormFieldRenderer} instance.
*
* @param modelElement the model element
*/
AbstractFormFieldRenderer(IFormField modelElement) {
super(modelElement);
}
/**
* Checks if form fields need to be flattened.
*
* @return true, if fields need to be flattened
*/
public boolean isFlatten() {
Boolean flatten = getPropertyAsBoolean(Html2PdfProperty.FORM_FIELD_FLATTEN);
return flatten != null ? (boolean) flatten : (boolean) modelElement.getDefaultProperty(Html2PdfProperty.FORM_FIELD_FLATTEN);
}
/**
* Gets the default value of the form field.
*
* @return the default value of the form field
*/
public String getDefaultValue() {
String defaultValue = this.getProperty(Html2PdfProperty.FORM_FIELD_VALUE);
return defaultValue != null ? defaultValue : modelElement.getDefaultProperty(Html2PdfProperty.FORM_FIELD_VALUE);
}
/* (non-Javadoc)
* @see com.itextpdf.layout.renderer.BlockRenderer#layout(com.itextpdf.layout.layout.LayoutContext)
*/
@Override
public LayoutResult layout(LayoutContext layoutContext) {
childRenderers.clear();
flatRenderer = null;
float parentWidth = layoutContext.getArea().getBBox().getWidth();
float parentHeight = layoutContext.getArea().getBBox().getHeight();
IRenderer renderer = createFlatRenderer();
renderer.setProperty(Property.OVERFLOW_X, OverflowPropertyValue.VISIBLE);
renderer.setProperty(Property.OVERFLOW_Y, OverflowPropertyValue.VISIBLE);
addChild(renderer);
Rectangle bBox = layoutContext.getArea().getBBox().clone().moveDown(INF - parentHeight).setHeight(INF);
layoutContext.getArea().setBBox(bBox);
LayoutResult result = super.layout(layoutContext);
if (!Boolean.TRUE.equals(getPropertyAsBoolean(Property.FORCED_PLACEMENT)) && (result.getStatus() != LayoutResult.FULL)) {
//@TODO investigate this tricky code a little more.
FloatPropertyValue floatPropertyValue = this.getProperty(Property.FLOAT);
if (floatPropertyValue == null || floatPropertyValue == FloatPropertyValue.NONE) {
setProperty(Property.FORCED_PLACEMENT, true);
} else {
flatRenderer = childRenderers.get(0);
childRenderers.clear();
childRenderers.add(flatRenderer);
adjustFieldLayout(layoutContext);
if (isLayoutBasedOnFlatRenderer()) {
Rectangle fBox = flatRenderer.getOccupiedArea().getBBox();
occupiedArea.getBBox().setX(fBox.getX()).setY(fBox.getY()).setWidth(fBox.getWidth()).setHeight(fBox.getHeight());
applyPaddings(occupiedArea.getBBox(), true);
applyBorderBox(occupiedArea.getBBox(), true);
applyMargins(occupiedArea.getBBox(), true);
}
}
return new MinMaxWidthLayoutResult(LayoutResult.NOTHING, occupiedArea, null, this, this).setMinMaxWidth(new MinMaxWidth());
}
if (!childRenderers.isEmpty()) {
flatRenderer = childRenderers.get(0);
childRenderers.clear();
childRenderers.add(flatRenderer);
adjustFieldLayout(layoutContext);
if (isLayoutBasedOnFlatRenderer()) {
Rectangle fBox = flatRenderer.getOccupiedArea().getBBox();
occupiedArea.getBBox().setX(fBox.getX()).setY(fBox.getY()).setWidth(fBox.getWidth()).setHeight(fBox.getHeight());
applyPaddings(occupiedArea.getBBox(), true);
applyBorderBox(occupiedArea.getBBox(), true);
applyMargins(occupiedArea.getBBox(), true);
}
} else {
LoggerFactory.getLogger(getClass()).error(LogMessageConstant.ERROR_WHILE_LAYOUT_OF_FORM_FIELD);
occupiedArea.getBBox().setWidth(0).setHeight(0);
}
if (!Boolean.TRUE.equals(getPropertyAsBoolean(Property.FORCED_PLACEMENT)) && !isRendererFit(parentWidth, parentHeight)) {
occupiedArea.getBBox().setWidth(0).setHeight(0);
return new MinMaxWidthLayoutResult(LayoutResult.NOTHING, occupiedArea, null, this, this).setMinMaxWidth(new MinMaxWidth());
}
if (result.getStatus() != LayoutResult.FULL || !isRendererFit(parentWidth, parentHeight)) {
LoggerFactory.getLogger(getClass()).warn(LogMessageConstant.INPUT_FIELD_DOES_NOT_FIT);
}
return new MinMaxWidthLayoutResult(LayoutResult.FULL, occupiedArea, this, null)
.setMinMaxWidth(new MinMaxWidth(occupiedArea.getBBox().getWidth(), occupiedArea.getBBox().getWidth(), 0));
}
/* (non-Javadoc)
* @see com.itextpdf.layout.renderer.BlockRenderer#draw(com.itextpdf.layout.renderer.DrawContext)
*/
@Override
public void draw(DrawContext drawContext) {
if (flatRenderer != null) {
super.draw(drawContext);
}
}
/* (non-Javadoc)
* @see com.itextpdf.layout.renderer.AbstractRenderer#drawChildren(com.itextpdf.layout.renderer.DrawContext)
*/
@Override
public void drawChildren(DrawContext drawContext) {
drawContext.getCanvas().saveState();
boolean flatten = isFlatten();
if (flatten) {
drawContext.getCanvas().rectangle(applyBorderBox(occupiedArea.getBBox(), false)).clip().newPath();
flatRenderer.draw(drawContext);
} else {
applyAcroField(drawContext);
}
drawContext.getCanvas().restoreState();
}
@Override
public float getAscent() {
Float baseline = getLastYLineRecursively();
return baseline != null ? occupiedArea.getBBox().getTop() - (float) baseline : occupiedArea.getBBox().getHeight();
}
@Override
public float getDescent() {
Float baseline = getLastYLineRecursively();
return baseline != null ? occupiedArea.getBBox().getBottom() - (float) baseline : 0;
}
/* (non-Javadoc)
* @see com.itextpdf.layout.renderer.BlockRenderer#getMinMaxWidth(float)
*/
@Override
public MinMaxWidth getMinMaxWidth() {
childRenderers.clear();
flatRenderer = null;
IRenderer renderer = createFlatRenderer();
addChild(renderer);
MinMaxWidth minMaxWidth = super.getMinMaxWidth();
return minMaxWidth;
}
/**
* Adjusts the field layout.
*
* @deprecated Will be removed in 3.0.0, override {@link #adjustFieldLayout(LayoutContext)} instead.
*/
@Deprecated
protected abstract void adjustFieldLayout();
//NOTE: should be abstract in 3.0.0
protected void adjustFieldLayout(LayoutContext layoutContext) {
adjustFieldLayout();
}
/**
* Creates the flat renderer instance.
*
* @return the renderer instance
*/
protected abstract IRenderer createFlatRenderer();
/**
* Applies the AcroField widget.
*
* @param drawContext the draw context
*/
protected abstract void applyAcroField(DrawContext drawContext);
/**
* Gets the model id.
*
* @return the model id
*/
protected String getModelId() {
return ((IFormField) getModelElement()).getId();
}
/**
* Checks if the renderer fits a certain width and height.
*
* @param availableWidth the available width
* @param availableHeight the available height
* @return true, if the renderer fits
*/
protected boolean isRendererFit(float availableWidth, float availableHeight) {
if (occupiedArea == null) {
return false;
}
return availableHeight >= occupiedArea.getBBox().getHeight() && availableWidth >= occupiedArea.getBBox().getWidth();
}
/**
* Gets the content width.
*
* @return the content width
* @deprecated will be removed in 3.0.0. Use {@link #retrieveWidth(float)}} instead.
*/
@Deprecated
protected Float getContentWidth() {
return super.retrieveWidth(0);
}
//NOTE: should be removed in 3.0.0
@Override
protected Float retrieveWidth(float parentBoxWidth) {
UnitValue width = super.getProperty(Property.WIDTH);
if (width != null && width.isPointValue()) {
return getContentWidth();
}
return super.retrieveWidth(parentBoxWidth);
}
protected boolean isLayoutBasedOnFlatRenderer() {
return true;
}
}