com.f1j.ss
Interface BookModel

All Known Implementing Classes:
BookModelImpl, JBook

public interface BookModel
extends Constants, ViewContainer

this interface defines the common e.Spreadsheet API.


Inner Class Summary
static class BookModel.Factory
          A class containing methods for creating instances of the BookModel interface.
 
Field Summary
static short CANCEL
          Specifies a CANCEL button.
static short NO
          Specifies a NO button.
static short OK
          Specifies an OK button in the type parameter to messageBox().
static short YES
          Specifies a YES button.
 
Fields inherited from class com.f1j.ss.Constants
eClearAll, eClearContents, eClearDlg, eClearFormats, eClearValues, eColWidthUnitsNormal, eColWidthUnitsTwips, eCopyAll, eCopyFormats, eCopyFormulas, eCopyValues, eEncryptionAuto, eEncryptionExcel97, eEncryptionWeak, eFileActuate9, eFileCurrentFormat, eFileESpreadsheet11, eFileExcel5, eFileExcel97, eFileExcel97And5, eFileFormulaOne3, eFileFormulaOne6, eFileFormulaOne7, eFileTabbedText, eFileTabbedTextValuesOnly, eFileUnicodeText, eFileUnicodeTextValuesOnly, eFixupAppend, eFixupIgnoreAdjacentRanges, eFixupPrepend, eOutlineCollapsed, eOutlineExpanded, eOutlineTerminal, eParamCurrency, eParamDate, eParamDouble, eParametersFileActuate5, eParametersFileActuate6, eParametersFileActuate7, eParametersFileActuate8, eParamFormula, eParamInteger, eParamString, eQueryParamCurrency, eQueryParamDate, eQueryParamDouble, eQueryParamFormula, eQueryParamInteger, eQueryParamString, eSheetHidden, eSheetShown, eSheetTypeChart, eSheetTypeSheet, eSheetVeryHidden, eShiftColumns, eShiftHorizontal, eShiftRows, eShiftVertical, eShowAutomatic, eShowOff, eShowOn, eTabsBottom, eTabsOff, eTabsTop, eTypeEmpty, eTypeError, eTypeLogical, eTypeNumber, eTypeText, kAllowDefault, kAllowDeleteColumns, kAllowDeleteRows, kAllowEditObjects, kAllowFormatCells, kAllowFormatColumns, kAllowFormatRows, kAllowInsertColumns, kAllowInsertHyperlinks, kAllowInsertRows, kAllowNone, kAllowSelectLocked, kAllowSelectUnlocked, kAllowSort, kAllowUseAutoFilter, kAllowUsePivotRanges, kCodePageDefaultANSI, kCodePageUnicodeBE, kCodePageUnicodeLE, kCodePageUTF8, kContentsChanged, kFontChanged, kFormatChanged, kMaxCellText, kMaxCol, kMaxCols, kMaxPaletteEntry, kMaxRow, kMaxRows, kMaxSheet, kMaxSheets, kProtectStructure
 
Fields inherited from class com.f1j.mvc.Constants
kPaper10x14, kPaper11x17, kPaperA3, kPaperA4, kPaperA4Small, kPaperA5, kPaperB4, kPaperB5, kPaperCSheet, kPaperDSheet, kPaperEnv10, kPaperEnv11, kPaperEnv12, kPaperEnv14, kPaperEnv9, kPaperEnvB4, kPaperEnvB5, kPaperEnvB6, kPaperEnvC3, kPaperEnvC4, kPaperEnvC5, kPaperEnvC6, kPaperEnvC65, kPaperEnvDL, kPaperEnvItaly, kPaperEnvMonarch, kPaperEnvPersonal, kPaperESheet, kPaperExecutive, kPaperFanfoldLglGerman, kPaperFanfoldStdGerman, kPaperFanfoldUS, kPaperFolio, kPaperLedger, kPaperLegal, kPaperLetter, kPaperLetterSmall, kPaperNote, kPaperQuarto, kPaperStatement, kPaperTabloid
 
Method Summary
 void addColPageBreak(int col)
          Adds a vertical page break to the left edge of the specified column.
 void addHyperlink(int iSheet, int iRow1, int iCol1, int iRow2, int iCol2, java.lang.String strLink, int iType, java.lang.String strToolTip)
          Adds a hyperlink to a worksheet range.
 GRObject addObject(short objectType, double x1, double y1, double x2, double y2)
          Deprecated. Replaced by com.f1j.drawing.DrawingModel.addShape(com.f1j.drawing.EAutoShape, com.f1j.drawing.ShapeAnchor).
 void addPageBreak()
          Adds a horizontal and vertical page break adjacent to the active cell.
 GRObject addPicture(double x1, double y1, double x2, double y2, byte[] imageData)
          Deprecated. Replaced by com.f1j.drawing.DrawingModel.addPicture(byte[], com.f1j.drawing.ShapeAnchor).
 GRObject addPicture(double x1, double y1, double x2, double y2, java.net.URL url)
          Deprecated. Replaced by com.f1j.drawing.DrawingModel.addPicture(java.io.InputStream, com.f1j.drawing.ShapeAnchor).
 GRObject addPolygon(double x1, double y1, double x2, double y2, java.awt.Point[] points, boolean closed)
          Deprecated.  
 void addRowPageBreak(int row)
          Adds a horizontal page break adjacent to the top edge of the specified row.
 void addSelection(GRObject object)
          Deprecated. Replaced by com.f1j.drawing.DrawingModel.getSelectedShapes() and com.f1j.drawing.DrawingModel.setSelection(com.f1j.drawing.ShapeRange).
 void addSelection(int row1, int col1, int row2, int col2)
          Adds a new selection to the current selection list.
 void attach(Book book)
          Attaches the current BookModel to the specified Book using the display properties of the specified workbook.
 void attach(BookModel bookModel)
          Attaches the current BookModel to the specified BookModel using the display properties of the specified BookModel.
 void attach(java.lang.String workbookName)
          Searches for a workbook with the specified name, and attaches the current Book to it.
 void autoFreezePanes()
          Freezes or unfreezes the current split view.
 void autoSplitView(boolean horizontal, boolean vertical)
          Toggles the split state of the view.
 void cancelClipboard()
          Clears the internal clipboard and the Windows clipboard.
 void cancelEdit()
          Aborts edit mode and leaves the current cell unchanged.
 boolean canEditCopy()
          Returns true if data can be copied and placed on the clipboard.
 boolean canEditCut()
          Returns true if data can be cut and placed on the clipboard.
 boolean canEditPaste()
          Returns true if the internal clipboard or the Windows clipboard contains items that can be pasted to the worksheet.
 boolean canEditPasteSpecial()
          Returns true if the internal clipboard or the Windows clipboard contains items that can be pasted to the worksheet using the Paste Special command.
 int charWidthToTwips(int charWidth)
          Converts column widths to units equal to 1/256th of the character 0's width in the default font.
 void checkRecalc()
          Recalculates the workbook if needed.
 void clearRange(int row1, int col1, int row2, int col2, short clearType)
          Clears the specified range.
 void copyAll(BookModel srcBookModel)
          Copies the contents of one workbook to another workbook.
 void copyAllToBook(Book dstBook)
          Copies everything from the Book attached to this BookModel to the destination workbook, dstBook.
 void copyDataFromArray(int sheet, int row1, int col1, int row2, int col2, double[][] data)
          Copies data from an array into a sheet.
 void copyDataToArray(int sheet, int row1, int col1, int row2, int col2, double[][] data)
          Copies data from the sheet into an array.
 void copyRange(int dstRow1, int dstCol1, int dstRow2, int dstCol2, BookModel srcBookModel, int srcRow1, int srcCol1, int srcRow2, int srcCol2)
          Copies a range of cells to a new location in the current workbook.
 void copyRange(int dstRow1, int dstCol1, int dstRow2, int dstCol2, BookModel srcBookModel, int srcRow1, int srcCol1, int srcRow2, int srcCol2, short what)
          Copies a range of cells to a new location in the current workbook.
 void copyRange(int dstSheet, int dstRow1, int dstCol1, int dstRow2, int dstCol2, BookModel srcBookModel, int srcSheet, int srcRow1, int srcCol1, int srcRow2, int srcCol2)
          Copies a range of data from one worksheet to another.
 void copyRange(int dstSheet, int dstRow1, int dstCol1, int dstRow2, int dstCol2, BookModel srcBookModel, int srcSheet, int srcRow1, int srcCol1, int srcRow2, int srcCol2, short what)
          Copies a range of data from one worksheet to another.
 void copySheet(int insertAt)
          Creates copies of all selected sheets.
 void copySheet(int nInsertAt, Range range)
          Creates copies of the specified sheets.
 void deleteAutoFillItems(int index)
          Deletes the specified autofill list.
 void deleteDefinedName(java.lang.String name)
          Deletes the specified user-defined name.
 void deleteRange(int row1, int col1, int row2, int col2, short shiftType)
          Deletes cells, rows, or columns from the specified range in all selected sheets.
 void deleteSheet()
          Deletes the delected sheets.
 void deleteSheet(Range range)
          Deletes the specified sheets.
 void deleteSheets(int sheet, int sheets)
          Deletes one or more worksheets from a workbook.
 void editCopy()
          Copies the selected range or objects to the clipboard.
 void editCopyDown()
          Copies cells in the top row of a selection to the other rows in the selected range and adjusts relative cell references appropriately.
 void editCopyRight()
          Copies cells in the left column of a selection to the other columns in the selected range and adjusts relative cell references appropriately.
 void editCut()
          Cuts the selected range or object to the clipboard and clears the range or object from the active worksheet.
 void editDelete(short shift)
          Deletes the selected range in all selected sheets.
 void editDeleteSheets()
          Deletes the selected sheets.
 void editInsert(short shiftType)
          Moves the selected range in all selected worksheets to insert new cells, rows, or columns.
 void editInsertSheets()
          Inserts one or more new worksheets, depending on the number and position of the currently selected worksheets.
 void editPaste()
          Pastes the contents of the clipboard to the selected range.
 void editPaste(boolean done)
          Pastes the contents of the clipboard to the selected range.
 void editPaste(short what)
          Pastes data from the clipboard to the selected range.
 void endEdit()
          Ends edit mode and applies changes to the active cell.
 java.lang.String errorNumberToText(short error)
          Returns a string containing the text corresponding to the specified error number.
 void filePrint(boolean showPrintDlg)
          Prints the selected worksheet.
 void filePrint(boolean showPrintDlg, java.lang.Object job)
          Prints the selected worksheet to the passed-in Printer Job.
 FindReplaceInfo find(java.lang.String findWhat, int flags)
          Finds the first cell containing the specified text, starting with the active cell.
 FindReplaceInfo findFirst(int sheet1, int row1, int col1, int sheet2, int row2, int col2, java.lang.String findWhat, int flags)
          Finds the first cell in the specified sheet for the given range.
 FindReplaceInfo findFirst(int row1, int col1, int row2, int col2, java.lang.String findWhat, int flags)
          Finds the first cell in the current sheet for the given range.
 FindReplaceInfo findFirst(java.lang.String findWhat, int flags)
          Finds the first cell containing the specified text.
 FindReplaceInfo findNext(java.lang.String findWhat, int flags)
          Finds the next cell containing the specified text.
 FindReplaceInfo findNext(java.lang.String findWhat, int flags, FindReplaceInfo info)
          Finds the next cell containing the specified text.
 void flushModifiedEvents()
          Sends modified events to ModifiedListeners and clears the flags indicating that the events needed to be sent.
 java.lang.String formatRCNr(int row, int col, boolean doAbsolute)
          Returns a string containing a formatted row and column reference.
 RangeRef formulaToRangeRef(java.lang.String formula)
          Creates and returns an instance of RangeRef from a formula, in US English.
 RangeRef formulaToRangeRefLocal(java.lang.String formula)
          Creates and returns an instance of RangeRef from a formula, in the user's local language.
 void freezePanes(int topRow, int leftCol, int splitRows, int splitCols, boolean splitView)
          Sets frozen panes at the specified position.
 CellRef getActiveCell()
          Deprecated. Replaced by GetActiveCellEx().
 Range getActiveCellEx()
          Returns the range of the active cell.
 Range getActiveCellEx(Range dst)
          Returns the range of the active cell.
 int getActiveCol()
          Returns the column of the active cell.
 int getActivePane()
          Returns the active pane.
 int getActiveRow()
          Returns the row of the active cell.
 java.lang.String getApplicationName()
          Returns the application name.
 CellFormat getAppliedCellFormat(int sheet, int row, int col)
          Returns the format of the specified cell into the specified CellFormat object taking into consideration any conditional formats.
 java.lang.String getAutoFillItems(int index)
          Returns an autofill list.
 int getAutoFillItemsCount()
          Returns the number of existing autofill lists.
 AutoFilter getAutoFilter()
          Returns the AutoFilter that is on the current worksheet, or null if there is no AutoFilter.
 Book getBook()
          Returns the Book attached to this BookModel.
 BookModel getBookModelImpl()
          Returns the BookModelImpl for this BookModel.
 int getBookProtectionFlags()
          Returns a set of flags indicating which actions are protected on this workbook when protection is enabled.
 BookView getBookView()
          Returns the view info associated with this BookModel.
 CellFormat getCellFormat()
          Returns the format of the selected range of cells.
 void getCellFormat(CellFormat cellFormat)
          Returns the format of the selected range of cells into the specified CellFormat object.
 void getCellFormat(CellFormat cellFormat, int row1, int col1, int row2, int col2)
          Returns the format of the specified range of cells into the specified CellFormat object.
 void getCellFormat(CellFormat cellFormat, int sheet1, int row1, int col1, int sheet2, int row2, int col2)
          Returns the format of the specified range of cells in the specified range of sheets into the specified CellFormat object.
 CellFormat getCellFormat(int row1, int col1, int row2, int col2)
          Returns the format of the specified range of cells.
 CellFormat getCellFormat(int sheet1, int row1, int col1, int sheet2, int row2, int col2)
          Returns the format of the specified range of cells in the specified range of sheets.
 java.lang.String getCellText()
          Returns a text representation of the value of the active cell.
 java.lang.String getClip()
          Convert selected cells to a tab-delimited text string using the formats assigned to the selected cells.
 java.lang.String getClipValues()
          Converts selected cells to a tab-delimited string ignoring any formatting which exists in the selected cells.
 int getCol()
          Returns the active column in the active worksheet.
 int getColOutlineLevel(int col)
          Returns the outline level of a single specified column.
 java.lang.String getColText(int col)
          Returns the label for a column.
 int getColWidth(int col)
          Returns the width of a single column.
 int getColWidthTwips(int col)
          Returns the width of the specified column in twips.
 short getColWidthUnits()
          Returns whether column widths are stored and displayed in twips or character units.
 ConditionalFormat[] getConditionalFormats()
          Returns the conditional formats for the current selection.
 DataRangeCollection getDataRangeCollection(int sheet)
          Returns the data range collection associated with the specified sheet.
 DataRangeModel getDataRangeModel()
          Returns a reference to the DataRange model.
 DataSourceCollection getDataSourceCollection()
          Returns the data source collection associated with this BookModel (JBook).
 int getDefaultColWidth()
          Returns the default column width.
 java.lang.String getDefaultFontName()
          Returns the name of the default font.
 int getDefaultFontSize()
          Returns the size of the default font.
 int getDefaultRowHeight()
          Returns the default height for rows.
 java.lang.String getDefinedName(int name)
          Returns the defined name for the specified index number.
 java.lang.String getDefinedName(java.lang.String name)
          Returns the definition associated with the specified name, in US English.
 int getDefinedNameCount()
          Returns the number of defined names in a view.
 java.lang.String getDefinedNameLocal(java.lang.String name)
          Returns the definition of a defined name in the user's local language.
 DrawingModel getDrawing()
          Returns a reference to the drawing model.
 java.lang.String getEntry()
          Returns the contents of the active cell in the first selected worksheet in edit mode format.
 java.lang.String getEntry(int row, int col)
          Returns the text value of the specified cell in the current worksheet in edit mode format.
 java.lang.String getEntry(int sheet, int row, int col)
          Returns the value of the specified cell on the specified worksheet in edit mode format.
 java.lang.String getEntry(java.lang.String location)
          Returns the value of the specified cell in edit mode format.
 java.lang.String getFileName()
          Returns the name of the workbook file currently loaded.
 NumberFormat getFirstNumberFormat()
          Returns a NumberFormat object representing the first entry in the workbook's number format table.
 GRObject getFirstObject()
          Deprecated. Replaced by com.f1j.drawing.Drawing.getShapeCount() and com.f1j.drawing.Drawing.getShape(int).
 int getFixedCol()
          Deprecated. Replaced by isFrozenPanes() and getLeftCol(int).
 int getFixedCols()
          Deprecated. Replaced by isFrozenPanes() and getSplitPos().
 int getFixedRow()
          Deprecated. Replaced by isFrozenPanes() and getTopRow(int).
 int getFixedRows()
          Deprecated. Replaced by isFrozenPanes() and getSplitPos().
 java.lang.String getFormattedText()
          Returns the formatted text value of the active cell.
 java.lang.String getFormattedText(int row, int col)
          Returns the formatted text value of the specified cell.
 java.lang.String getFormattedText(int sheet, int row, int col)
          Returns the value of the specified cell as it appears in the specified worksheet.
 java.lang.String getFormula()
          Returns the formula of the active cell.
 java.lang.String getFormula(int row, int col)
          Returns the text of the formula of the specified cell, in US English.
 java.lang.String getFormula(int sheet, int row, int col)
          Returns the text of the formula of the specified cell in the specified sheet, in US English.
 java.lang.String getFormulaLocal()
          Returns the text of the formula of the active cell, in the user's language.
 java.lang.String getFormulaLocal(int row, int col)
          Returns the text of the formula of the specified cell, in the user's language.
 java.lang.String getFormulaLocal(int sheet, int row, int col)
          Returns the text of the formula of the specified cell in the specified sheet, in the user's language.
 java.lang.String getGroup()
          Returns the Group name for the workbook attached to this BookModel.
 int getHeaderHeight()
          Returns the height of the column headers.
 int getHeaderWidth()
          Returns the width of the row headers.
 java.lang.String getHyperlinkBase()
          Returns the hyperlink base string used for relative hyperlinks.
 Hyperlink[] getHyperlinks(int iSheet)
          Returns an array of hyperlinks for an individual sheet in the book.
 int getIterationMax()
          Returns the maximum number of calculation iterations.
 double getIterationMaxChange()
          Returns the maximum iteration change value.
 int getLastCol()
          Returns the number of the last occupied column.
 int getLastColForRow(int row)
          Returns the number of the last occupied column in the specified row.
 int getLastRow()
          Returns the number of the last row that is not empty, including cells that contain only formatting.
 int getLeftCol()
          Returns the first column currently displayed in this BookModel.
 int getLeftCol(int pane)
          Returns the left column displayed in the specified pane.
 void getLock()
          Acquires a lock for the group to which this BookModel belongs.
 int getMaxCol()
          Returns the last column which may be displayed in the current sheet.
 int getMaxRow()
          Returns the last row which may be displayed in the current sheet.
 int getMinCol()
          Returns the first column that can be displayed in the active worksheet.
 int getMinRow()
          Returns the first row that can be displayed in the active worksheet.
 short getMode()
          Deprecated. Replaced by com.f1j.drawing.Shape.isDrawingMode() and com.f1j.drawing.DrawingModel.getDrawingModeShape() and com.f1j.drawing.DrawingModel.getDrawingModeType().
 int getNextColPageBreak(int col)
          Returns the next column where there is a page break.
 NumberFormat getNextNumberFormat(NumberFormat f)
          Returns a NumberFormat object containing the next entry in the workbook's number format table.
 int getNextRowPageBreak(int row)
          Returns the next row where there is a page break.
 double getNumber()
          Returns the numeric value of the active cell.
 double getNumber(int row, int col)
          Returns the numeric value of the specified cell.
 double getNumber(int sheet, int row, int col)
          Returns the numeric value of the specified cell in the specified worksheet.
 int getNumSheets()
          Returns the number of worksheets in the current workbook.
 GRObject getObject(int objectID)
          Deprecated. Replaced by com.f1j.drawing.DrawingModel.getShape(int).
 GRObject getObject(java.lang.String objectName)
          Deprecated.  
 int getPaletteRGB(int entry)
          Returns a color in the e.Spreadsheet color palette.
 short getParameterType(int name)
          Returns the type of the specified parameter.
 PivotRangeModel getPivotRangeModel()
          Returns a reference to the PivotRange model.
 short getPolyEditMode()
          Deprecated.  
 java.lang.String getPrintArea()
          Returns the current print area.
 java.lang.String getPrintAreaLocal()
          Returns the current print area.
 double getPrintBottomMargin()
          Returns the bottom print margin in inches.
 java.lang.String getPrintFooter()
          Returns the current page footer.
 double getPrintFooterMargin()
          Returns the page footer margin used during printing.
 java.lang.String getPrintHeader()
          Returns the page header printed at the top of each page.
 double getPrintHeaderMargin()
          Returns the page header margin used during printing.
 double getPrintLeftMargin()
          Returns the left print margin in inches.
 int getPrintNumberOfCopies()
          Returns the number copies to print

Note: Although methods that set and get print settings are accessible in a GUI-less environment, since printing requires access to a graphical device, methods that implement printing are not usable in environments without access to graphics hardware.

 int getPrintPaperHeight()
          Returns the height of the paper in twips.
 short getPrintPaperSize()
          Returns paper size print setting value.
 int getPrintPaperWidth()
          Returns the width of the paper in twips.
 double getPrintRightMargin()
          Returns the right print margin in inches.
 int getPrintScale()
          Returns the scale factor for the active worksheet.
 int getPrintScaleFitHPages()
          Returns the number of horizontal pages to which the print job is fit.
 int getPrintScaleFitVPages()
          Returns the number of vertical pages to which the print job is fit.
 int getPrintStartPageNumber()
          Returns the number displayed on the first page printed.
 java.lang.String getPrintTitles()
          Returns the print titles to be printed at the top of each page, in US English.
 java.lang.String getPrintTitlesLocal()
          Returns the print titles to be printed at the top of each page, in the user's language.
 double getPrintTopMargin()
          Returns the top print margin in inches.
 Range getRange(int row1, int col1, int row2, int col2)
          Returns a Range object for the specified coordinates on the current worksheet.
 Range getRange(int sheet1, int row1, int col1, int sheet2, int row2, int col2)
          Returns a Range object for the specified coordinates on the current worksheet.
 ReadResults getReadResults()
          Deprecated. Replaced by Document.getDocumentSaveOptions(), Document.getDocumentType()
 ReportParameterCollection getReportParameterCollection()
          Returns a ReportParameterCollection object representing the collection of report parameters.
 int getRow()
          Returns the row of the active cell.
 int getRowHeight(int row)
          Returns the height of a single specified row.
 int getRowOutlineLevel(int row)
          Returns the outline level of a single specified row.
 java.lang.String getRowText(int row)
          Returns the name of the specified row.
 DataRange getSelectedDataRange()
          Returns a reference to the currently selected DataRange.
 GRObject getSelectedObject(int selection)
          Deprecated. Replaced by com.f1j.drawing.DrawingModel.getSelectedShapes() and com.f1j.drawing.ShapeRange.getShape(int).
 int getSelectedObjectCount()
          Deprecated. Replaced by com.f1j.drawing.DrawingModel.getSelectedShapes() and com.f1j.drawing.ShapeRange.getShapeCount().
 PivotRange getSelectedPivotRange()
          Returns a reference to the currently selected PivotRange.
 Range getSelectedRange()
          Returns a Range object that represents the the current selection.
 Range getSelectedRange(Range dst)
          Returns a Range object that represents the the current selection.
 java.lang.String getSelection()
          Returns a formula that represents the row and column coordinates of the current selection.
 RangeRef getSelection(int selection)
          Deprecated. Replaced by getSelectedRange.
 int getSelectionCount()
          Deprecated. Replaced by getSelectedRange.
 java.lang.String getSelectionLocal()
          Returns the start and end row and column of the specified selection, in the user's language.
 int getSelEndCol()
          Returns the last selected column.
 int getSelEndRow()
          Returns the last selected row.
 int getSelStartCol()
          Returns the first selected column.
 int getSelStartRow()
          Returns the first selected row.
 int getSheet()
          Returns the active worksheet.
 java.lang.String getSheetName(int sheet)
          Returns the name of the specified worksheet.
 int getSheetProtectionFlags(int sheet)
          Returns a set of flags indicating which actions are allowed when sheet protection is enabled.
 short getShowHScrollBar()
          Returns the mode for the horizontal scroll bar.
 short getShowSelections()
          Returns the mode for highlighting selections.
 short getShowTabs()
          Returns the display status and position of the sheet name tabs on a workbook.
 short getShowVScrollBar()
          Returns the mode for the vertical scroll bar.
 boolean getSplitPos(java.awt.Point point)
          if this is a split view or if the view has frozen panes, returns the position of the split.
 java.lang.String getTabbedText(int row1, int col1, int row2, int col2, boolean valuesOnly)
          Takes the specified range of data and converts it to a tab-delimited block of text.
 java.lang.String getText(int row, int col)
          Returns the text value of the specified cell.
 java.lang.String getText(int sheet, int row, int col)
          Returns the text value of the specified cell.
 int[] getTextFormatPositions()
          Returns an array of ints that gives the location within the text of the CellFormats returned by the getTextFormats method.
 CellFormat[] getTextFormats()
          Returns an array of CellFormats that describe the text attributes of the selected cell.
 int getTextSelectionEnd()
          Returns the text selection ending position of the selected cell.
 int getTextSelectionStart()
          Returns the text selection starting position of the selected cell.
 java.lang.String getTopLeftText()
          Returns the text displayed at the intersection of the row and column headings in the top left corner.
 int getTopRow()
          Returns the top row displayed in the active worksheet.
 int getTopRow(int pane)
          Returns the top row displayed in the specified pane.
 short getType()
          Returns the cell type of the active cell.
 short getType(int row, int col)
          Returns the cell type of the specified cell.
 short getType(int sheet, int row, int col)
          Returns the cell type of the specified cell.
 int getViewScale()
          Returns the current display scale for a workbook.
 java.lang.String getWorkbookName()
          Returns the name assigned to this workbook.
 boolean hasAutoFilter()
          true if the AutoFilter drop-down arrows are currently displayed on the current worksheet.
 boolean hasDrawing()
          Returns true if the active sheet currently has a drawing.
 boolean hasPivotGroup()
          Returns true if the workbook currently has a PivotRange group.
 boolean hasReportFunctionsGroup()
          Returns true if the workbook currently has a ReportFunctionsGroup.
 void initWorkbook()
          Initilaizes a workbook to a default, empty state.
 void insertRange(int row1, int col1, int row2, int col2, short shiftType)
          Moves the specified range in order to insert new cells, rows or columns.
 void insertSheet()
          Inserts one or more sheets before the active sheet.
 void insertSheets(int sheet, int sheets)
          Inserts one or more worksheets at the specified location.
 boolean isAllowArrows()
          Returns true if arrow keys can be used to navigate the worksheet.
 boolean isAllowAutoFill()
          Returns true if auto fill is enabled.
 boolean isAllowCellTextDlg()
          Returns true if the cell text dialog pops up when the user presses F2 during cell editing.
 boolean isAllowDelete()
          Returns true if the delete key deletes records and clears selection.
 boolean isAllowDesigner()
          Returns true if the Workbook Designer can be launched at run time.
 boolean isAllowEditHeaders()
          Returns true if users can edit row, column and top left headers.
 boolean isAllowedSheetAction(int protectionFlags)
          Returns true if the selected sheets are not protected or if the selected sheets' current protection settings allow all of the specified actions.
 boolean isAllowedSheetAction(int sheet, int protectionFlags)
          Returns true if the specified sheet is not protected or if the specified sheet's current protection settings allow all of the specified actions.
 boolean isAllowFillRange()
          Returns true if the user is allowed to fill a range by clicking and dragging with the mouse.
 boolean isAllowFormulas()
          Returns true if the user is allowed to enter and edit formulas.
 boolean isAllowInCellEditing()
          Returns true if cells are edited in place.
 boolean isAllowLockedCellsErrMsg()
          Returns true if an error message pops up when a user tries to type in a locked cell.
 boolean isAllowMoveRange()
          Returns true if the user is allowed to move a range by clicking and dragging with the mouse.
 boolean isAllowNewShapes()
          Returns true if it is currently possible to add new shapes to the active sheet's drawing.
 boolean isAllowObjSelections()
          Returns true if objects can be selected.
 boolean isAllowResize()
          Returns true if the user is allowed to resize rows and columns with the mouse.