com.itextpdf.forms.form.element

Class CheckBox

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<CheckBox>

com.itextpdf.forms.form.element.CheckBox

All Implemented Interfaces:

IFormField, IAbstractElement, IBlockElement, IElement, IPropertyContainer, IAccessibleElement

public class CheckBox
extends FormField<CheckBox>

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

Field Summary

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

tagProperties

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
CheckBox(String id) Creates a new CheckBox instance.

Method Summary

Modifier and Type	Method and Description
AccessibilityProperties	getAccessibilityProperties()
protected IRenderer	makeNewRenderer()
CheckBox	setCheckBoxType(CheckBoxType checkBoxType) Sets the icon of the checkbox.
CheckBox	setChecked(boolean checked) Sets the checked state of the checkbox.
CheckBox	setPdfAConformanceLevel(PdfAConformanceLevel conformanceLevel) Deprecated.
CheckBox	setPdfConformanceLevel(IConformanceLevel conformanceLevel) Sets the conformance level for the checkbox.
CheckBox	setSize(float size) Sets the size of the checkbox.

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

getDefaultProperty, getId, setHeight, setInteractive, 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

CheckBox

public CheckBox(String id)

Creates a new CheckBox instance.

Parameters:

id - the id

Method Detail

setChecked

public CheckBox setChecked(boolean checked)

Sets the checked state of the checkbox.

Parameters:

checked - the checked state to set

Returns:

this checkbox instance

setPdfAConformanceLevel

@Deprecated
public CheckBox setPdfAConformanceLevel(PdfAConformanceLevel conformanceLevel)

Deprecated.

Sets the PDF/A conformance level for the checkbox. This method is deprecated use setPdfConformanceLevel.

Parameters:

conformanceLevel - The PDF/A conformance level to set.

Returns:

This checkbox instance.

setPdfConformanceLevel

public CheckBox setPdfConformanceLevel(IConformanceLevel conformanceLevel)

Sets the conformance level for the checkbox.

Parameters:

conformanceLevel - The PDF/A conformance level to set.

Returns:

tThis checkbox instance.

setCheckBoxType

public CheckBox setCheckBoxType(CheckBoxType checkBoxType)

Sets the icon of the checkbox.

Parameters:

checkBoxType - the type of the checkbox to set

Returns:

this checkbox instance

setSize

public CheckBox setSize(float size)

Sets the size of the checkbox.

Overrides:

setSize in class FormField<CheckBox>

Parameters:

size - the size of the checkbox to set, in points

Returns:

this checkbox instance

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

makeNewRenderer

protected IRenderer makeNewRenderer()

Specified by:

makeNewRenderer in class AbstractElement<CheckBox>