eu.id3.document

## Class TextField

- java.lang.Object
- - eu.id3.document.TextField

- All Implemented Interfaces:
    java.io.Serializable, java.lang.AutoCloseable

      public class TextField
      extends java.lang.Object
      implements java.lang.AutoCloseable, java.io.Serializable

  Represents a text field extracted from a document.
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `TextField()` Creates a new instance of the TextField class.
    `TextField(long handle)` Creates a new instance of the TextField class.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `TextField` | `clone()` Creates a copy of the TextField object.
    `void` | `close()` Releases all resources used by this TextField.
    `protected void` | `finalize()` Finalizer for this class.
    `Rectangle` | `getBounds()` Gets the boundaries of the text field in the image.
    `float` | `getConfidence()` Gets the confidence score for the value read from the text field.
    `long` | `getHandle()` Gets the native handle.
    `java.lang.String` | `getName()` Gets the name of the text field.
    `java.lang.String` | `getValue()` Gets the value of the text field.

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### TextField

          public TextField()
                    throws DocumentException

      Creates a new instance of the TextField class.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

    - #### TextField

          public TextField(long handle)
                    throws DocumentException

      Creates a new instance of the TextField class.
      Parameters:
        `handle` - Handle to the TextField.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

  - ### Method Detail

    - #### close

          public void close()

      Releases all resources used by this TextField.
      Specified by:
        `close` in interface `java.lang.AutoCloseable`

    - #### finalize

          protected void finalize()

      Finalizer for this class. Finalizers are deprecated since Java 9+. This method is not guaranteed to be called. To release all memory held by this class please be sure to call the close() method.
      Overrides:
        `finalize` in class `java.lang.Object`

    - #### getHandle

          public long getHandle()

      Gets the native handle.
      Returns:
        The native handle.

    - #### clone

          public TextField clone()
                          throws DocumentException

      Creates a copy of the TextField object.
      Overrides:
        `clone` in class `java.lang.Object`
      Returns:
        The newly created TextField object.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

    - #### getBounds

          public Rectangle getBounds()
                              throws DocumentException

      Gets the boundaries of the text field in the image.
      Returns:
        Boundaries of the text field in the image.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

    - #### getConfidence

          public float getConfidence()
                              throws DocumentException

      Gets the confidence score for the value read from the text field.
      Returns:
        Confidence score for the value read from the text field.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

    - #### getName

          public java.lang.String getName()
                                   throws DocumentException

      Gets the name of the text field.
      Returns:
        Name of the text field.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

    - #### getValue

          public java.lang.String getValue()
                                    throws DocumentException

      Gets the value of the text field.
      Returns:
        Value of the text field.
      Throws:
        `DocumentException` - An error has occurred during Document Library execution.

Copyright © 2020-2030, id3 Technologies. All rights reserved. eu.id3.document