TextFragmentCollection

Inheritance: java.lang.Object

All Implemented Interfaces: java.lang.Iterable

public final class TextFragmentCollection implements Iterable<TextFragment>

Represents a text fragments collection

Methods

MethodDescription
size()Gets the number of TextFragment object elements actually contained in the collection.
getSyncRoot()Gets an object that can be used to synchronize access to the collection.
isSynchronized()Gets a value indicating whether access to the collection is synchronized (thread safe).
isReadOnly()Gets a value indicating whether collection is read-only
add(TextFragment fragment)Adds the text fragment element at the specified index.
iterator()Returns an enumerator for the entire collection.
copyTo(TextFragment[] array, int index)Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array
clear()Clears all items from the collection.
contains(TextFragment item)Determines whether the collection contains a specific value.
remove(TextFragment item)Deletes specified item from collection.
get_Item(int index)Gets the text fragment element at the specified index.

size()

public int size()

Gets the number of TextFragment object elements actually contained in the collection.

Returns: int - int value

getSyncRoot()

public Object getSyncRoot()

Gets an object that can be used to synchronize access to the collection.

Returns: java.lang.Object - Object element

isSynchronized()

public boolean isSynchronized()

Gets a value indicating whether access to the collection is synchronized (thread safe).

Returns: boolean - boolean value

isReadOnly()

public boolean isReadOnly()

Gets a value indicating whether collection is read-only

Returns: boolean - boolean value

add(TextFragment fragment)

public void add(TextFragment fragment)

Adds the text fragment element at the specified index.

Parameters:

ParameterTypeDescription
fragmentTextFragmentTextFragment object element to add.

iterator()

public Iterator<TextFragment> iterator()

Returns an enumerator for the entire collection.

Returns: java.util.Iterator<com.aspose.pdf.TextFragment> - Enumerator object.

copyTo(TextFragment[] array, int index)

public void copyTo(TextFragment[] array, int index)

Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array

Parameters:

ParameterTypeDescription
arrayTextFragment[]Array of objects which will be copied.
indexintStarting index from which copying will be started.

clear()

public void clear()

Clears all items from the collection.

contains(TextFragment item)

public boolean contains(TextFragment item)

Determines whether the collection contains a specific value.

Parameters:

ParameterTypeDescription
itemTextFragmentThe object to locate in the collection

Returns: boolean - true if item is found in the collection; otherwise, false.

remove(TextFragment item)

public boolean remove(TextFragment item)

Deletes specified item from collection.

Parameters:

ParameterTypeDescription
itemTextFragmentThe object to delete

Returns: boolean - true if item was deleted from collection; otherwise, false.

get_Item(int index)

public TextFragment get_Item(int index)

Gets the text fragment element at the specified index.

Index should be in the range [1..n] where n equals to the text fragments count.

Parameters:

ParameterTypeDescription
indexintIndex within the collection.

Returns: TextFragment - TextFragment object.