com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

com.aspose.pdf

Class CheckboxField

  • All Implemented Interfaces:
    com.aspose.ms.System.Collections.ICollection, com.aspose.ms.System.Collections.IEnumerable, com.aspose.ms.System.ICloneable, Cloneable, Iterable


    public class CheckboxField
    extends Field

    Class representing checkbox field

    • Constructor Detail

      • CheckboxField

        public CheckboxField(Page page,
                     Rectangle rect)

        Constructor for CheckboxField class.

        Parameters:
        page - Page where check box will be placed.
        rect - Position and size of the check box.
      • CheckboxField

        public CheckboxField(IDocument doc,
                     Rectangle rect)

        Constructor for CheckboxField class.

        Parameters:
        doc - Document where will be new field created.
        rect - Rectangle where new field will be created.
      • CheckboxField

        public CheckboxField()

        Create instance of CheckboxField.

      • CheckboxField

        public CheckboxField(IDocument doc)

        Constructor to use with Generator.

        Parameters:
        doc - Document where field will be created.
    • Method Detail

      • getAllowedStates

        public List<String> getAllowedStates()

        Returns list of allowed states.

        Returns:
        list of 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 int getStyle()

        Gets style of check box.

        Returns:
        style of check box.
        See Also:
        BoxStyle
      • setStyle

        public void setStyle(int value)

        Sets style of check box.

        Parameters:
        value - BoxStyle of check box.
        See Also:
        BoxStyle
      • getActiveState

        public String getActiveState()

        Gets current annotation appearance state.

        Overrides:
        getActiveState in class Annotation
        Returns:
        String value
      • setActiveState

        public void setActiveState(String value)

        Sets current annotation appearance state.

        Overrides:
        setActiveState in class Annotation
        Parameters:
        value - String value
      • getChecked

        public boolean getChecked()

        Gets state of check box.

        Returns:
        boolean value
      • setChecked

        public void setChecked(boolean value)

        Sets state of check box.

        Parameters:
        value - boolean value
      • getNormalCaption

        public String getNormalCaption()

        Gets normal caption of the field.

        Returns:
        String value
      • getValue

        public String getValue()

        Gets value of check box field.

        Overrides:
        getValue in class Field
        Returns:
        String value
      • setValue

        public void setValue(String value)

        Sets value of check box field.

        Overrides:
        setValue in class Field
        Parameters:
        value - String value