com.mindoo.remote.api.symphony.spreadsheet
Interface IRemoteDataPilotField

public interface IRemoteDataPilotField

This class represents a field which can be a row, column, data, page or hidden field in a DataPilot table.

Usage

After a DataPilot table is created, all the columns in the source range are added to hidden fields. There are two ways to add row fields, column fields, page fields, and data fields :

• Use addFields method in the DataPilotTable class.
• Change the Orientation property.

Method Summary

IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getFunction() This property returns or sets the function used to summarize only the data fields of the DataPilot field, it can be a general function constant.
java.lang.String	getName() This property returns a string value that represent the name of the field.
int	getOrientation() This property returns or sets the type of the field in the specified DataPilot table report.
void	setFunction(int function) This property returns or sets the function used to summarize only the data fields of the DataPilot field, it can be a general function constant.
void	setOrientation(int orientation) This property returns or sets the type of the field in the specified DataPilot table report.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

getFunction

int getFunction()
                throws RemoteEclipseAPIException

This property returns or sets the function used to summarize only the data fields of the DataPilot field, it can be a general function constant.

Returns:

function

Throws:

RemoteEclipseAPIException

setFunction

void setFunction(int function)
                 throws RemoteEclipseAPIException

This property returns or sets the function used to summarize only the data fields of the DataPilot field, it can be a general function constant.

Parameters:

function -

Throws:

RemoteEclipseAPIException

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

This property returns a string value that represent the name of the field.

Returns:

name

Throws:

RemoteEclipseAPIException

getOrientation

int getOrientation()
                   throws RemoteEclipseAPIException

This property returns or sets the type of the field in the specified DataPilot table report. The value can be a DataPilotTable orientation constant.

All DataPilot fields (row, column, data, hidden and page ) can change to other fields by changing the Orientation property.

Returns:

orientation

Throws:

RemoteEclipseAPIException

setOrientation

void setOrientation(int orientation)
                    throws RemoteEclipseAPIException

This property returns or sets the type of the field in the specified DataPilot table report. The value can be a DataPilotTable orientation constant.

All DataPilot fields (row, column, data, hidden and page ) can change to other fields by changing the Orientation property.

Parameters:

orientation -

Throws:

RemoteEclipseAPIException