com.itextpdf.forms.form.element

Class TextArea

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer<T>

com.itextpdf.layout.element.AbstractElement<T>

com.itextpdf.forms.form.element.FormField<TextArea>

com.itextpdf.forms.form.element.TextArea

All Implemented Interfaces:

IFormField, IPlaceholderable, IAbstractElement, IBlockElement, IElement, IPropertyContainer

public class TextArea
extends FormField<TextArea>
implements IPlaceholderable

Extension of the FormField class representing a button so that a TextAreaRenderer is used instead of the default renderer for fields.

Field Summary

Fields inherited from class com.itextpdf.layout.element.AbstractElement

childElements, nextRenderer, styles

Fields inherited from class com.itextpdf.layout.ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor and Description
TextArea(String id) Creates a new TextArea instance.

Method Summary

Modifier and Type	Method and Description
<T1> T1	getDefaultProperty(int property)
Paragraph	getPlaceholder() Gets the placeholder paragraph.
protected IRenderer	makeNewRenderer()
void	setPlaceholder(Paragraph placeholder) Sets the placeholder paragraph.
TextArea	useAsPassword(boolean isPassword) Determines, whether the input field will be password.

Methods inherited from class com.itextpdf.forms.form.element.FormField

getId, setHeight, setInteractive, setSize, setValue, setWidth

Methods inherited from class com.itextpdf.layout.element.AbstractElement

addStyle, createRendererSubTree, getChildren, getProperty, getRenderer, hasProperty, isEmpty, setAction, setNextRenderer, setPageNumber

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundImage, setBackgroundImage, setBaseDirection, setBold, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFontColor, setFontColor, setFontColor, setFontFamily, setFontFamily, setFontKerning, setFontScript, setFontSize, setHorizontalAlignment, setHyphenation, setItalic, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setWordSpacing

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itextpdf.layout.element.IAbstractElement

getChildren

Methods inherited from interface com.itextpdf.layout.element.IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

deleteOwnProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Constructor Detail

TextArea

public TextArea(String id)

Creates a new TextArea instance.

Parameters:

id - the id

Method Detail

useAsPassword

public TextArea useAsPassword(boolean isPassword)

Determines, whether the input field will be password.

Usually means that instead of glyphs '*' will be shown in case of flatten field.

If the field is not flatten, value will be ignored.

Parameters:

isPassword - true is this field shall be considered as password, false otherwise

Returns:

this input field

getDefaultProperty

public <T1> T1 getDefaultProperty(int property)

Description copied from class: FormField

Specified by:

getDefaultProperty in interface IPropertyContainer

Overrides:

getDefaultProperty in class FormField<TextArea>

Parameters:

property -

Returns:

getPlaceholder

public Paragraph getPlaceholder()

Gets the placeholder paragraph.

Specified by:

getPlaceholder in interface IPlaceholderable

Returns:

the placeholder paragraph

setPlaceholder

public void setPlaceholder(Paragraph placeholder)

Sets the placeholder paragraph.

Specified by:

setPlaceholder in interface IPlaceholderable

Parameters:

placeholder - the paragraph to be used as placeholder

makeNewRenderer

protected IRenderer makeNewRenderer()

Specified by:

makeNewRenderer in class AbstractElement<TextArea>