com.itextpdf.forms.form.renderer

Class AbstractFormFieldRenderer

java.lang.Object

com.itextpdf.layout.renderer.AbstractRenderer

com.itextpdf.layout.renderer.BlockRenderer

com.itextpdf.forms.form.renderer.AbstractFormFieldRenderer

All Implemented Interfaces:

IPropertyContainer, IRenderer

Direct Known Subclasses:

AbstractTextFieldRenderer, CheckBoxRenderer, RadioRenderer

public abstract class AbstractFormFieldRenderer
extends BlockRenderer

Abstract BlockRenderer for form fields.

Field Summary

Fields

Modifier and Type	Field and Description
protected IRenderer	flatRenderer The flat renderer.

Fields inherited from class com.itextpdf.layout.renderer.AbstractRenderer

childRenderers, EPS, flushed, INF, isLastRendererForModelElement, modelElement, occupiedArea, OVERLAP_EPSILON, parent, positionedRenderers, properties

Method Summary

Modifier and Type	Method and Description
protected abstract void	adjustFieldLayout(LayoutContext layoutContext) Adjusts the field layout.
protected void	applyAccessibilityProperties(PdfFormField formField, PdfDocument pdfDocument) Applies the accessibility properties to the form field.
protected abstract void	applyAcroField(DrawContext drawContext) Applies the AcroField widget.
protected abstract IRenderer	createFlatRenderer() Creates the flat renderer instance.
void	draw(DrawContext drawContext)
void	drawChildren(DrawContext drawContext)
protected PdfConformance	getConformance(PdfDocument document) Gets the conformance.
String	getDefaultValue() Gets the default value of the form field.
protected String	getLang() Gets the accessibility language using IAccessibleElement.getAccessibilityProperties().
MinMaxWidth	getMinMaxWidth()
protected String	getModelId() Gets the model id.
boolean	isFlatten() Checks if form fields need to be flattened.
protected boolean	isLayoutBasedOnFlatRenderer() Determines, whether the layout is based in the renderer itself or flat renderer.
protected boolean	isRendererFit(float availableWidth, float availableHeight) Checks if the renderer fits a certain width and height.
LayoutResult	layout(LayoutContext layoutContext)
protected void	writeAcroFormFieldLangAttribute(PdfDocument pdfDoc) Sets the form accessibility language identifier of the form element in case the document is tagged.

Methods inherited from class com.itextpdf.layout.renderer.BlockRenderer

applyRotationLayout, applyVerticalAlignment, beginRotationIfApplied, createOverflowRenderer, createRotationTransformInsideOccupiedArea, createSplitRenderer, endRotationIfApplied, getOccupiedAreaBBox, getResolvedFont

Methods inherited from class com.itextpdf.layout.renderer.AbstractRenderer

addAllProperties, addChild, alignChildHorizontally, allowLastYLineRecursiveExtraction, applyAbsolutePosition, applyAction, applyBorderBox, applyBorderBox, applyDestination, applyDestinationsAndAnnotation, applyLinkAnnotation, applyMargins, applyMargins, applyPaddings, applyPaddings, applyRelativePositioningTranslation, beginElementOpacityApplying, beginTransformationIfApplied, calculateAbsolutePdfBBox, calculateBBox, calculateShiftToPositionBBoxOfPointsAt, clipBackgroundArea, clipBackgroundArea, clipBorderArea, createXObject, deleteOwnProperty, deleteProperty, drawBackground, drawBorder, endElementOpacityApplying, endTransformationIfApplied, getBackgroundArea, getBorderAreaBBox, getBorderRadii, getBorders, getChildRenderers, getDefaultProperty, getFirstYLineRecursively, getInnerAreaBBox, getLastYLineRecursively, getMargins, getModelElement, getOccupiedArea, getOwnProperties, getOwnProperty, getPaddings, getParent, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsColor, getPropertyAsFloat, getPropertyAsFloat, getPropertyAsFont, getPropertyAsInteger, getPropertyAsTransparentColor, getPropertyAsUnitValue, hasAbsoluteUnitValue, hasOwnOrModelProperty, hasOwnProperty, hasProperty, hasRelativeUnitValue, initElementAreas, isAbsolutePosition, isBorderBoxSizing, isFirstOnRootArea, isFixedLayout, isFlushed, isKeepTogether, isNotFittingHeight, isNotFittingLayoutArea, isNotFittingWidth, isOverflowFit, isOverflowProperty, isOverflowProperty, isOverflowProperty, isPositioned, isRelativePosition, isStaticLayout, move, rectangleToPointsList, retrieveHeight, retrieveMaxHeight, retrieveMaxWidth, retrieveMinHeight, retrieveMinWidth, retrieveUnitValue, retrieveUnitValue, retrieveWidth, setBorders, setMinMaxWidthBasedOnFixedWidth, setParent, setProperty, toString, transformPoints, updateHeight, updateHeightsOnSplit, updateMaxHeight, updateMinHeight, updateWidth

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.itextpdf.layout.renderer.IRenderer

getNextRenderer

Field Detail

flatRenderer

protected IRenderer flatRenderer

The flat renderer.

Method Detail

isFlatten

public boolean isFlatten()

Checks if form fields need to be flattened.

Returns:

true, if fields need to be flattened.

getDefaultValue

public String getDefaultValue()

Gets the default value of the form field.

Returns:

the default value of the form field.

layout

public LayoutResult layout(LayoutContext layoutContext)

Specified by:

layout in interface IRenderer

Overrides:

layout in class BlockRenderer

draw

public void draw(DrawContext drawContext)

Specified by:

draw in interface IRenderer

Overrides:

draw in class BlockRenderer

getMinMaxWidth

public MinMaxWidth getMinMaxWidth()

Overrides:

getMinMaxWidth in class BlockRenderer

drawChildren

public void drawChildren(DrawContext drawContext)

Overrides:

drawChildren in class AbstractRenderer

applyAccessibilityProperties

protected void applyAccessibilityProperties(PdfFormField formField,
                                            PdfDocument pdfDocument)

Applies the accessibility properties to the form field.

Parameters:

formField - The form field to which the accessibility properties should be applied.

pdfDocument - The document to which the form field belongs.

adjustFieldLayout

protected abstract void adjustFieldLayout(LayoutContext layoutContext)

Adjusts the field layout.

Parameters:

layoutContext - layout context

createFlatRenderer

protected abstract IRenderer createFlatRenderer()

Creates the flat renderer instance.

Returns:

the renderer instance.

applyAcroField

protected abstract void applyAcroField(DrawContext drawContext)

Applies the AcroField widget.

Parameters:

drawContext - the draw context

getModelId

protected String getModelId()

Gets the model id.

Returns:

the model id.

isRendererFit

protected boolean isRendererFit(float availableWidth,
                                float availableHeight)

Checks if the renderer fits a certain width and height.

Parameters:

availableWidth - the available width

availableHeight - the available height

Returns:

true, if the renderer fits.

getLang

protected String getLang()

Gets the accessibility language using IAccessibleElement.getAccessibilityProperties().

Returns:

the accessibility language.

getConformance

protected PdfConformance getConformance(PdfDocument document)

Gets the conformance. If the conformance is not set, the conformance of the document is used.

Parameters:

document - the document

Returns:

the conformance or null if the conformance is not set.

isLayoutBasedOnFlatRenderer

protected boolean isLayoutBasedOnFlatRenderer()

Determines, whether the layout is based in the renderer itself or flat renderer.

Returns:

true if layout is based on flat renderer, false otherwise.

writeAcroFormFieldLangAttribute

protected void writeAcroFormFieldLangAttribute(PdfDocument pdfDoc)

Sets the form accessibility language identifier of the form element in case the document is tagged.

Parameters:

pdfDoc - the document which contains form field