DocumentTableColumnCollection

Inheritance: java.lang.Object

All Implemented Interfaces: java.lang.Iterable

public class DocumentTableColumnCollection implements Iterable

Represents a read-only collection of DocumentTableColumn objects of a particular DocumentTable instance. The collection is filled automatically while loading the corresponding table from a document and can not be modified. However, properties of DocumentTableColumn objects contained within the collection can be modified.

Methods

Method	Description
iterator()	Returns an enumerator to iterate DocumentTableColumn objects of this collection.
contains(String name)	Returns a value indicating whether this collection contains a column with the specified name.
contains(DocumentTableColumn column)	Returns a value indicating whether this collection contains the specified column.
indexOf(String name)	Returns the index of a column with the specified name within this collection.
indexOf(DocumentTableColumn column)	Returns the index of the specified column within this collection.
get(int index)	Gets a DocumentTableColumn instance from the collection at the specified index.
get(String name)	Gets a DocumentTableColumn instance with the specified name from the collection.
getCount()	Gets the total number of DocumentTableColumn objects in the collection.

iterator()

public Iterator iterator()

Returns an enumerator to iterate DocumentTableColumn objects of this collection.

Returns: java.util.Iterator - An enumerator to iterate DocumentTableColumn objects of this collection.

contains(String name)

public boolean contains(String name)

Returns a value indicating whether this collection contains a column with the specified name.

Parameters:

Parameter	Type	Description
name	java.lang.String	The case-insensitive name of a column to look for.

Returns: boolean - A value indicating whether this collection contains a column with the specified name.

contains(DocumentTableColumn column)

public boolean contains(DocumentTableColumn column)

Returns a value indicating whether this collection contains the specified column.

Parameters:

Parameter	Type	Description
column	DocumentTableColumn	A column to look for.

Returns: boolean - A value indicating whether this collection contains the specified column.

indexOf(String name)

public int indexOf(String name)

Returns the index of a column with the specified name within this collection.

Parameters:

Parameter	Type	Description
name	java.lang.String	The case-insensitive name of a column to find.

Returns: int - The zero-based index of a column with the specified name, or -1 if the column does not exist in this collection.

indexOf(DocumentTableColumn column)

public int indexOf(DocumentTableColumn column)

Returns the index of the specified column within this collection.

Parameters:

Parameter	Type	Description
column	DocumentTableColumn	A column to find.

Returns: int - The zero-based index of the specified column, or -1 if the column does not exist in this collection.

get(int index)

public DocumentTableColumn get(int index)

Gets a DocumentTableColumn instance from the collection at the specified index.

Parameters:

Parameter	Type	Description
index	int	The zero-based index of the column to return.

Returns: DocumentTableColumn - A DocumentTableColumn instance from the collection at the specified index.

get(String name)

public DocumentTableColumn get(String name)

Gets a DocumentTableColumn instance with the specified name from the collection.

Parameters:

Parameter	Type	Description
name	java.lang.String	The case-insensitive name of the column to return.

Returns: DocumentTableColumn - A DocumentTableColumn instance with the specified name from the collection or null if such an instance does not exist.

getCount()

public int getCount()

Gets the total number of DocumentTableColumn objects in the collection.

Returns: int - The total number of DocumentTableColumn objects in the collection.