Package com.itextpdf.forms.form.renderer

Class TextAreaRenderer

java.lang.Object

com.itextpdf.layout.renderer.AbstractRenderer

com.itextpdf.layout.renderer.BlockRenderer

com.itextpdf.forms.form.renderer.AbstractFormFieldRenderer

com.itextpdf.forms.form.renderer.AbstractTextFieldRenderer

com.itextpdf.forms.form.renderer.TextAreaRenderer

All Implemented Interfaces:

IPropertyContainer, IRenderer

       public class TextAreaRenderer extends AbstractTextFieldRenderer
      

The AbstractTextFieldRenderer implementation for text area fields.

Field Summary

Fields inherited from class com.itextpdf.forms.form.renderer.AbstractTextFieldRenderer

font

Fields inherited from class com.itextpdf.forms.form.renderer.AbstractFormFieldRenderer

flatRenderer

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

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

Constructor Summary

Constructors

Constructor	Description
TextAreaRenderer(TextArea modelElement)	Creates a new TextAreaRenderer instance.

Method Summary

Modifier and Type	Method	Description
protected void	adjustFieldLayout(LayoutContext layoutContext)	Adjusts the field layout.
protected void	applyAcroField(DrawContext drawContext)	Applies the AcroField widget.
protected IRenderer	createFlatRenderer()	Creates the flat renderer instance.
int	getCols()	Gets the number of columns.
protected Float	getLastYLineRecursively()
IRenderer	getNextRenderer()	Gets a new instance of this class to be used as a next renderer, after this renderer is used, if IRenderer.layout(LayoutContext) is called more than once.
T1	getProperty(int key)	Gets the property from this entity.
int	getRows()	Gets the number of rows.
LayoutResult	layout(LayoutContext layoutContext)	This method simulates positioning of the renderer, including all of its children, and returns the LayoutResult, representing the layout result, including occupied area, status, i.e.
protected boolean	setMinMaxWidthBasedOnFixedWidth(MinMaxWidth minMaxWidth)

Methods inherited from class com.itextpdf.forms.form.renderer.AbstractFormFieldRenderer

applyAccessibilityProperties, draw, drawChildren, getConformance, getDefaultValue, getLang, getMinMaxWidth, getModelId, isFlatten, isLayoutBasedOnFlatRenderer, isRendererFit, writeAcroFormFieldLangAttribute

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

applyRotationLayout, applyVerticalAlignment, beginRotationIfApplied, createOverflowRenderer, createRotationTransformInsideOccupiedArea, createSplitRenderer, endRotationIfApplied, getMinMaxWidth, 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, getMargins, getModelElement, getOccupiedArea, getOwnProperties, getOwnProperty, getPaddings, getParent, 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, retrieveResolvedDeclaredHeight, retrieveUnitValue, retrieveUnitValue, retrieveWidth, setBorders, 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

Constructor Details

TextAreaRenderer

             public TextAreaRenderer
             (TextArea modelElement)
            

Creates a new TextAreaRenderer instance.

Parameters:

modelElement - the model element

Method Details

getCols

             public int getCols()
            

Gets the number of columns.

Returns:

the cols value of the text area field

getRows

             public int getRows()
            

Gets the number of rows.

Returns:

the rows value of the text area field

getLastYLineRecursively

             protected Float getLastYLineRecursively()
            

Overrides:

getLastYLineRecursively in class AbstractRenderer

getNextRenderer

             public IRenderer getNextRenderer()
            

Gets a new instance of this class to be used as a next renderer, after this renderer is used, if IRenderer.layout(LayoutContext) is called more than once.

Returns:

new renderer instance

layout

             public LayoutResult layout
             (LayoutContext layoutContext)
            

This method simulates positioning of the renderer, including all of its children, and returns the LayoutResult, representing the layout result, including occupied area, status, i.e. if there was enough place to fit the renderer subtree, etc. LayoutResult can be extended to return custom layout results for custom elements, e.g. TextRenderer uses TextLayoutResult as its result. This method can be called standalone to learn how much area the renderer subtree needs, or can be called before IRenderer.draw(DrawContext), to prepare the renderer to be flushed to the output stream.

Specified by:

layout in interface IRenderer

Overrides:

layout in class AbstractFormFieldRenderer

Parameters:

layoutContext - the description of layout area and any other additional information

Returns:

result of the layout process

getProperty

             public  T1 getProperty
             (int key)
            

Gets the property from this entity. Compared to IPropertyContainer.getOwnProperty(int), this method can check parent's properties, styles, etc, depending on the origin of the instance

Specified by:

getProperty in interface IPropertyContainer

Overrides:

getProperty in class AbstractRenderer

Type Parameters:

T1 - the return type associated with the property

Parameters:

key - the property to be retrieved

Returns:

the value of the given property. null will be returned if the property value was not found

adjustFieldLayout

             protected void adjustFieldLayout
             (LayoutContext layoutContext)
            

Adjusts the field layout.

Specified by:

adjustFieldLayout in class AbstractFormFieldRenderer

Parameters:

layoutContext - layout context

createFlatRenderer

             protected IRenderer createFlatRenderer()
            

Creates the flat renderer instance.

Specified by:

createFlatRenderer in class AbstractFormFieldRenderer

Returns:

the renderer instance.

applyAcroField

             protected void applyAcroField
             (DrawContext drawContext)
            

Applies the AcroField widget.

Specified by:

applyAcroField in class AbstractFormFieldRenderer

Parameters:

drawContext - the draw context

setMinMaxWidthBasedOnFixedWidth

             protected boolean setMinMaxWidthBasedOnFixedWidth
             (MinMaxWidth minMaxWidth)
            

Overrides:

setMinMaxWidthBasedOnFixedWidth in class AbstractRenderer