PDF4Java Reference Documentation
com.o2sol.pdf4java.forms Package / PDFCheckWidget Class
Fields Methods Collapse All Expand All Members Options: Show All Members Options: Filtered
Include Inherited Members
Include Protected Members
In This Topic

PDFCheckWidget Class Members
In This Topic

The following tables list the members exposed by PDFCheckWidget.

Public Constructors

| Name | Description
--- | --- | ---
| PDFCheckWidget Constructor | Overloaded.

Top
Protected Fields

| Name | Description
--- | --- | ---
| annotationType | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| appearance | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| appearanceFont | (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| border | (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| cosAnnotation | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| doubleBuffer | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| exportValue |
| field | (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| font | (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| isInitialization | True if the annotation is in process of initialization. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isStandardAppearance | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| page | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| visualRectangle | (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)

Top
Public Methods

| Name | Description
--- | --- | ---
| beginInit | Signals the start of the initialization of annotation's properties. The annotation appearance is not updated while properties are initialized. When initialization is completed, call to signal the end of initialization and update the annotation appearance. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| canRotate | Gets a value indicating whether the annotation should be rotated when the page is rotated. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| createAnnotationAppearance | This method supports the internal library infrastructure and should not be used by external client code.
| createAppearance | Creates the visual appearance for the annotation. This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| createFromCosAnnotation | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| createFromXFDF | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| endInit | Signals the end of the initialization of annotation's properties. The annotation appearance is updated when the initialization ends. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| exportAsXFDF | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| flatten | Merges the annotation appearance with the page content stream and sets the result as content item for the given structure element. The widget normal appearance is merged with the page content stream and the widget is destroyed. After calling this method the widget object is in an invalid state and cannot be used any longer. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| getAppearanceFont | Gets the widget appearance font. If this property is null, the property is used for displaying the field content. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| getAppearanceState | This method supports the internal library infrastructure and should not be used by external client code.
| getBackgroundColor | Gets the widget background color. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| getBlur | Gets the blur action. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| getBorder | Gets the widget border. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| getCheckedAppearanceName | This method supports the internal library infrastructure and should not be used by external client code.
| getCheckedStateDownAppearance | Gets the pressed visual appearance for the widget in checked state. The visual appearance of the widget in checked state when the user presses the widget.
| getCheckedStateNormalAppearance | Gets the normal visual appearance for the widget in checked state. The visual appearance of the widget in checked state when the user does not interact with the widget.
| getCheckedStateRolloverAppearance | Gets the rollover visual appearance for the widget in checked state. The visual appearance of the widget in checked state when the user hovers the mouse over the widget.
| getCheckStyle | Gets the style of the checked widget.
| getContents | Gets the annotation contents. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getCosAnnotation | Gets the COS annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getCreationDate | Gets the annotation creation date. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getDisplayRectangle | Gets the display rectangle of this annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getExportValue | Gets the widget's export value. When the form data is exported as FDF/XFDF/HTML or XML and the check widget is checked then this value is written to exported data stream.
| getField | Gets the parent field. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| getFocus | Gets the focus action. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| getFont | Gets the widget font. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| getID | Gets the annotation ID. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getModifiedDate | Gets the annotation modified date. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getMouseDownAction | Gets the mouse down action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getMouseEnterAction | Gets the mouse enter action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getMouseLeaveAction | Gets the mouse leave action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getMouseUpAction | Gets the mouse up action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getNormalAppearance | Gets the annotation normal appearance. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getPage | Gets the page that contains this annotation.. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getPageCloseAction | Gets the page close action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getPageInvisibleAction | Gets the page invisible action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getPageOpenAction | Gets the page open action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getPageVisibleAction | Gets the page visible action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getPDFRectangle | Gets the annotation rectangle in standard PDF coordinates. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getPopup | Gets the associated popup annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getRotation | Gets the widget rotation angle. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| getTabOrder | Gets the widget's tab order. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| getTextColor | Gets the widget text color. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| getToggleNoView | Gets a value indicating whether the interpretation of isViewable method should be reversed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getType | Gets the type of the annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| getUncheckedStateDownAppearance | Gets the pressed visual appearance for the widget in unchecked state. The visual appearance of the widget in unchecked state when the user presses the widget.
| getUncheckedStateNormalAppearance | Gets the normal visual appearance for the widget in unchecked state. The visual appearance of the widget in unchecked state when the user does not interact with the widget.
| getUncheckedStateRolloverAppearance | Gets the rollover visual appearance for the widget in unchecked state. The visual appearance of the widget in unchecked state when the user hovers the mouse over the widget.
| getUpdatedDefaultAppearance | This method supports the internal library infrastructure and should not be used by external client code.
| getVisibility | Gets the field widget visibility. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| importFromXFDF | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| initActions | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| initAppearance | This method supports the internal library infrastructure and should not be used by external client code.
| initFont | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| isChecked | Gets a value indicating whether the check widget is in the checked state.
| isHidden | Gets a value indicating whether to display the annotation or not. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isInvisible | Gets a value indicating whether the annotation should be displayed if it does not belong to one of the standard annotation types. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isLocked | Gets a value indicating whether the annotation should be modified. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isLockedContents | Gets a value indicating whether the annotation contents should be modified. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isPrintable | Gets a value indicating whether the annotation should be printed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isReadOnly | Gets a value indicating whether the annotation is read only. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isViewable | Gets a value indicating whether the annotation should be displayed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| isZoomable | Gets a value indicating whether the annotation should be scaled to current page zoom. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setAppearanceFont | Sets the widget appearance font. If this property is null, the property is used for displaying the field content. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| setAppearanceState | This method supports the internal library infrastructure and should not be used by external client code.
| setBackgroundColor | Sets the widget background color. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| setBlur | Sets the blur action. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| setBorder | Sets the widget border. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| setCanRotate | Sets a value indicating whether the annotation should be rotated when the page is rotated. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setCheckedStateDownAppearance | Sets the pressed visual appearance for the widget in checked state. The visual appearance of the widget in checked state when the user presses the widget.
| setCheckedStateNormalAppearance | Sets the normal visual appearance for the widget in checked state. The visual appearance of the widget in checked state when the user does not interact with the widget.
| setCheckedStateRolloverAppearance | Sets the rollover visual appearance for the widget in checked state. The visual appearance of the widget in checked state when the user hovers the mouse over the widget.
| setCheckStyle | Sets the style of the checked widget.
| setContents | Sets the annotation contents. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setCreationDate | Sets the annotation creation date. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setDisplayRectangle | Sets the display rectangle of this annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setExportValue | Sets the widget's export value. When the form data is exported as FDF/XFDF/HTML or XML and the check widget is checked then this value is written to exported data stream.
| setFocus | Sets the focus action. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| setFont | Sets the widget font. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| setHidden | Sets a value indicating whether to display the annotation or not. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setID | Sets the annotation ID. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setInvisible | Sets a value indicating whether the annotation should be displayed if it does not belong to one of the standard annotation types. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setIsChecked | Gets or set a value indicating whether the check widget is in the checked state.
| setLocked | Sets a value indicating whether the annotation should be modified. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setLockedContents | Sets a value indicating whether the annotation contents should be modified. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setModifiedDate | Sets the annotation modified date. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setMouseDownAction | Sets the mouse down action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setMouseEnterAction | Sets the mouse enter action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setMouseLeaveAction | Sets the mouse leave action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setMouseUpAction | Sets the mouse up action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setNormalAppearance | Sets the annotation normal appearance. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setPageCloseAction | Sets the page close action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setPageInvisibleAction | Sets the page invisible action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setPageOpenAction | Sets the page open action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setPageVisibleAction | Sets the page visible action. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setPDFRectangle | Sets the annotation rectangle in standard PDF coordinates. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setPopup | Sets the associated popup annotation. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setPrintable | Sets a value indicating whether the annotation should be printed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setReadOnly | Sets a value indicating whether the annotation is read only. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setRotation | Sets the widget rotation angle. The accepted values for this property are 0, 90, 180 and 270 degrees. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| setTabOrder | Sets the widget's tab order. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| setTextColor | Sets the widget text color. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| setToggleNoView | Sets a value indicating whether the interpretation of isViewable method should be reversed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setUncheckedStateDownAppearance | Sets the pressed visual appearance for the widget in unchecked state. The visual appearance of the widget in unchecked state when the user presses the widget.
| setUncheckedStateNormalAppearance | Sets the normal visual appearance for the widget in unchecked state. The visual appearance of the widget in unchecked state when the user does not interact with the widget.
| setUncheckedStateRolloverAppearance | Sets the rollover visual appearance for the widget in unchecked state. The visual appearance of the widget in unchecked state when the user hovers the mouse over the widget.
| setViewable | Sets a value indicating whether the annotation should be displayed. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setVisibility | Sets the field widget visibility. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| setZoomable | Sets a value indicating whether the annotation should be scaled to current page zoom. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod1 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod2 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| zInternalMethod3 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.forms.PDFFieldWidget)
| zInternalMethod4 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod5 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod6 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod7 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| zInternalMethod8 | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)

Top
Protected Methods

| Name | Description
--- | --- | ---
| initAdditionalAction | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| setAction | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| writeXFDFAttributes | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| writeXFDFChildNodes | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| writeXFDFEndElement | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)
| writeXFDFStartElement | This method supports the internal library infrastructure and should not be used by external client code. (Inherited from com.o2sol.pdf4java.annotations.PDFAnnotation)

Top
See Also

#### Reference

PDFCheckWidget Class
com.o2sol.pdf4java.forms Package

© 2025 O2 Solutions All Rights Reserved.

Send comments on this topic.