CheckboxField
Inheritance: java.lang.Object, com.aspose.pdf.BaseParagraph com.aspose.pdf.Annotation com.aspose.pdf.WidgetAnnotation com.aspose.pdf.Field com.aspose.pdf.CheckboxField, com.aspose.pdf.BaseParagraph, com.aspose.pdf.Annotation com.aspose.pdf.WidgetAnnotation com.aspose.pdf.Field com.aspose.pdf.CheckboxField, com.aspose.pdf.Annotation, com.aspose.pdf.WidgetAnnotation com.aspose.pdf.Field com.aspose.pdf.CheckboxField, com.aspose.pdf.WidgetAnnotation, com.aspose.pdf.Field com.aspose.pdf.CheckboxField, com.aspose.pdf.Field, com.aspose.pdf.CheckboxField
All Implemented Interfaces: com.aspose.ms.System.Collections.Generic.IGenericEnumerable< WidgetAnnotation >, com.aspose.ms.System.Collections.IEnumerable< WidgetAnnotation >, com.aspose.ms.System.ICloneable, Cloneable, Iterable < WidgetAnnotation >
public class CheckboxField extends Field
Class representing checkbox field
Constructors
| Constructor | Description |
|---|---|
| CheckboxField | Create instance of CheckboxField. @deprecated For full field functionality, a binding to the document is required - use CheckboxField(Document doc) |
| CheckboxField | Create instance of CheckboxField. @deprecated For full field functionality, a binding to the document is required - use CheckboxField(Document doc) |
| CheckboxField | Create instance of CheckboxField. @deprecated For full field functionality, a binding to the document is required - use CheckboxField(Document doc) |
| CheckboxField | Create instance of CheckboxField. @deprecated For full field functionality, a binding to the document is required - use CheckboxField(Document doc) |
Methods
| Method | Description |
|---|---|
| addOption | Adds new checkbox into a checkbox group, in which at most one of the checkboxes may be checked at any time. The new checkbox is added to the bottom of the group. |
| addOption | Adds new checkbox into a checkbox group, in which at most one of the checkboxes may be checked at any time. |
| addOption | Adds new checkbox into a checkbox group, in which at most one of the checkboxes may be checked at any time. |
| deepClone | Clone the checkbox. |
| getActiveState | Gets current annotation appearance state. |
| getAllowedStates | Returns list of allowed states. |
| getChecked | Gets state of check box. |
| getExportValue | Gets or sets export value of CheckBox field. |
| getNormalCaption | Gets normal caption of the field. |
| getOnState | Returns name of state which is “Checked” state of checkbox. This is “Yes” if presents or any other value other then “Off” and “No”; |
| getStyle | Gets style of check box. |
| getValue | Gets value of check box field. |
| setActiveState | Sets current annotation appearance state. |
| setChecked | Sets state of check box. |
| setExportValue | Gets or sets export value of CheckBox field. |
| setStyle | Sets style of check box. |
| setValue | Sets value of check box field. |
CheckboxField
@Deprecated public CheckboxField()
Create instance of CheckboxField. @deprecated For full field functionality, a binding to the document is required - use CheckboxField(Document doc)
CheckboxField
Create instance of CheckboxField. @deprecated For full field functionality, a binding to the document is required - use CheckboxField(Document doc)
CheckboxField
Create instance of CheckboxField. @deprecated For full field functionality, a binding to the document is required - use CheckboxField(Document doc)
CheckboxField
Create instance of CheckboxField. @deprecated For full field functionality, a binding to the document is required - use CheckboxField(Document doc)
addOption
Adds new checkbox into a checkbox group, in which at most one of the checkboxes may be checked at any time. The new checkbox is added to the bottom of the group.
addOption
Adds new checkbox into a checkbox group, in which at most one of the checkboxes may be checked at any time.
addOption
Adds new checkbox into a checkbox group, in which at most one of the checkboxes may be checked at any time.
deepClone
public Object deepClone()
Clone the checkbox.
Returns: The cloned object
getActiveState
public String getActiveState()
Gets current annotation appearance state.
Returns: String value
getAllowedStates
public List < String > getAllowedStates()
Returns list of allowed states.
Returns: list of String value
getChecked
public boolean getChecked()
Gets state of check box.
Returns: boolean value
getExportValue
public final String getExportValue()
Gets or sets export value of CheckBox field.
Returns: String value
getNormalCaption
public String getNormalCaption()
Gets normal caption of the field.
Returns: String value
getOnState
public String getOnState()
Returns name of state which is “Checked” state of checkbox. This is “Yes” if presents or any other value other then “Off” and “No”;
Returns: String value
getStyle
public BoxStyle getStyle()
Gets style of check box.
Returns: style of check box. @see BoxStyle
getValue
public String getValue()
Gets value of check box field.
Returns: String value
setActiveState
Sets current annotation appearance state.
setChecked
public void setChecked(boolean value)
Sets state of check box.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean value |
setExportValue
Gets or sets export value of CheckBox field.
setStyle
Sets style of check box.
setValue
Sets value of check box field.