eu.id3.document

Class TextFieldList

java.lang.Object

eu.id3.document.TextFieldList

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable, java.lang.Iterable<TextField>

public class TextFieldList
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable, java.lang.Iterable<TextField>

Represents a list of text fields extracted from a document.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TextFieldList() Creates a new instance of the TextFieldList class.
TextFieldList(long handle) Creates a new instance of the TextFieldList class.

Method Summary

Modifier and Type	Method and Description
void	add(TextField textFieldItem) Adds an item to the TextFieldList object.
void	clear() Clears the TextFieldList object.
TextFieldList	clone() Creates a copy of the TextFieldList object.
void	close() Releases all resources used by this TextFieldList.
protected void	finalize() Finalizer for this class.
TextField	get(int index) Gets an item of the TextFieldList object.
int	getCount() Gets the number of elements in the TextFieldList object.
long	getHandle() Gets the native handle.
java.util.Iterator<TextField>	iterator()
void	removeAt(int index) Removes an element of the TextFieldList object.
void	resize(int newSize) TextFieldList object.
void	set(int index, TextField textFieldItem) Sets an item of the TextFieldList object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TextFieldList

public TextFieldList()
              throws DocumentException

Creates a new instance of the TextFieldList class.

Throws:

DocumentException - An error has occurred during Document Library execution.

TextFieldList

public TextFieldList(long handle)
              throws DocumentException

Creates a new instance of the TextFieldList class.

Parameters:

handle - Handle to the TextFieldList.

Throws:

DocumentException - An error has occurred during Document Library execution.

Method Detail

close

public void close()

Releases all resources used by this TextFieldList.

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 TextFieldList clone()
                    throws DocumentException

Creates a copy of the TextFieldList object.

Overrides:

clone in class java.lang.Object

Returns:

The newly created TextFieldList object.

Throws:

DocumentException - An error has occurred during Document Library execution.

clear

public void clear()
           throws DocumentException

Clears the TextFieldList object.

Throws:

DocumentException - An error has occurred during Document Library execution.

add

public void add(TextField textFieldItem)
         throws DocumentException

Adds an item to the TextFieldList object.

Parameters:

textFieldItem - TextField item to add.

Throws:

DocumentException - An error has occurred during Document Library execution.

get

public TextField get(int index)
              throws DocumentException

Gets an item of the TextFieldList object.

Parameters:

index - Index of the TextField item to get.

Returns:

TextField item to get.

Throws:

DocumentException - An error has occurred during Document Library execution.

set

public void set(int index,
                TextField textFieldItem)
         throws DocumentException

Sets an item of the TextFieldList object.

Parameters:

index - Index of the TextField item to set.

textFieldItem - TextField item to set.

Throws:

DocumentException - An error has occurred during Document Library execution.

getCount

public int getCount()
             throws DocumentException

Gets the number of elements in the TextFieldList object.

Returns:

Number of elements in the TextField object.

Throws:

DocumentException - An error has occurred during Document Library execution.

removeAt

public void removeAt(int index)
              throws DocumentException

Removes an element of the TextFieldList object.

Parameters:

index - Index of the TextField item to remove.

Throws:

DocumentException - An error has occurred during Document Library execution.

resize

public void resize(int newSize)
            throws DocumentException

TextFieldList object.

Parameters:

newSize - TextField object.

Throws:

DocumentException - An error has occurred during Document Library execution.

iterator

public java.util.Iterator<TextField> iterator()

Specified by:

iterator in interface java.lang.Iterable<TextField>