com.aspose.gridweb

Class GridCommentCollection

java.lang.Object

com.aspose.gridweb.GridCommentCollection

public class GridCommentCollection
extends java.lang.Object

Encapsulates a collection of GridComment objects.

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int row, int column) Adds a comment to the collection.
int	add(java.lang.String cellName) Adds a comment to the collection.
void	clear() Removes all comments;
GridComment	get(int index) Gets the GridComment element at the specified index.
GridComment	get(int row, int column) Gets the GridComment element at the specified row index and column index.
GridComment	get(java.lang.String cellName) Gets the GridComment element at the specified cell.
int	getCount() Gets the size of enumerator
java.util.Iterator	iterator() Gets the rows enumerator
void	removeAt(int row, int column) Removes the comment of the specific cell.
void	removeAt(java.lang.String cellName) Removes the comment of the specific cell.

Methods inherited from class java.lang.Object

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

Method Detail

get

public GridComment get(int index)

Gets the GridComment element at the specified index.

Parameters:

index - The zero based index of the element.

Returns:

The element at the specified index.

get

public GridComment get(java.lang.String cellName)

Gets the GridComment element at the specified cell.

Parameters:

cellName - Cell name.

Returns:

The element at the specified cell.

get

public GridComment get(int row,
              int column)

Gets the GridComment element at the specified row index and column index.

Parameters:

row - Row index.

column - Column index.

Returns:

The element at the specified cell.

getCount

public int getCount()

Gets the size of enumerator

iterator

public java.util.Iterator iterator()

Gets the rows enumerator

Returns:

The rows enumerator

add

public int add(int row,
      int column)

Adds a comment to the collection.

Parameters:

row - Cell row index.

column - Cell column index.

Returns:

GridComment object index.

add

public int add(java.lang.String cellName)

Adds a comment to the collection.

Parameters:

cellName - Cell name.

Returns:

GridComment object index.

removeAt

public void removeAt(java.lang.String cellName)

Removes the comment of the specific cell.

Parameters:

cellName - The name of cell which contains a comment.

removeAt

public void removeAt(int row,
            int column)

Removes the comment of the specific cell.

Parameters:

row - The row index.

column - the column index.

clear

public void clear()

Removes all comments;