Class InputField

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer<InputField>

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

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

com.itextpdf.forms.form.element.InputField

All Implemented Interfaces:

IFormField, IPlaceholderable, IAbstractElement, IBlockElement, IElement, IPropertyContainer, IAccessibleElement

public class InputField
extends FormField<InputField>
implements IPlaceholderable

Extension of the FormField class representing a button so that a InputFieldRenderer is used.

Field Summary

Fields

Modifier and Type	Field	Description
private Paragraph	placeholder	The placeholder paragraph.
private int	rotation	Field rotation, counterclockwise.
private static final float	X_OFFSET	Default padding X offset.

Fields inherited from class FormField

tagProperties

Fields inherited from class AbstractElement

childElements, nextRenderer, styles

Fields inherited from class ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor	Description
InputField(String id)	Creates a new input field.

Method Summary

Modifier and Type	Method	Description
AccessibilityProperties	getAccessibilityProperties()	Gets the accessibility properties.
<T1> T1	getDefaultProperty(int property)	Gets the default property from this entity.
Paragraph	getPlaceholder()	Gets the placeholder paragraph.
int	getRotation()	Get rotation.
protected IRenderer	makeNewRenderer()	Creates a new renderer instance.
InputField	setComb(boolean isComb)	Sets Comb flag for the text field.
InputField	setMaxLen(int maxLen)	Sets the maximum length of the field's text, in characters.
void	setPlaceholder(Paragraph placeholder)	Sets the placeholder paragraph.
private void	setProperties()
InputField	setRotation(int rotation)	Set rotation of the input field.
InputField	useAsPassword(boolean isPassword)	Determines, whether the input field will be password.

Methods inherited from class FormField

getId, setAlternativeDescription, setHeight, setInteractive, setSize, setValue, setWidth

Methods inherited from class AbstractElement

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

Methods inherited from class ElementPropertyContainer

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

Methods inherited from class Object

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

Methods inherited from interface IAbstractElement

getChildren

Methods inherited from interface IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface IPropertyContainer

deleteOwnProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Field Details

X_OFFSET

private static final float X_OFFSET

Default padding X offset.

See Also:

• Constant Field Values

placeholder

private Paragraph placeholder

The placeholder paragraph.

rotation

private int rotation

Field rotation, counterclockwise. Must be a multiple of 90 degrees.

Constructor Details

InputField

public InputField(String id)

Creates a new input field.

Parameters:

id - the id

Method Details

useAsPassword

public InputField 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

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

getDefaultProperty

public <T1> T1 getDefaultProperty(int property)

Description copied from class: FormField

Gets the default property from this entity.

Specified by:

getDefaultProperty in interface IPropertyContainer

Overrides:

getDefaultProperty in class FormField<InputField>

Type Parameters:

T1 - the return type associated with the property

Parameters:

property - the property to be retrieved

Returns:

the default property value. If the default property is not defined, null will be returned

getRotation

public int getRotation()

Get rotation.

Returns:

rotation value.

setRotation

public InputField setRotation(int rotation)

Set rotation of the input field.

Parameters:

rotation - new rotation value, counterclockwise. Must be a multiple of 90 degrees. It has sense only in interactive mode, see FormField.setInteractive(boolean)

Returns:

the edited InputField

setComb

public InputField setComb(boolean isComb)

Sets Comb flag for the text field. Meaningful only if the MaxLen entry is present in the text field dictionary and if the Multiline, Password and FileSelect flags are clear.

If true, the field is automatically divided into as many equally spaced positions, or combs, as the value of MaxLen, and the text is laid out into those combs.

Parameters:

isComb - boolean value specifying whether to enable combing

Returns:

this InputField instance

setMaxLen

public InputField setMaxLen(int maxLen)

Sets the maximum length of the field's text, in characters.

Parameters:

maxLen - the current maximum text length

Returns:

this InputField instance

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

Gets the accessibility properties. See also IAccessibleElement.

Specified by:

getAccessibilityProperties in interface IAccessibleElement

Returns:

an interface that allows to specify properties of a tagged element in Tagged PDF.

makeNewRenderer

protected IRenderer makeNewRenderer()

Description copied from class: AbstractElement

Creates a new renderer instance.

Specified by:

makeNewRenderer in class AbstractElement<InputField>

Returns:

new IRenderer

setProperties

private void setProperties()