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
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
ConstructorDescriptionTextAreaRenderer
(TextArea modelElement) Creates a newTextAreaRenderer
instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
adjustFieldLayout
(LayoutContext layoutContext) Adjusts the field layout.protected void
applyAcroField
(DrawContext drawContext) Applies the AcroField widget.protected IRenderer
Creates the flat renderer instance.int
getCols()
Gets the number of columns.protected Float
Gets a new instance of this class to be used as a next renderer, after this renderer is used, ifIRenderer.layout(LayoutContext)
is called more than once.T1 getProperty
(int key) Gets the property from this entity.int
getRows()
Gets the number of rows.layout
(LayoutContext layoutContext) This method simulates positioning of the renderer, including all of its children, and returns theLayoutResult
, 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
draw, drawChildren, getDefaultValue, getLang, getMinMaxWidth, getModelId, isFlatten, isLayoutBasedOnFlatRenderer, isRendererFit, writeAcroFormFieldLangAttribute
Methods inherited from class com.itextpdf.layout.renderer.BlockRenderer
applyRotationLayout, applyVerticalAlignment, beginRotationIfApplied, createOverflowRenderer, createRotationTransformInsideOccupiedArea, createSplitRenderer, endRotationIfApplied, getOccupiedAreaBBox
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, retrieveUnitValue, retrieveUnitValue, retrieveWidth, setBorders, setParent, setProperty, toString, transformPoints, updateHeight, updateHeightsOnSplit, updateMaxHeight, updateMinHeight, updateWidth
-
Constructor Details
-
TextAreaRenderer
Creates a newTextAreaRenderer
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
- Overrides:
-
getLastYLineRecursively
in classAbstractRenderer
-
getNextRenderer
Gets a new instance of this class to be used as a next renderer, after this renderer is used, ifIRenderer.layout(LayoutContext)
is called more than once.- Returns:
- new renderer instance
-
layout
This method simulates positioning of the renderer, including all of its children, and returns theLayoutResult
, 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
usesTextLayoutResult
as its result. This method can be called standalone to learn how much area the renderer subtree needs, or can be called beforeIRenderer.draw(DrawContext)
, to prepare the renderer to be flushed to the output stream.- Specified by:
-
layout
in interfaceIRenderer
- Overrides:
-
layout
in classAbstractFormFieldRenderer
- Parameters:
-
layoutContext
- the description of layout area and any other additional information - Returns:
- result of the layout process
-
getProperty
publicT1 getProperty (int key) Gets the property from this entity. Compared toIPropertyContainer.getOwnProperty(int)
, this method can check parent's properties, styles, etc, depending on the origin of the instance- Specified by:
-
getProperty
in interfaceIPropertyContainer
- Overrides:
-
getProperty
in classAbstractRenderer
- 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
Adjusts the field layout.- Specified by:
-
adjustFieldLayout
in classAbstractFormFieldRenderer
- Parameters:
-
layoutContext
- layout context
-
createFlatRenderer
Creates the flat renderer instance.- Specified by:
-
createFlatRenderer
in classAbstractFormFieldRenderer
- Returns:
- the renderer instance
-
applyAcroField
Applies the AcroField widget.- Specified by:
-
applyAcroField
in classAbstractFormFieldRenderer
- Parameters:
-
drawContext
- the draw context
-
setMinMaxWidthBasedOnFixedWidth
- Overrides:
-
setMinMaxWidthBasedOnFixedWidth
in classAbstractRenderer
-