IRemoteSheet

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

public interface IRemoteSheet

This class represents a sheet.

Creation and access

To get a sheet of a spreadsheet, use the Item method in the Sheets class.
To create a new sheet, use the AddTo method in the Sheets class.
To copy a sheet, use the CopyTo method in the Sheets class.
Use Previous property and Next property to access the previous and next sheet.

Usage

Sheet provides access to ranges, columns, rows, cells, chart objects and DataPilot tables, and provide ways to import data from text csv file and spreadsheet.

To calculate all the formulas in the sheet, use the Calculate method, to protect the sheet from modification, use the Protect method.

Method Summary
`void`	`activate()` This method makes the current sheet into the active sheet.
`void`	`calculate()` This method calculates all the formulas in a sheet.
`IRemoteRange`	`cells()` This method returns a Range object that represents a whole sheet, an entire row, or a cell.
`IRemoteRange`	`cells(int rowIndex)` This method returns a Range object that represents a whole sheet, an entire row, or a cell.
`IRemoteRange`	`cells(int rowIndex, int columnIndex)` This method returns a Range object that represents a whole sheet, an entire row, or a cell.
`IRemoteRange`	`columns()` This method returns a Range object that represents all columns or it returns one column by index.
`IRemoteRange`	`columns(int index)` This method returns a Range object that represents all columns or it returns one column by index.
`void`	`copyTo(IRemoteSheet pre)` This method copies a sheet and inserts it into current spreadsheet.
`void`	`copyTo(IRemoteSheet sheet_pos, boolean beforeOrAfter)` This method copies a sheet and inserts it into current spreadsheet.
`IRemoteDataPilotTable`	`dataPilotTableWizard(java.lang.String name, IRemoteRange sourceData, IRemoteRange dest)` This method creates a new DataPilot table report.
`void`	`deleteColumns(int columnIndex, int count, boolean isAfter)` This method deletes one or more columns in a sheet.
`void`	`deleteRows(int rowIndex, int count, boolean isAfter)` This method removes one or more rows in a sheet.
`void`	`freezePosition(int nColumns, int nRows)` This method freezes panes with the specified number of columns and rows.
`IRemoteSymphonyApplication`	`getApplication()` This property represents the Lotus Symphony application.
`IRemoteChartObjects`	`getChartObjects()` This property returns a ChartObjects object that represents a collection of all the embedded charts of the sheet.
`IRemoteDataPilotTables`	`getDataPilotTables()` This property returns a DataPilotTables object represents a collection of all the DataPilot table reports on a sheet.
`int`	`getIndex()` This property returns the index of the current sheet, starting from 1.
`java.lang.String`	`getName()` This property returns or sets a string value representing the name of the object.
`IRemoteRange`	`getSelectedRange()` This property returns a range object that represents the selected range.
`IRemoteRange`	`getUsedRange()` This property returns a range object that represents the used range (modified or containing data) on the specified sheet.
`boolean`	`hasFrozen()` This property returns whether the sheet is frozen.
`void`	`importCSVFile(java.lang.String fileName)` This method imports data from a CSV file into the current sheet.
`void`	`importCSVFile(java.lang.String fileName, java.lang.String fieldSeperator)` This method imports data from a CSV file into the current sheet.
`void`	`importCSVFile(java.lang.String fileName, java.lang.String fieldSeperator, java.lang.String delimiter)` This method imports data from a CSV file into the current sheet.
`void`	`importCSVFile(java.lang.String fileName, java.lang.String fieldSeperator, java.lang.String delimiter, int firstLine)` This method imports data from a CSV file into the current sheet.
`void`	`importCSVFile(java.lang.String fileName, java.lang.String fieldSeperator, java.lang.String delimiter, int firstLine, int importMode)` This method imports data from a CSV file into the current sheet.
`void`	`importFile(java.lang.String fileName, java.lang.String sheetName)` This method imports data from a spreadsheet into current sheet.
`void`	`importFile(java.lang.String fileName, java.lang.String sheetName, int firstLine)` This method imports data from a spreadsheet into current sheet.
`void`	`importFile(java.lang.String fileName, java.lang.String sheetName, int firstLine, int importMode)` This method imports data from a spreadsheet into current sheet.
`void`	`insertColumns(int columnIndex, int count, boolean isAfter)` This method inserts one or more columns in a sheet.
`void`	`insertRows(int rowIndex, int count, boolean isAfter)` This method inserts one or more rows.
`boolean`	`isProtected()` This property returns whether the sheet can be modified from UI.
`boolean`	`isVisible()` This property returns or sets whether the sheet is visible.
`void`	`moveTo(IRemoteSheet sheet)` This method moves a sheet to the specified position.
`void`	`moveTo(IRemoteSheet sheet_pos, boolean beforeOrAfter)` This method moves a sheet to the specified position.
`IRemoteSheet`	`next()` This property returns a sheet object that represents the next sheet.
`IRemoteSheet`	`previous()` This property returns a sheet object that represents the previous sheet.
`void`	`print()` This method prints the current sheet.
`void`	`protect()` This method makes current sheet un-modifiable from the user interface.
`void`	`protect(java.lang.String password)` This method makes current sheet un-modifiable from the user interface.
`IRemoteRange`	`range(IRemoteRange range1, IRemoteRange range2)` This method returns a Range object that represents a cell or a range of cells.
`IRemoteRange`	`range(java.lang.String name)` This method returns a Range object that represents a cell or a range of cells.
`void`	`remove()` This method deletes the sheet.
`IRemoteRange`	`rows()` This method returns a Range object representing all rows or returns one row by index.
`IRemoteRange`	`rows(int index)` This method returns a Range object representing all rows or returns one row by index.
`void`	`setName(java.lang.String name)` This property returns or sets a string value representing the name of the object.
`void`	`setVisible(boolean visible)` This property returns or sets whether the sheet is visible.
`void`	`unProtect()` This method makes the current sheet modifiable from UI.
`void`	`unProtect(java.lang.String password)` This method makes the current sheet modifiable from UI.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:: application
Throws:: RemoteEclipseAPIException

getChartObjects

IRemoteChartObjects getChartObjects()
                                    throws RemoteEclipseAPIException

This property returns a ChartObjects object that represents a collection of all the embedded charts of the sheet.

Usage

Use the add method in the ChartObjects to create a new chart object.
Use the item method in the ChartObjects to access a chart object.

Returns:: objects
Throws:: RemoteEclipseAPIException

getDataPilotTables

IRemoteDataPilotTables getDataPilotTables()
                                          throws RemoteEclipseAPIException

This property returns a DataPilotTables object represents a collection of all the DataPilot table reports on a sheet.

Returns:: tables
Throws:: RemoteEclipseAPIException

getIndex

int getIndex()
             throws RemoteEclipseAPIException

This property returns the index of the current sheet, starting from 1.

Returns:: index
Throws:: RemoteEclipseAPIException

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

This property returns or sets a string value representing the name of the object.

Returns:: name
Throws:: RemoteEclipseAPIException

setName

void setName(java.lang.String name)
             throws RemoteEclipseAPIException

This property returns or sets a string value representing the name of the object.

Parameters:: name -
Throws:: RemoteEclipseAPIException

IRemoteSheet next()
                  throws RemoteEclipseAPIException

This property returns a sheet object that represents the next sheet. If a next sheet does not exist, then it returns the sheet itself.

Returns:: sheet
Throws:: RemoteEclipseAPIException

IRemoteSheet previous()
                      throws RemoteEclipseAPIException

This property returns a sheet object that represents the previous sheet. If the previous sheet does not exist, then it returns the sheet itself.

Returns:: sheet
Throws:: RemoteEclipseAPIException

isProtected

boolean isProtected()
                    throws RemoteEclipseAPIException

This property returns whether the sheet can be modified from UI. A value of true means that the sheet can not be modified.

Returns:: protected
Throws:: RemoteEclipseAPIException

getUsedRange

IRemoteRange getUsedRange()
                          throws RemoteEclipseAPIException

This property returns a range object that represents the used range (modified or containing data) on the specified sheet. If the sheet is empty, it returns the range (A1:A1).

Returns:: range
Throws:: RemoteEclipseAPIException

isVisible

boolean isVisible()
                  throws RemoteEclipseAPIException

This property returns or sets whether the sheet is visible. A value of true means that the sheet is visible. In visible mode, we can not hide all the sheet in a spreadsheet, there must be at least one visible sheet in a spreadsheet.

Returns:: visible
Throws:: RemoteEclipseAPIException

setVisible

void setVisible(boolean visible)
                throws RemoteEclipseAPIException

Parameters:: visible -
Throws:: RemoteEclipseAPIException

activate

void activate()
              throws RemoteEclipseAPIException

This method makes the current sheet into the active sheet.

Throws:: RemoteEclipseAPIException

calculate

void calculate()
               throws RemoteEclipseAPIException

This method calculates all the formulas in a sheet.

Throws:: RemoteEclipseAPIException

copyTo

void copyTo(IRemoteSheet pre)
            throws RemoteEclipseAPIException

This method copies a sheet and inserts it into current spreadsheet.

Parameters:: pre -
Throws:: RemoteEclipseAPIException

copyTo

void copyTo(IRemoteSheet sheet_pos,
            boolean beforeOrAfter)
            throws RemoteEclipseAPIException

This method copies a sheet and inserts it into current spreadsheet.

Parameters:: sheet_pos - Specifies the position before or after which the new sheet is added. If this parameter is null, this method throws an exception.; beforeOrAfter - Adds the new sheet before or after the sheet_pos. A value of true adds the new sheet before the sheet_pos. A value of false adds the new sheet after the sheet_pos. The default value is true.
Throws:: RemoteEclipseAPIException

moveTo

void moveTo(IRemoteSheet sheet)
            throws RemoteEclipseAPIException

This method moves a sheet to the specified position.

Parameters:: sheet -
Throws:: RemoteEclipseAPIException

moveTo

void moveTo(IRemoteSheet sheet_pos,
            boolean beforeOrAfter)
            throws RemoteEclipseAPIException

This method moves a sheet to the specified position.

Parameters:: sheet_pos - Specifies the position before or after which the sheet moves. If this parameter is null, this method throws an exception.; beforeOrAfter - Moves the sheet before or after the sheet_pos parameter. A value of true moves the sheet before sheet_pos. A value of false moves the sheet after sheet_pos. The default value is true.
Throws:: RemoteEclipseAPIException

print

void print()
           throws RemoteEclipseAPIException

This method prints the current sheet.

Throws:: RemoteEclipseAPIException

protect

void protect()
             throws RemoteEclipseAPIException

This method makes current sheet un-modifiable from the user interface. After calling this method, the Protected property of Sheet returns true.

After calling this method, the sheet can not be modified from the UI or API.

Throws:: RemoteEclipseAPIException

protect

void protect(java.lang.String password)
             throws RemoteEclipseAPIException

Parameters:: password - Uses a string as password to lock this sheet.
Throws:: RemoteEclipseAPIException

unProtect

void unProtect()
               throws RemoteEclipseAPIException

This method makes the current sheet modifiable from UI. After calling this method, the Protected property of Sheet returns false.

Throws:: RemoteEclipseAPIException

unProtect

void unProtect(java.lang.String password)
               throws RemoteEclipseAPIException

This method makes the current sheet modifiable from UI. After calling this method, the Protected property of Sheet returns false.

Parameters:: password - Provides the string password to un-lock the sheet.
Throws:: RemoteEclipseAPIException

remove

void remove()
            throws RemoteEclipseAPIException

This method deletes the sheet.

Throws:: RemoteEclipseAPIException

range

IRemoteRange range(IRemoteRange range1,
                   IRemoteRange range2)
                   throws RemoteEclipseAPIException

This method returns a Range object that represents a cell or a range of cells.
range( range1, range2 ) returns the union range of range1 and range2 .

Parameters:: range1 - Specifies the start of the new range.; range2 - Specifies the end of the new range.
Returns:: A Range object that represents a cell or a range of cells.
Throws:: RemoteEclipseAPIException

range

IRemoteRange range(java.lang.String name)
                   throws RemoteEclipseAPIException

This method returns a Range object that represents a cell or a range of cells.

Parameters:: name - Specifies the range name of the new range. The name of range can represent a single cell, such as "A1", or represent a range containing a collection of cells, such as : "C2:E20", "B1:D10".
Returns:: A Range object that represents a cell or a range of cells.
Throws:: RemoteEclipseAPIException

columns

IRemoteRange columns()
                     throws RemoteEclipseAPIException

This method returns a Range object that represents all columns or it returns one column by index.

Returns:

range

columns() return a Range object represents the whole sheet.
columns( int index ) return a Range object represents a row.

Throws:

RemoteEclipseAPIException

columns

IRemoteRange columns(int index)
                     throws RemoteEclipseAPIException

This method returns a Range object that represents all columns or it returns one column by index.

Parameters:

index - Specifies the column index in the sheet, starting at 1.If the column index is out of bounds, this method throws an exception.

Returns:

range

columns() return a Range object represents the whole sheet.
columns( int index ) return a Range object represents a row.

Throws:

RemoteEclipseAPIException

rows

IRemoteRange rows()
                  throws RemoteEclipseAPIException

This method returns a Range object representing all rows or returns one row by index.

Returns:

range

rows() returns a Range object that represents the whole sheet.
rows( int index ) returns a Range object that represents a row.

Throws:

RemoteEclipseAPIException

rows

IRemoteRange rows(int index)
                  throws RemoteEclipseAPIException

This method returns a Range object representing all rows or returns one row by index.

Parameters:

index - Specifies the row index in the sheet, starting at 1. If the row index is out of bounds, this method throws an exception.

Returns:

range

rows() returns a Range object that represents the whole sheet.
rows( int index ) returns a Range object that represents a row.

Throws:

RemoteEclipseAPIException

dataPilotTableWizard

IRemoteDataPilotTable dataPilotTableWizard(java.lang.String name,
                                           IRemoteRange sourceData,
                                           IRemoteRange dest)
                                           throws RemoteEclipseAPIException

This method creates a new DataPilot table report.

Parameters:: name - Specifies the name of this table.; sourceData - Specifies the range that containing data. If the range is in another sheet, this method throws an exception.; dest - Specifies the position of the DataPilot table.
Returns:: symphonyDataPilotTable
Throws:: RemoteEclipseAPIException