com.groupdocs.parser.legacy

Interfaces

Classes

Exceptions

com.groupdocs.parser.legacy

Class DocumentDataField


  • public final class DocumentDataField
extends Object

    Provides a data field.

    • Constructor Detail

      • DocumentDataField

        public DocumentDataField(String fieldName,
                 int pageIndex,
                 String value,
                 Rectangle rectangle)

        Initializes a new instance of the DocumentDataField class.

        Parameters:
        fieldName - A name of the field.
        pageIndex - A zero-based page index.
        value - A data field value.
        rectangle - A rectangle area of data field.

      • DocumentDataField

        public DocumentDataField(String fieldName,
                 int pageIndex,
                 String value,
                 Rectangle rectangle,
                 DocumentDataField relatedDataField)

        Initializes a new instance of the DocumentDataField class.

        Parameters:
        fieldName - A name of the field.
        pageIndex - A zero-based page index.
        value - A data field value.
        rectangle - A rectangle area of data field.
        relatedDataField - Data field relative to which the value is found.

      • DocumentDataField

        public DocumentDataField(String fieldName,
                 int pageIndex)

        Initializes a new instance of the DocumentDataField class.

        Parameters:
        fieldName - A name of the field.
        pageIndex - A zero-based page index.

    • Method Detail

      • getFieldName

        public String getFieldName()

        Gets a name of the data field.

        Returns:
        An uppercase string that represents the name of the data field.

      • getPageIndex

        public int getPageIndex()

        Gets a zero-based page index.

        Returns:
        A zero-based index of the page where value is found.

      • getValue

        public String getValue()

        Gets a value of data field.

        Returns:
        A string value that represents a value of the data field; null if value isn't found.

      • getRectangle

        public Rectangle getRectangle()

        Gets a rectangle of data field.

        Returns:
        A rectangle that bounds the data field; null if value isn't found.

      • getRelatedDataField

        public DocumentDataField getRelatedDataField()

        Gets a related data field.

        Returns:
        A data field relative to which the value is found; null for non-related data fields.

      • isEmpty

        public boolean isEmpty()

        Gets a value indicating whether a value is found.

        Returns:
        A boolean true if value is found; false otherwise.