com.f1j.ss.filter
Interface AutoFilter

public interface AutoFilter

extends Lockable

This interface describes the AutoFilter API.

Since:

11.0

See Also:

Range, Filter

Method Summary

Filter	getFilter(int index) Returns the filter object at the specified index.
int	getNumFilters() Returns the number of filter objects in the AutoFilter.
RangeRef	getRange() Returns the bounding range of the AutoFilter.
void	stop() Removes from the sheet.

Methods inherited from interface com.f1j.util.Lockable

getLock, releaseLock

Method Detail

getFilter

public Filter getFilter(int index)
                 throws com.f1j.util.InvalidIndexException,
                        F1Exception

Returns the filter object at the specified index.

Parameters:

index - The index of the desired filter object.

Returns:

The filter object at the specified index

Throws:

com.f1j.util.InvalidIndexException - if the index is out of bounds.

F1Exception - if an error occurs.

Since:

11.0

See Also:

Filter

getNumFilters

public int getNumFilters()

Returns the number of filter objects in the AutoFilter.

Returns:

The number of filter objects in the AutoFilter.

Since:

11.0

See Also:

Filter

getRange

public RangeRef getRange()

Returns the bounding range of the AutoFilter.

Returns:

The bounding range of the AutoFilter.

Since:

11.0

stop

public void stop()
          throws F1Exception

Removes from the sheet.

Throws:

F1Exception - if an error occurs while trying to stop.

Since:

11.0