com.f1j.ss.pivot
Interface Area

public interface Area

extends Lockable

This interface defines the PivotRange area API.

Since:

11.0

Method Summary

void	addField(Field field) Adds the field to this area and positions the field after any existing fields.
Field	getField(int index) Returns the PivotRange field at the specified index within this area.
int	getFieldCount() Returns the number of fields in this area.

Methods inherited from interface com.f1j.util.Lockable

getLock, releaseLock

Method Detail

addField

public void addField(Field field)
              throws IllegalPivotException,
                     AccessDeniedException,
                     DataConflictException,
                     InvalidPivotRangeException,
                     F1Exception

Adds the field to this area and positions the field after any existing fields.

Parameters:

field - The field that should be added to the area.

Throws:

IllegalPivotException - if the field cannot be added to this area.

AccessDeniedException - if the sheet is protected.

DataConflictException - if the PivotRange grows too large.

InvalidPivotRangeException - if PivotRange is invalid.

F1Exception - if an error occurs.

Since:

11.0

See Also:

Field, PivotRange

getField

public Field getField(int index)
               throws com.f1j.util.InvalidIndexException,
                      F1Exception

Returns the PivotRange field at the specified index within this area.

Returns:

The index of the desired field.

Throws:

com.f1j.util.InvalidIndexException - if the specified index is invalid.

F1Exception - if an error occurs.

Since:

11.0

See Also:

Field

getFieldCount

public int getFieldCount()

Returns the number of fields in this area.

Returns:

The number of fields in this area.

Since:

11.0