com.jxcell
Class View

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Panel
              extended byjava.applet.Applet
                  extended bycom.jxcell.View
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.AdjustmentListener, java.awt.datatransfer.ClipboardOwner, java.util.EventListener, java.awt.event.FocusListener, java.awt.image.ImageObserver, java.awt.event.KeyListener, java.awt.MenuContainer, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.io.Serializable, java.awt.datatransfer.Transferable

public class View
extends java.applet.Applet
implements java.awt.event.KeyListener, java.awt.event.FocusListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.AdjustmentListener, java.awt.datatransfer.Transferable, java.awt.datatransfer.ClipboardOwner, java.io.Serializable

This is the JXCell view class.

This is the primary class of JXCell. It may be used as an Applet, Component or JavaBean.

You may also use this class to create an instance of a workbook which is not visible, such as for use on a server.

See Also:
Serialized Form

Field Summary
static short CANCEL
          Specifies a CANCEL button
static short eClearAll
          Clears values, formats, and objects
static short eClearDlg
          Displays the Clear dialog box
static short eClearFormats
          Clears formats only
static short eClearValues
          Clears values only, including formats
static short eColWidthUnitsNormal
          Column width in characters
static short eColWidthUnitsTwips
          Column width in twips
static short eCopyAll
          Copies formats, values, and formulas
static short eCopyFormats
          Copies formats
static short eCopyFormulas
          Copies formulas
static short eCopyValues
          Copies values
static short eFileCurrentFormat
          JXCell version
static short eFileExcel
          Excel 97 format
static short eFileJXCell
          JXCell format
static short eFileTabbedText
          Tab-delimited text
static short eFileTabbedTextValuesOnly
          Tab-delimited text files values only
static short eModeArc
          Arc drawing
static short eModeButton
          Button drawing
static short eModeChart
          Chart drawing
static short eModeCheckBox
          Checkbox drawing
static short eModeDropDown
          Drop-down list drawing
static short eModeLine
          Line drawing
static short eModeNormal
          Normal worksheet editing
static short eModeOval
          Oval drawing
static short eModePicture
          Button drawing
static short eModePolygon
          Polygon drawing
static short eModeRectangle
          Rectangle drawing
static short eModeText
          Field drawing
static short ePolyEditModeNormal
          Edits a polygon bounding box
static short ePolyEditModePoints
          Eidts polygon points
static short eShiftColumns
          Columns in which the range resdies are deleted and the rightmost columns are shifted left to fill the vacated space
static short eShiftHorizontal
          Cells to the right of the range are shifted left to fill the vacated space
static short eShiftRows
          Rows in which the range resieds are deleted and lower rows are shifted up to fill the vacated space
static short eShiftVertical
          Cells below the range are shifted up to fill the vacated space
static short eShowAutomatic
          Displayed if workbook or control is active
static short eShowOff
          Selections or scrollbars are hidden
static short eShowOn
          Selections or scrollbars are displayed
static short eTabsBottom
          Tabs appear at the bottom of worksheets
static short eTabsOff
          Tabs do not appear on worksheets
static short eTabsTop
          Tabs appear at the top of worksheets
static short eTypeEmpty
          Indicates an empty cell
static short eTypeError
          Indicates the cell contains an error
static short eTypeLogical
          Indicates a logical cell
static short eTypeNumber
          Indicates a number cell
static short eTypeText
          Indicates a text cell
static int kMaxCols
          The maximum number of columns
static int kMaxRows
          The maximum number of rows
static int kMaxSheets
          The maximum number of sheets
static short NO
          Specifies a NO button
static short OK
           
static java.awt.Color scControl
           
static java.awt.Color scControlDkShadow
           
static java.awt.Color scControlHighlight
           
static java.awt.Color scControlLtHighlight
           
static java.awt.Color scControlShadow
           
static java.awt.Color scControlText
           
static java.awt.Color scText
           
static java.awt.Color scTextText
           
static java.awt.Color scWindow
           
static java.awt.Color scWindowText
           
static int setResizableAfterAddNotify
           
static char[] SLASH
          A constant to represent the / character
static short YES
          Specifies a YES button
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
View()
          This constructor calls the other View constructor with a null View reference to create a new workbook.
View(View view)
          If the View argument is null, this constructor creates a new workbook, or if the View argument is not null, this constructor attaches to the specified view's workbook.
 
Method Summary
 void addCancelEditListener(CancelEditListener canceleditlistener)
          Adds the specified listener to receive CancelEdit events

 void addColPageBreak(int i)
          Adds a vertical page break to the left edge of the specified column

 void addEndEditListener(EndEditListener endeditlistener)
          Adds the specified listener to receive EndEdit events

 void addEndRecalcListener(EndRecalcListener endrecalclistener)
          Adds the specified listener to receive EndRecalc events

 void addModifiedListener(ModifiedListener modifiedlistener)
          Adds the specified listener to receive Modified events

 GRObject addObject(short objectType, double x1, double y1, double x2, double y2)
          Creates and adds an object to the active worksheet

 void addObjectListener(ObjectListener objectlistener)
          Adds the specified listener to receive Object events

 void addPageBreak()
          Adds a horizontal and vertical page break adjacent to the active cell

The horizontal page break is added at the cell's top edge; the vertical page break is added at the cell's left edge.

 GRObject addPicture(double x1, double y1, double x2, double y2, byte[] imageData)
          Adds picture object to the worksheet

 GRObject addPicture(double x1, double y1, double x2, double y2, java.net.URL url)
          Adds picture object to the worksheet

 GRObject addPolygon(double x1, double y1, double x2, double y2, java.awt.Point[] apoint, boolean closed)
          Creates and adds a polygon to a view, and specifieds the placement of points in the polygon.
 void addRowPageBreak(int row)
          Adds a horizontal page break adjacent to the top edge of the specified row

 void addSelection(GRObject grobject)
          Selects an additional object.
 void addSelection(int row1, int col1, int row2, int col2)
          Adds a new selection to the current selection list Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.
 void addSelectionChangedListener(SelectionChangedListener selectionchangedlistener)
          Adds the specified listener to receive SelectionChanged events

 void addStartEditListener(StartEditListener starteditlistener)
          Adds the specified listener to receive StartEdit events

 void addStartRecalcListener(StartRecalcListener startrecalclistener)
          Adds the specified listener to receive StartRecalc events

 void addUpdateListener(UpdateListener updatelistener)
          Adds the specified listener to receive Update events

 void addValidationFailedListener(ValidationFailedListener validationfailedlistener)
          Adds the specified listener to receive ValidationFailed events

 void addViewChangedListener(ViewChangedListener viewchangedlistener)
          Adds the specified listener to receive ViewChanged events

 void adjustmentValueChanged(java.awt.event.AdjustmentEvent adjustmentevent)
           
static void Assert(boolean flag)
           
 void attach(java.lang.String workbookName)
          Searches for a workbook with the specified name, and attaches the current view to it.
 void attach(View view)
          Attaches the current view to the specified view's workbook, using the display properties of the specified view's workbook.
 void cancelEdit()
          Aborts edit mode and leaves the current cell unchanged

 int charWidthToTwips(int nCharWidth)
          Converts column widths to units equal to 1/256th of the character 0's width in the default font.
 void checkRecalc()
          Recalculates the worksheet if needed

 void childIsActive()
          Informs the View that a child of the view is or soon will be active.
 void clearRange(int row1, int col1, int row2, int col2, short clearType)
          Clears the specified range Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.
 void copyAll(View view)
          Copies the contents of one workbook to another workbook Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.
 void copyDataFromArray(int sheet, int row1, int col1, int row2, int col2, double[][] data)
          Copies data from an array into a sheet The array and the sheet do not have to be the same size.
 void copyDataToArray(int sheet, int row1, int col1, int row2, int col2, double[][] data)
          Copies data from the sheet into an array The array and the sheet do not have to be the same size.
 void copyRange(int dstSheet, int dstRow1, int dstCol1, int dstRow2, int dstCol2, View srcView, int srcSheet, int srcRow1, int srcCol1, int srcRow2, int srcCol2)
          Copies a range of cells to a new location in the current workbook Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.
 void copyRange(int dstSheet, int dstRow1, int dstCol1, int dstRow2, int dstCol2, View srcView, int srcSheet, int srcRow1, int srcCol1, int srcRow2, int srcCol2, short what)
          Copies a range of cells to a new location in the current workbook This method allows you to choose the type of data to copy: formulas only, values only, formats only, any combination of the previous types, or all of the types.
 void copyRange(int dstRow1, int dstCol1, int dstRow2, int dstCol2, View srcView, int srcRow1, int srcCol1, int srcRow2, int srcCol2)
          Copies a range of cells to a new location in the current workbook The source range can be in a different workbook.
 void copyRange(int dstRow1, int dstCol1, int dstRow2, int dstCol2, View srcView, int srcRow1, int srcCol1, int srcRow2, int srcCol2, short what)
          Copies a range of cells to a new location in the current workbook The source range can be in a different workbook.
 void deleteAutoFillItems(int index)
          Deletes the specified autofill list Autofill lists are frequently used series of data, such as months and days of the week.
 void deleteDefinedName(java.lang.String name)
          Deletes the specified user-defined name You cannot delete a defined name that is currently referenced by a formula in a cell, another defined name, or a chart object.
 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 deleteSheets(int sheet, int sheets)
          Deletes one or more worksheets from a workbook The names displayed on the sheet tabs are not affected by deletions; however, the worksheet index is adjusted.
 void destroy()
          Releases resources associated with this view.
 void doLayout()
           
 void draw(java.awt.Graphics g, int x, int y, int cx, int cy, int nRow, int nCol, int[] rows, int[] cols, int nFixedR1, int nFixedRows, int nFixedC1, int nFixedCols)
          Draws a workbook to the specified device context, such as a printer or window.
 void editClear(short clearType)
          Clears all cells in the selected range and all selected objects in all selected sheets

 void editCopy()
          Copies the selected range or objects to the clipboard Only one range can be selected.
 void editCopyDown()
          Copies cells in the top row 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 Sheet names displayed on the tabs are not affect by the deletion; however, the remaining worksheet indexes are adjusted to reflect the new position.
 void editInsert(short shift)
          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 editPasteSpecial(short what)
          Pastes data from the clipboard to the selected range This method allows you to choose the type of data to paste: formulas only, values only, formats only, any combination of the previous types, or all of the types.
 void endEdit()
          Ends edit mode and applies changes to the active cell If an invalid entry has been made (e.g., an incorrect formula), edit mode cannot end.
 java.lang.String errorNumberToText(short error)
          Returns a string containing the text of the corresponding to the specified error number
 void filePrint(boolean showPrintDlg)
          Prints the selected worksheet If the user-defined name Print_Area is defined, only those ranges specified in Print_Area are printed.
 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 current 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 in the current sheet for the given range.
 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 findreplaceinfo)
          Finds the next cell containing the specified text
 void flushModifiedEvents()
          Sends modified events to Modified event listeners and clears the flags indicating the events needed to be sent
 void focusGained(java.awt.event.FocusEvent focusevent)
           
 void focusLost(java.awt.event.FocusEvent focusevent)
           
 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.
 CellRef getActiveCell()
          Returns the row and column coordinates of the active cell The active cell is the cell in which the cursor is currently located.
 java.lang.String getAutoFillItems(int index)
          Returns an autofill list Autofill lists are frequently used series of text such as months and days of the week.
 int getAutoFillItemsCount()
          Returns the number of existing autofill lists
 java.awt.Color getBackColor()
          Returns the background color of the current sheet.
 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 You can use this method to loop through cells, retrieving cell formats through the same instance of the 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 You can use this method to loop through cells, retrieving cell formats through the same instance of the 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 You can use this method to loop through cells, retrieving cell formats through the same instance of the CellFormat object.
 CellFormat getCellFormat(int row1, int col1, int row2, int col2)
          Returns the format of the specified range of cells Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.
 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 Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.
 java.lang.String getClip()
          Imports tab-delimited text strings from workbooks.
static java.awt.datatransfer.Clipboard getClipboard()
          Returns the clipboard to be used for clipboard operations.
 java.lang.String getClipValues()
          Imports values from workbooks
 int getCol()
          Returns the active column in the active worksheet.
 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 Column width can be specified in units equal to 1/256th of the character O's width in the default font, or to twips, depending on the column width units specified for the workbook.
 short getColWidthUnits()
          Returns whether column widths are stored and displayed in twips or character units.
 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 a defined name
 java.lang.String getDefinedName(java.lang.String name)
          Returns the definition associated with a 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 A defined name can refer to a cell, a group of cells, a value, or a formula.
 java.lang.String getEntry()
          Returns the contents of the active cell in the first selected worksheet in edit mode format For example, if the cell contains a formula, the text of the formula is displayed.
 java.lang.String getEntry(int row, int col)
          Returns the text value of the specified cell in the first selected worksheet in edit mode format For example, if the cell contains a formula, the text of the formula is displayed.
 java.lang.String getEntry(int sheet, int row, int col)
          Returns the text value of the specified cell in the first selected worksheet in edit mode format For example, if the cell contains a formula, the text of the formula is displayed.
 java.awt.Color getExtraColor()
          Returns the extra color of the current sheet.
 java.lang.String getFileName()
          Returns the name of the workbook file currently attached to a view.
 NumberFormat getFirstNumberFormat()
          Returns a NumberFormat object representing the first entry in the workbook's number format table.
 GRObject getFirstObject()
          Returns the first object in the active worksheet This method can be used in conjunction with the getNextObject method to to loop through all the objects in a worksheet.
 View getFirstView()
          Returns the first view of the workbook attached to this view.
 int getFixedCol()
          Returns the starting fixed column.
 int getFixedCols()
          Returns the number of fixed columns or zero if there are none.
 int getFixedRow()
          Returns the starting fixed row.
 int getFixedRows()
          Returns the number of fixed rows or zero if there are none.
 java.lang.String getFormattedText()
           
 java.lang.String getFormattedText(int row, int col)
          Returns the formatted text value of the specified cell This method returns the text as it is seen in the worksheet, including all formatting.
 java.lang.String getFormattedText(int sheet, int row, int col)
          Returns the value of the specified cell as it appears in the specified worksheet This method returns the text as it is seen in the worksheet, including all formatting.
 java.lang.String getFormula()
          Returns the formula of the active cell.
 java.lang.String getFormula(int row, int col)
          Returns the the text of the formula of the specified cell, in US English.
 java.lang.String getFormula(int sheetnum, int row, int col)
          Returns the the text of the formula of the specified cell, 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 the text of the formula of the specified cell, in the user's language
 java.lang.String getFormulaLocal(int sheetnum, int row, int col)
          Returns the 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 view.
 int getHeaderHeight()
          Returns the height of the column headers.
 int getHeaderWidth()
          Returns the width of the row headers.
 java.awt.Image getImg(java.net.URL url)
           
 java.awt.Insets getInsets()
           
 int getIterationMax()
          Returns the maximum number of calculation iterations Iteration can be used to resolve circular references.
 double getIterationMaxChange()
          Returns the maximum iteration change value Iteration can be used to resolve circular references.
 int getLastCol()
          Returns the number of the last occupied column This method returns the last column that is not empty, including cells that contain only formatting.
 int getLastColForRow(int rownum)
          Returns the number of the last occupied column in the specified row This method returns the last column that is not empty, including cells that contain only formatting.
 int getLastRow()
          Returns the number of the last occupied row This method returns the last row that is not empty, including cells that contain only formatting.
 int getLeftCol()
          Returns the first column currently displayed in this view.
 void getLock()
          Locks all views and workbooks in the current group.
 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()
          Returns the current mode for mouse actions in a view
 int getNextColPageBreak(int col)
          Returns the next column where there is a page break
 NumberFormat getNextNumberFormat(NumberFormat numberformat)
          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
 View getNextView()
          Returns the next view of a workbook.
 double getNumber()
          Returns the numeric value of the active cell Cells containing a formula return the numeric result of the formula.
 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 Cells containing a formula return the numeric result of the formula.
 int getNumSheets()
          Returns the number of worksheets in the current workbook
 GRObject getObject(int objectID)
          Returns an object specified by its identification number
 GRObject getObject(java.lang.String name)
          Returns an object specified by name
 java.awt.Color getPaletteEntry(int entry)
          Returns a color in the JXCell color palette
 java.lang.String[][] getParameterInfo()
           
 java.awt.Frame getParentFrame()
          Returns the parent window
 short getPolyEditMode()
          Returns the mode for interactive polygon editing In normal polygon editing mode (0), only the width and height of polygons can be interactively edited.
 java.lang.String getPrintArea()
          Returns the current print area The returned string is based on the user-defined name, Print_Area, which defines the worksheet range to be printed.
 double getPrintBottomMargin()
          Returns the bottom print margin in inches.
 java.lang.String getPrintFooter()
          Returns the current page footer The following list shows the special codes the footer text can contain.
 double getPrintFooterMargin()
          Returns the page footer margin used during printing The header and footer margins can be printed.
 java.lang.String getPrintHeader()
          Returns the page header printed at the top of each page The following list shows the special codes the footer text can contain.
 double getPrintHeaderMargin()
          Returns the page header margin used during printing The header and footer margins can be printed.
 double getPrintLeftMargin()
          Returns the left print margin in inches.
 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
 java.lang.String getPrintTitles()
          Returns the print titles to be printed at the top of each page Print titles are row and column titles that are printed on each page.
 double getPrintTopMargin()
          Returns the top print margin in inches.
 int getRow()
          Returns the row of the active cell.
 int getRowHeight(int row)
          Returns the height of a single specified row.
 java.lang.String getRowText(int row)
          Returns the name of the specified row Naming a row is useful for providing labels that reflect the data in the row.
 GRObject getSelectedObject(int selection)
          Returns the ID of a selected object.
 int getSelectedObjectCount()
          Returns the number of selected objects.
 java.lang.String getSelection()
          Returns a formula that represents the row and column coordinates of the current selection.
 RangeRef getSelection(int selection)
          Returns the row and column coordinates of a selected range.
 int getSelectionCount()
          Returns the number of selected ranges in the active worksheet.
 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 col.
 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.
 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.
 java.lang.String getTabbedText(int row1, int row2, int col1, int col2, boolean valuesOnly)
          Takes the specified range of data and converts it to a tab-delimited block of text.
 java.lang.String getText()
          Returns the text representation of the value of the active cell.
 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
 java.lang.String getTopLeftText()
          Returns the text displayed at the intersection of the row and column headings in the top left corner, affects all selected sheets.
 int getTopRow()
          Returns the top row displayed in the active worksheet.
 java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor dataflavor)
           
 java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()
           
 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.
static int getVersion()
          Returns the version of the component.
static java.lang.String getVersionString()
          Returns the version of the component in a string.
 int getViewScale()
          Returns the current display scale for a workbook.
 java.lang.String getWorkbookName()
          Returns the name assigned to the workbook associated with the current view control
 boolean hasFocus()
           
 boolean imageUpdate(java.awt.Image image, int i, int j, int k, int l, int i1)
           
 void init()
          Reads and acts on applet parameters.
 void initWorkbook()
           
 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 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 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 isAllowFillRange()
          Returns true if the user is allowed to fill a range by clicking and dragging with the mouse, false otherwise.
 boolean isAllowFormulas()
          Returns true if the user is allowed to enter and edit formulas, false otherwise.
 boolean isAllowInCellEditing()
          Returns true if cells are edited in place, false otherwise.
 boolean isAllowMoveRange()
          Returns true of the user is allowed to move a range by clicking and dragging with the mouse, false otherwise.
 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, false otherwise.
 boolean isAllowSelections()
          Returns true if the user is allowed to change the selection with the keyboard or mouse, false otherwise.
 boolean isAllowTabs()
          Returns true if the TAB key can be used to reposition the active cell in a selected range.
 boolean isApplet()
          Returns true if JXCell is being run as an applet.
 boolean isAutoRecalc()
          Returns whether or not automatic recalc is on.
 boolean isBorder()
          Returns whether or not a black border is painted around the workbook.
 boolean isCanEditPaste()
          Returns true if the internal clipboard or Windows' clipboard contains items that can be pasted to the worksheet.
 boolean isCanEditPasteSpecial()
          Returns true if the internal clipboard or Windows' clipboard contains items that can be pasted to the worksheet using the Paste Special command.
 boolean isCellMerge()
           
 boolean isCellMerge(int i, int j)
           
 boolean isCellMerge(TRange trange)
           
 boolean isColHeaderSelected()
          Returns true if the column headings are selected.
 boolean isColHidden(int col)
          Returns true if the column is hidden.
 boolean isCompressed()
          Returns true if a workbook is saved in a compressed format.
 boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor dataflavor)
           
static boolean isDebug()
           
 boolean isDefaultRowHeightAutomatic()
          Returns true if row height is automatic.
 boolean isEnableProtection()
          Returns true if protection is enabled for all sheets in a workbook.
 boolean isEnableProtection(int sheet)
          Returns true if protection is enabled for all sheets in a workbook.
 boolean isEnterMovesDown()
          Returns true if the enter key moves to the next cell.
 boolean isFormatPaintMode()
          Returns true if FormatPaint Mode is enabled.
 boolean isIterationEnabled()
          Returns true if iteration is enabled.
 boolean isLaunchWorkbookDesigner()
          Returns false.
 boolean isLogical()
          Returns the logical (True or False) value of the active cell.
 boolean isLogical(int row, int col)
          Returns the logical (True or False) value of the specified cell.
 boolean isLogical(int nSheet, int nRow, int nCol)
          Returns the logical (True or False) value of the specified cell.
 boolean isPrecisionAsDisplayed()
          Returns true if all cell values are rounded to the displayed precision, False otherwise.
 boolean isPrintColHeading()
          Returns True if column headings are enabled and printed at the top of the worksheet, False otherwise.
 boolean isPrintGridLines()
          Returns True if grid lines are printed for the current sheet, False otherwise
 boolean isPrintHCenter()
          Returns whether or not the current sheet centered horizontally when printed.
 boolean isPrintLandscape()
          Returns True if the workbook is printed with a landscape orientation, False otherwise.
 boolean isPrintLeftToRight()
          Returns whether the current sheet is printed left to right then top to bottom, or top to bottom then left to right.
 boolean isPrintNoColor()
          Returns True if all workbook colors are converted to black and white, and all patterns are removed, False otherwise.
 boolean isPrintRowHeading()
          Returns whether or not row headings are printed for the current sheet.
 boolean isPrintScaleFitToPage()
          Returns True if the workbook is printed on the number of vertical and horizontal pages returned by the setPrintScaleFitHPages method, returns False if the scale percentage returned is used to print the workbook.
 boolean isPrintVCenter()
          Returns True if the current sheet is centered vertically when printed, False otherwise.
 boolean isRepaint()
          Returns True if repainting occurs in the entire window when Windows sends a WM_PAINT message, False otherwise.
 boolean isRowHeaderSelected()
          Returns True if row headings are selected, False otherwise.
 boolean isRowHeightAutomatic(int row)
          Returns True if row height is automatic, False otherwise.
 boolean isRowHidden(int row)
          Returns True if row is hidden, False otherwise. .
 boolean isRowMode()
          Returns True if an entire row is selected when you select a cell, false otherwise.
 boolean isScrollToLastRC()
          Returns True if scroll bars can scroll the last filled cell in the workbook to the top-left edge of the window.
 boolean isSheetSelected(int sheet)
          Returns True if worksheet is selected, False otherwise.
 boolean isShowColHeading()
          Returns True if column headings are displayed, False otherwise.
 boolean isShowEditBar()
          Returns True if the edit bar is displayed with the workbook, False otherwise.
 boolean isShowEditBarCellRef()
          Returns True if isShowEditBar is True.
 boolean isShowFormulas()
          Returns True if formula text is displayed in cells instead of the values formulas produce, False otherwise.
 boolean isShowGridLines()
          Returns true if grid lines are shown, false otherwise.
 boolean isShowRowHeading()
          Returns true if row headings are shown, false otherwise.
 boolean isShowTypeMarkers()
          Returns True if the following frame types are used to identify different types of cells, False otherwise: Cell Type Frame Marker Empty cell None Blank formatted cell Blue frame Value cell (holds a number or text) Green frame Formula cell Red frame
 boolean isShowZeroValues()
          Returns True if cells with zero values are displayed, False, otherwise
 boolean isTopLeftHeaderSelected()
          Returns True if top left header is selected, False otherwise.
static boolean isTrace()
           
 void keyPressed(java.awt.event.KeyEvent keyevent)
           
 void keyReleased(java.awt.event.KeyEvent keyevent)
           
 void keyTyped(java.awt.event.KeyEvent keyevent)
           
 void launchDesigner()
          Displays the Workbook Designer.
 void lostOwnership(java.awt.datatransfer.Clipboard clipboard, java.awt.datatransfer.Transferable transferable)
           
 void mergeCell()
           
 int messageBox(java.lang.String message, java.lang.String caption, short type)
          Displays a message in a dialog box, waits for the user to click a button, and returns an Integer indicating which button the user clicked.
 void mouseClicked(java.awt.event.MouseEvent mouseevent)
           
 void mouseDragged(java.awt.event.MouseEvent mouseevent)
           
 void mouseEntered(java.awt.event.MouseEvent mouseevent)
           
 void mouseExited(java.awt.event.MouseEvent mouseevent)
           
 void mouseMoved(java.awt.event.MouseEvent mouseevent)
           
 void mousePressed(java.awt.event.MouseEvent mouseevent)
           
 void mouseReleased(java.awt.event.MouseEvent mouseevent)
           
 void moveRange(int row1, int col1, int row2, int col2, int rowOffset, int colOffset)
          Moves a range of cells.
 void objectBringToFront()
          Places the selected objects in front of all unselected objects in a view.
 short objectPosToTwips(double x1, double y1, double x2, double y2, java.awt.Rectangle rectangle)
          Given an object position in relation to rows and columns, this method returns the object position in twips.
 void objectSendToBack()
          Places the selected objects behind all unselected objects in a view.
 void paint(java.awt.Graphics g)
           
 short rangeToPixels(int row1, int col1, int row2, int col2, java.awt.Rectangle rectangle)
          Returns the offset, width, and height of the specified range in pixels.
 short rangeToTwips(int row1, int col1, int row2, int col2, java.awt.Rectangle rectangle)
          Determines the offset, width, and height of the specified range in twips.
 short read(java.io.InputStream inputstream)
          Reads a worksheet or workbook from disk
 short read(java.lang.String string)
          Reads a worksheet or workbook from disk.
 short readFromBlob(byte[] blob)
          Reads a worksheet or workbook that has been stored in memory in a byte array
 short readURL(java.lang.String spec)
          Loads a worksheet from a URL address.
 void recalc()
          Recalculates the workbook attached to a view.
 void releaseLock()
          Release a lock obtained by getLock().
 void removeCancelEditListener(CancelEditListener canceleditlistener)
          Removes the specified listener so it no longer receives events
 void removeColPageBreak(int col)
          Removes a a vertical page break adjacent to the left edge of the specified column.
 void removeEndEditListener(EndEditListener endeditlistener)
          Removes the specified listener so it no longer receives events
 void removeEndRecalcListener(EndRecalcListener endrecalclistener)
          Removes the specified listener so it no longer receives events
 void removeModifiedListener(ModifiedListener modifiedlistener)
          Removes the specified listener so it no longer receives events
 void removeObject(GRObject grobject)
          Removes the specified object.
 void removeObjectListener(ObjectListener objectlistener)
          Removes the specified listener so it no longer receives events
 void removePageBreak()
          Removes vertical and horizontal page breaks adjacent to the current cell.
 void removeRowPageBreak(int row)
          Removes a horizontal page break adjacent to the current cell
 void removeSelectionChangedListener(SelectionChangedListener selectionchangedlistener)
          Removes the specified listener so it no longer receives events
 void removeStartEditListener(StartEditListener starteditlistener)
          Removes the specified listener so it no longer receives events
 void removeStartRecalcListener(StartRecalcListener startrecalclistener)
          Removes the specified listener so it no longer receives events
 void removeUpdateListener(UpdateListener updatelistener)
          Removes the specified listener so it no longer receives events
 void removeValidationFailedListener(ValidationFailedListener validationfailedlistener)
          Removes the specified listener so it no longer receives events
 void removeViewChangedListener(ViewChangedListener viewchangedlistener)
          Removes the specified listener so it no longer receives events
 void repaint(DC dc, Rect rect)
           
 void repaint(long l, int i, int j, int k, int i1)
           
 boolean replace(java.lang.String findWhat, java.lang.String replaceWith, int flags, FindReplaceInfo findreplaceinfo)
          Invokes a find and replace session in a JXCell workbook and sets the criteria for the find and replace actions.
 void saveWindowInfo()
           
 void setActiveCell(int row, int col)
          Sets the row and column coordinates of the active cell The active cell is the cell in which the cursor is currently located.
 void setAllowArrows(boolean allowArrows)
          Sets a value indicating whether or not arrows keys can reposition the active cell.
 void setAllowAutoFill(boolean allowAutoFill)
          Sets a value indicating whether auto fill is enabled.
 void setAllowDelete(boolean allowDelete)
          Sets a value indicating whether the delete key clears selections.
 void setAllowDesigner(boolean allowDesigner)
          Sets whether the Workbook Designer can be launched at run time
 void setAllowEditHeaders(boolean allowEditHeaders)
          Sets a value indicating whether row, column, and top left headers can be edited.
 void setAllowFillRange(boolean allowFillRange)
          Sets the flag which determines whether users are allowed to fill a range by clicking and dragging with the mouse.
 void setAllowFormulas(boolean allowFormulas)
          Sets the flag which determines whether the user is allowed to enter and edit formulas.
 void setAllowInCellEditing(boolean allowInCellEditing)
          Sets the flag which determines whether cells are edited in place.
 void setAllowMoveRange(boolean allowMoveRange)
          Sets the flag which determines whether users are allowed to move a range by clicking and dragging with the mouse
 void setAllowObjectSelections(boolean allowObjectSelections)
          Sets a flag indicating whether you can select objects at run time.
 void setAllowResize(boolean allowResize)
          Sets a value indicating whether you can resize rows and columns by dragging them.
 void setAllowSelections(boolean allowSelections)
          Sets the flag which determines whether a user is allowed to change the selections with the keyboard or mouse.
 void setAllowTabs(boolean allowTabs)
          Sets a value indicating whether you can use the TAB key to reposition the active cell in a selected range.
 void setAutoFillItems(int index, java.lang.String items)
          Sets an autofill list.
 void setAutoRecalc(boolean autoRecalc)
          Sets the flag which determines whether or not automatic recalc is on.
 void setBackColor(java.awt.Color color)
          Sets the background color.
 void setBorder(boolean border)
          Sets wether the workbook has a border painted around it.
 void setCellFormat(CellFormat cellformat)
          Sets the format of the selected range of cells
 void setCellFormat(CellFormat cellformat, int row1, int col1, int row2, int col2)
          Sets the format of the specified range of cells Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.
 void setCellFormat(CellFormat cellformat, int sheet1, int row1, int col1, int sheet2, int row2, int col2)
          Sets the format of the specified range of cells in the specified range of sheets
 void setClip(java.lang.String text)
          Exports a tab-delimited text block to a worksheet at run time.
static void setClipboard(java.awt.datatransfer.Clipboard clipboard)
          Sets the clipboard to be used for clipboard operations.
 void setClipValues(java.lang.String text)
          Exports tab-delimited text strings to a workbook at run time ignoring any formatting applied to the text.
 void setCol(int col)
          Sets the column of the active cell.
 void setColHeaderSelected(boolean ColHeaderSelected)
          Sets a value indicating whether or not column headers can be selected.
 void setColHidden(int col, boolean colHidden)
          Sets a value indicating whether or not the specified column is hidden.
 void setColHidden(int col1, int col2, boolean colHidden)
          Sets the display status of the specified range of columns
 void setColText(int col, java.lang.String colText)
          Sets the label for a column.
 void setColWidth(int col, int width)
          Sets the width of a single column.
 void setColWidth(int col1, int col2, int width, boolean defColWidth)
          Sets the width of a single column.
 void setColWidthAuto(int row1, int col1, int row2, int col2, boolean setDefaults)
          Sets the widths of the specified columns to automatically adjust to the largest column entry, including the header.
 void setColWidthTwips(int col1, int width)
          Changes the width of one or more columns to the specified number of twips.
 void setColWidthTwips(int col1, int col2, int width, boolean defColWidth)
          Changes the width of one or more columns to the specified number of twips.
 void setColWidthUnits(short colWidthUnits)
          Sets how the column width is stored and displayed.
 void setCompressed(boolean compressed)
          Sets whether a workbook is saved in compressed format.
 void setDefaultColWidth(int width)
          Sets the default column width.
 void setDefaultFont(java.lang.String fontName, int fontSize)
          Sets the default font and the font size.
 void setDefaultFontName(java.lang.String fontName)
          Sets the default font by name.
 void setDefaultFontSize(int fontSize)
          Sets the default font size.
 void setDefaultRowHeight(int height)
          Sets the default row height.
 void setDefaultRowHeightAutomatic(boolean automatic)
          Sets whether the default row height is determined automatically.
 void setDefinedName(java.lang.String name, java.lang.String formula)
          Sets the formula associated with a defined name, in US English.
 void setDefinedNameLocal(java.lang.String name, java.lang.String formula)
          Sets the formula definition for a user-defined name, in the user's language.
 void setEnableProtection(boolean enableProtection)
          Sets whether protection is enabled for all selected sheets.
 void setEnterMovesDown(boolean enterMovesDown)
          Sets whether pressing the ENTER key moves the active cell down to the next cell.
 void setEntry(int sheet, int row, int col, java.lang.String entry)
          Sets the value of a specified cell on the specified worksheet This method allows you to enter information in a cell just as a user would enter information.
 void setEntry(int row, int col, java.lang.String entry)
          Sets the value of a specified cell of all selected worksheets.
 void setEntry(java.lang.String entry)
          Enters text in the active cell of all selected worksheets.
 void setExtraColor(java.awt.Color extraColor)
          Sets the color used to fill any extra space to the right and below the sheet.
 void setFileName(java.lang.String fileName)
          Attaches a worksheet or workbook file to a view.
 void setFixedCol(int col)
          Sets the number of fixed columns.
 void setFixedCols(int cols)
          Sets the number of fixed columns.
 void setFixedCols(int nCol1, int nCols)
          Sets the number of fixed columns.
 void setFixedRow(int row)
          Sets the starting fixed row.
 void setFixedRows(int rows)
          Sets the number of fixed rows.
 void setFixedRows(int nRow1, int nRows)
          Sets the number of fixed rows.
 void setFormatPaintMode(boolean isFormatPaintMode)
          Sets the Format Paint Mode.
 void setFormula(int sheet, int row, int col, java.lang.String formula)
          Sets the formula for the specified cell on the specified sheet.
 void setFormula(int row, int col, java.lang.String formula)
          Sets the formula for the specified cell in all selected sheets.
 void setFormula(java.lang.String formula)
          Sets the formula for the active cell for all selected sheets.
 void setFormulaLocal(int sheet, int row, int col, java.lang.String formula)
          Sets the text version of the formula of the specified cell in the specified worksheet in the user's language.
 void setFormulaLocal(int row, int col, java.lang.String formula)
          Sets the text version of the formula of the specified cell, in the user's language.
 void setFormulaLocal(java.lang.String formula)
          Sets the text version of the formula in the active cell, in the user's language.
 void setGroup(java.lang.String group)
          Sets the group name for the workbook attached to this view.
 void setHeaderHeight(int height)
          Sets the height of the column headers on all selected sheets.
 void setHeaderSelection(boolean topLeftHeader, boolean rowHeader, boolean colHeader)
          Sets whether the row and column headings are selected.
 void setHeaderWidth(int width)
          Sets the width of the row headers of all selected sheets.
 void setIterationEnabled(boolean iterationEnabled)
          Sets whether iteration is enabled.
 void setIterationMax(int iterationMax)
          Sets the maximum number of iterations.
 void setIterationMaxChange(double iterationMaxChange)
          Sets the maximum iteration change value.
 void setLaunchWorkbookDesigner(boolean launchWorkbookDesigner)
          Brings up the Workbook Designer.
 void setLeftCol(int leftCol)
          Sets the leftmost column currently displayed in the view.
 void setLogical(boolean logical)
          Sets the logical (True or False) value of the active cell in all selected worksheets.
 void setLogical(int row, int col, boolean logical)
          Sets the logical (True or False) value of the specified cell in all selected worksheets.
 void setLogical(int sheet, int row, int col, boolean logical)
          Sets the logical (True or False) value of the specified cell in the specified worksheet.
 void setMaxCol(int maxCol)
          Sets the maximum column which may be displayed in the current sheet.
 void setMaxRow(int maxRow)
          Sets the maximum row which may be displayed in the current sheet.
 void setMinCol(int minCol)
          Sets the first column that can be displayed in the current worksheet.
 void setMinRow(int minRow)
          Sets the first row that can be displayed in the current worksheet.
 void setMode(short mode)
          Sets the current mode for mouse actions in a view
 void setNumber(double number)
          Sets the numeric value of the active cell in all selected sheets.
 void setNumber(int row, int col, double number)
          Sets the numeric value of the specified cell in all selected sheets.
 void setNumber(int sheet, int row, int col, double number)
          Sets the numeric value of the specified cell in the specified worksheet.
 void setNumSheets(int sheets)
          Sets the number of worksheets in the current workbook.
 void setPaletteEntry(int entry, java.awt.Color color)
          Sets a color in the JXCell color palette.
 void setParentFrame(java.awt.Frame frame)
          Sets the window to display JXCell in.
 void setPolyEditMode(short polyEditMode)
          Sets the mode for interactive polygon editing.
 void setPrecisionAsDisplayed(boolean precisionAsDisplayed)
          Determines whether cell values are stored as entered or as displayed
 void setPrintArea()
          Sets the current print area.
 void setPrintArea(java.lang.String formula)
          Sets the current print area to the specified range.
 void setPrintBottomMargin(double printBottomMargin)
          Sets the bottom print margin.
 void setPrintColHeading(boolean printColHeading)
          Determines whether column headings are printed.
 void setPrintFooter(java.lang.String printFooter)
          Sets the current page footer The following list shows the special codes the footer text can contain.
 void setPrintFooterMargin(double printFooterMagrin)
          Sets the page footer margin used during printing The header and footer margins can be printed.
 void setPrintGridLines(boolean printGridLines)
          Sets the flag which determines whether or not grid lines are printed for the current sheet.
 void setPrintHCenter(boolean printHCenter)
          Sets the flag which determines whether or not the current sheet is centered horizontally when printed.
 void setPrintHeader(java.lang.String printHeader)
          Sets the page header printed at the top of each page The following list shows the special codes the footer text can contain.
 void setPrintHeaderMargin(double printHeaderMargin)
          Sets the page header margin used during printing The header and footer margins can be printed.
 void setPrintLandscape(boolean printLandscape)
          Determines the direction of the print job.
 void setPrintLeftMargin(double printLeftMargin)
          Sets the left print margin.
 void setPrintLeftToRight(boolean printLeftToRight)
          Sets the flag which determines whether the current sheet is to be printed left to right then top to bottom, or top to bottom then left to right.
 void setPrintNoColor(boolean printNoColor)
          Determines whether job is printed in color or black and white Color formats are translated by the printer driver and printed as patterns.
 void setPrintRightMargin(double printRightMargin)
          Sets the right print margin.
 void setPrintRowHeading(boolean printRowHeading)
          Sets the flag which determines whether or not row headings are printed for the current sheet.
 void setPrintScale(int scale)
          Sets the scale factor for the active worksheet To print a worksheet at the largest scale possible, set this value to 400 and setPrintScaleToFitPage to True.Then, specify the number of pages on which you want the worksheet printed.
 void setPrintScale(int scale, boolean fitToPage, int verticalPages, int horizontalPages)
          Sets the scale factor for the active worksheet
 void setPrintScaleFitHPages(int horizontalPages)
          Sets the number of horizontal pages to which the print job is fit This value has no effect if setPrintScaleFitToPage is False.
 void setPrintScaleFitToPage(boolean fitToPage)
          Sets sets whether pages are scaled to fit the specified number of pages when printed.
 void setPrintScaleFitVPages(int verticalPages)
          Sets the number of vertical pages to which the print job is fit.
 void setPrintTitles()
          Sets the current selection to be the print titles to be printed at the top of each page Print titles are row and column titles that are printed on each page.
 void setPrintTitles(java.lang.String formula)
          Sets the print titles to be printed at the top of each page
 void setPrintTopMargin(double printTopMargin)
          Sets the top print margin.
 void setPrintVCenter(boolean printVCenter)
          Sets the flag which determines whether or not the current sheet is centered verticall when printed.
 void setRepaint(boolean repaint)
          Sets the flag which determines whether or not this view is painted.
 void setRow(int row)
          Sets the row of the active cell.
 void setRowHeaderSelected(boolean rowHeaderSelected)
          Determines if the row header is selected.
 void setRowHeight(int row, int height)
          Sets the height of a single specified row.
 void setRowHeight(int row1, int row2, int height, boolean defRowHeight, boolean automatic)
          Sets the height of a range of rows.
 void setRowHeightAuto(int row1, int col1, int row2, int col2, boolean setDefaults)
          Specifies that the heights of the rows in the specified range are automatically set to display the tallest entry in the specified rows.
 void setRowHeightAutomatic(int row, boolean automatic)
          Specifies that the heights of the specified row is automatically set to display the tallest entry in the row.
 void setRowHidden(int row, boolean rowHidden)
          Changes the display status of the specified row.
 void setRowHidden(int row1, int row2, boolean rowHidden)
          Changes the display status of the specified rows.
 void setRowMode(boolean rowMode)
          Sets the row mode status for a view.
 void setRowText(int row, java.lang.String rowText)
          Sets the name for the specified row.
 void setScrollToLastRC(boolean scrollToLastRC)
          Sets how scrollbars work.
 void setSelection(GRObject grobject)
          Selects a graphical object on the worksheet
 void setSelection(int row1, int col1, int row2, int col2)
          Selects the range represented by the specified parameters and moves the active cell to the top left cell in the range.
 void setSelectionLocal(java.lang.String string)
          Selects the range represented by the specified formula and moves the active cell to the top left cell in the range.
 void setSelEndCol(int selEndCol)
          Sets the last selected column.
 void setSelEndRow(int selEndRow)
          Sets the last selected row.
 void setSelStartCol(int selStartCol)
          Sets the first selected column.
 void setSelStartRow(int selStartRow)
          Sets the first selected row.
 void setSheet(int sheet)
          Sets the active worksheet.
 void setSheetName(int sheet, java.lang.String sheetName)
          Assigns a name to the specified worksheet .
 void setSheetSelected(int sheet, boolean selected)
          Sets which sheet is selected.
 void setShowColHeading(boolean showColHeadings)
          Sets whether column headings are displayed
 void setShowEditBar(boolean showEditBar)
          Sets whether the edit bar is displayed.
 void setShowEditBarCellRef(boolean showEditBarCellRef)
          Sets whether the reference of the active cell appears with the edit bar.
 void setShowFormulas(boolean showFormulas)
          Sets whether formulas are displayed in place of cell values
 void setShowGridLines(boolean showGridLines)
          Sets whether grid lines are displayed.
 void setShowHScrollBar(short showHScrollBar)
          Sets the mode for the horizontal scroll bar
 void setShowRowHeading(boolean showRowHeading)
          Sets the flag which determines whether row headings are shown.
 void setShowSelections(short showSelections)
          Sets the mode for highlighting selections.
 void setShowTabs(short showTabs)
          Sets the display status and position of the sheet name tabs on a workbook.
 void setShowTypeMarkers(boolean showTypeMarkers)
          Sets whether frames are displayed around cells to identify the cell types.
 void setShowVScrollBar(short showVScrollBar)
          Sets the mode for the vertical scroll bar.
 void setShowZeroValues(boolean showZeroValues)
          Sets or returns whether zero value cells are displayed.
 RangeRef setTabbedText(int row1, int col1, boolean valuesOnly, java.lang.String text)
          Places a block of tab-delimited text in a workbook.
 void setText(int sheet, int row, int Col, java.lang.String text)
          Sets the value of the specified cell in the specified sheet.
 void setText(int row, int Col, java.lang.String text)
          Sets the value of the active cell for all selected sheets.
 void setText(java.lang.String text)
          Sets the value of the active cell for all selected sheets.
 void setTopLeftHeaderSelected(boolean topLeftHeaderSelected)
          Sets whether the top left header is selected.
 void setTopLeftText(java.lang.String topLeftText)
          Sets the text displayed at the intersection of the row and column headings in the top left corner of all selected sheets.
 void setTopRow(int leftRow)
          Sets the first row to display in this view.
 void setViewScale(int scale)
          Sets the current display scale for a workbook
 void setWorkbookName(java.lang.String workbookName)
          Sets the name assigned to the workbook associated with the current view.
 void showActiveCell()
          Positions the view to show the active cell if it is not currently displayed in the window.
 void showError(java.lang.String errorMsg)
          Displays an error message in a message box
 void showError(java.lang.Throwable throwable)
          Displays an error message in a message box
 void sort(int row1, int col1, int row2, int col2, boolean sortByRows, int[] keys)
          Specifies a range of data to be sorted and the keys by which to sort the data.
 void sort3(int row1, int col1, int row2, int col2, boolean sortByRows, int keys, int key2, int key3)
          Specifies a range of data to be sorted and as many as three keys by which to sort the data.
 void startEdit(boolean clear, boolean inCellEditFocus, boolean arrowsExitEditMode)
          Begins edit mode for the active cell.
 void swapWorkbooks(View f1ToSwapWith)
          Exchanges the workbooks attached to two views.
static void TRACE(java.lang.String s)
           
 void transactCommit()
          Commits changes made during a transaction.
 void transactRollback()
          Undoes all changes made to a table since the last TransactStart method was called.
 void transactStart()
          Starts a transaction.
 int twipsToCharWidth(int nTwips)
          Converts twips (1/1440th of an inch) to character width based units.
 CellRef twipsToRC(int x, int y)
          Converts a point in a worksheet, as specified by a set of coordinates, to the corresponding row and column at which the point is located.
 void unMergeCell()
           
 void update()
          Updates all workbooks.
 void update(java.awt.Graphics g)
           
static void Verify(boolean flag)
           
 void write(java.io.OutputStream outputstream, int sheet1, int row1, int col1, int sheet2, int row2, int col2, short fileType)
          Writes a range of data to the specified output stream.
 void write(java.io.OutputStream outputstream, short fileType)
          Saves the workbook to the specified output stream.
 void write(java.lang.String s, int sheet1, int row1, int col1, int sheet, int row2, int col2, short fileType)
          Writes specified portion of the workbook to a file.
 void write(java.lang.String pathName, short fileType)
          Saves the workbook to a file.
 byte[] writeToBlob()
          Writes the workbook to a blob.
 boolean writeURL(java.lang.String s1, int i1, java.lang.String s2, java.lang.String s3, short word0)
           
 boolean writeURL(java.lang.String s1, short word0)
           
 boolean writeURL(java.net.URL url, short word0)
           
 
Methods inherited from class java.applet.Applet
getAccessibleContext, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus, start, stop
 
Methods inherited from class java.awt.Panel
addNotify
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

setResizableAfterAddNotify

public static int setResizableAfterAddNotify

scWindow

public static java.awt.Color scWindow

scWindowText

public static java.awt.Color scWindowText

scControl

public static java.awt.Color scControl

scControlText

public static java.awt.Color scControlText

scText

public static java.awt.Color scText

scTextText

public static java.awt.Color scTextText

scControlHighlight

public static java.awt.Color scControlHighlight

scControlLtHighlight

public static java.awt.Color scControlLtHighlight

scControlShadow

public static java.awt.Color scControlShadow

scControlDkShadow

public static java.awt.Color scControlDkShadow

OK

public static final short OK
See Also:
Constant Field Values

CANCEL

public static final short CANCEL
Specifies a CANCEL button

See Also:
Constant Field Values

YES

public static final short YES
Specifies a YES button

See Also:
Constant Field Values

NO

public static final short NO
Specifies a NO button

See Also:
Constant Field Values

eClearDlg

public static final short eClearDlg
Displays the Clear dialog box

See Also:
Constant Field Values

eClearFormats

public static final short eClearFormats
Clears formats only

See Also:
Constant Field Values

eClearValues

public static final short eClearValues
Clears values only, including formats

See Also:
Constant Field Values

eClearAll

public static final short eClearAll
Clears values, formats, and objects

See Also:
Constant Field Values

eColWidthUnitsNormal

public static final short eColWidthUnitsNormal
Column width in characters

See Also:
Constant Field Values

eColWidthUnitsTwips

public static final short eColWidthUnitsTwips
Column width in twips

See Also:
Constant Field Values

eCopyFormulas

public static final short eCopyFormulas
Copies formulas

See Also:
Constant Field Values

eCopyValues

public static final short eCopyValues
Copies values

See Also:
Constant Field Values

eCopyFormats

public static final short eCopyFormats
Copies formats

See Also:
Constant Field Values

eCopyAll

public static final short eCopyAll
Copies formats, values, and formulas

See Also:
Constant Field Values

eFileTabbedText

public static final short eFileTabbedText
Tab-delimited text

See Also:
Constant Field Values

eFileExcel

public static final short eFileExcel
Excel 97 format

See Also:
Constant Field Values

eFileJXCell

public static final short eFileJXCell
JXCell format

See Also:
Constant Field Values

eFileTabbedTextValuesOnly

public static final short eFileTabbedTextValuesOnly
Tab-delimited text files values only

See Also:
Constant Field Values

eFileCurrentFormat

public static final short eFileCurrentFormat
JXCell version

See Also:
Constant Field Values

eModeNormal

public static final short eModeNormal
Normal worksheet editing

See Also:
Constant Field Values

eModeLine

public static final short eModeLine
Line drawing

See Also:
Constant Field Values

eModeRectangle

public static final short eModeRectangle
Rectangle drawing

See Also:
Constant Field Values

eModeOval

public static final short eModeOval
Oval drawing

See Also:
Constant Field Values

eModeArc

public static final short eModeArc
Arc drawing

See Also:
Constant Field Values

eModeText

public static final short eModeText
Field drawing

See Also:
Constant Field Values

eModeButton

public static final short eModeButton
Button drawing

See Also:
Constant Field Values

eModePicture

public static final short eModePicture
Button drawing

See Also:
Constant Field Values

eModePolygon

public static final short eModePolygon
Polygon drawing

See Also:
Constant Field Values

eModeDropDown

public static final short eModeDropDown
Drop-down list drawing

See Also:
Constant Field Values

eModeCheckBox

public static final short eModeCheckBox
Checkbox drawing

See Also:
Constant Field Values

eModeChart

public static final short eModeChart
Chart drawing

See Also:
Constant Field Values

ePolyEditModeNormal

public static final short ePolyEditModeNormal
Edits a polygon bounding box

See Also:
Constant Field Values

ePolyEditModePoints

public static final short ePolyEditModePoints
Eidts polygon points

See Also:
Constant Field Values

eShiftHorizontal

public static final short eShiftHorizontal
Cells to the right of the range are shifted left to fill the vacated space

See Also:
Constant Field Values

eShiftVertical

public static final short eShiftVertical
Cells below the range are shifted up to fill the vacated space

See Also:
Constant Field Values

eShiftRows

public static final short eShiftRows
Rows in which the range resieds are deleted and lower rows are shifted up to fill the vacated space

See Also:
Constant Field Values

eShiftColumns

public static final short eShiftColumns
Columns in which the range resdies are deleted and the rightmost columns are shifted left to fill the vacated space

See Also:
Constant Field Values

eShowOff

public static final short eShowOff
Selections or scrollbars are hidden

See Also:
Constant Field Values

eShowOn

public static final short eShowOn
Selections or scrollbars are displayed

See Also:
Constant Field Values

eShowAutomatic

public static final short eShowAutomatic
Displayed if workbook or control is active

See Also:
Constant Field Values

eTabsOff

public static final short eTabsOff
Tabs do not appear on worksheets

See Also:
Constant Field Values

eTabsBottom

public static final short eTabsBottom
Tabs appear at the bottom of worksheets

See Also:
Constant Field Values

eTabsTop

public static final short eTabsTop
Tabs appear at the top of worksheets

See Also:
Constant Field Values

eTypeEmpty

public static final short eTypeEmpty
Indicates an empty cell

See Also:
Constant Field Values

eTypeNumber

public static final short eTypeNumber
Indicates a number cell

See Also:
Constant Field Values

eTypeText

public static final short eTypeText
Indicates a text cell

See Also:
Constant Field Values

eTypeLogical

public static final short eTypeLogical
Indicates a logical cell

See Also:
Constant Field Values

eTypeError

public static final short eTypeError
Indicates the cell contains an error

See Also:
Constant Field Values

kMaxSheets

public static int kMaxSheets
The maximum number of sheets


kMaxRows

public static int kMaxRows
The maximum number of rows


kMaxCols

public static int kMaxCols
The maximum number of columns


SLASH

public static final char[] SLASH
A constant to represent the / character

Constructor Detail

View

public View()
This constructor calls the other View constructor with a null View reference to create a new workbook.


View

public View(View view)
If the View argument is null, this constructor creates a new workbook, or if the View argument is not null, this constructor attaches to the specified view's workbook.

Method Detail

addCancelEditListener

public void addCancelEditListener(CancelEditListener canceleditlistener)
Adds the specified listener to receive CancelEdit events

Parameters:
canceleditlistener - - the CancelEdit listener to be added

addColPageBreak

public void addColPageBreak(int i)
                     throws CellException
Adds a vertical page break to the left edge of the specified column

Parameters:
i - - indicates the column where the page break is added
Throws:
CellException - if argument is invalid

addEndEditListener

public void addEndEditListener(EndEditListener endeditlistener)
Adds the specified listener to receive EndEdit events

Parameters:
endeditlistener - - the EndEdit listener to be added

addEndRecalcListener

public void addEndRecalcListener(EndRecalcListener endrecalclistener)
Adds the specified listener to receive EndRecalc events

Parameters:
endrecalclistener - - the EndRecalc listener to be added

addModifiedListener

public void addModifiedListener(ModifiedListener modifiedlistener)
Adds the specified listener to receive Modified events

Parameters:
modifiedlistener - - the Modified listener to be added

addObject

public GRObject addObject(short objectType,
                          double x1,
                          double y1,
                          double x2,
                          double y2)
                   throws CellException
Creates and adds an object to the active worksheet

Parameters:
objectType - - identifies the type of object to be created
x1 - - coordinate of the first anchor point of the object. x1 is measured in columns from the left edge of the worksheet.
y1 - - coordinate of the first anchor point of the object. y1 is measured in rows from the top edge of the worksheet.
x2 - - coordinate of the second anchor point. x2 is measured in columns from the left edge of the worksheet
y2 - - coordinate of the second anchor point. y2 is measured in rows from the top edge of the worksheet.
Returns:
an object
Throws:
CellException - if a parameter is invalid

addObjectListener

public void addObjectListener(ObjectListener objectlistener)
Adds the specified listener to receive Object events

Parameters:
objectlistener - - the Object listener to be added

addPageBreak

public void addPageBreak()
                  throws CellException
Adds a horizontal and vertical page break adjacent to the active cell

The horizontal page break is added at the cell's top edge; the vertical page break is added at the cell's left edge.

Throws:
CellException - if the current selection is invalid

addPicture

public GRObject addPicture(double x1,
                           double y1,
                           double x2,
                           double y2,
                           byte[] imageData)
                    throws CellException
Adds picture object to the worksheet

Parameters:
x1 - - double that is the first of two coordinates that represent the first anchor point of the object. X1 is measured in columns from the left edge of the worksheet
y1 - - double that is the second of two coordinates that represent the first anchor point of the object. nY1 is measured in rows from the top edge of the worksheet.
x2 - - double that is the first of two coordinates that represent the second anchor point of the object. x2 is measured in columns from the left edge of the worksheet.
y2 - - double that is the second of two coordinates that represent the second anchor point of the object. y2 is measured in rows from the top edge of the worksheet.
imageData - - an array of data describing the picture. try { // Add a URL based picture (the picture is not stored in the // vts file. Only the reference to the picture is stored. m_f1.addPicture(1.1, 1.1, 3.9, 14.9, new java.net.URL("http://CNNSI.com/basketball/ college/news/1998.03/01/kansas oklast/t1 lafrents ap.jpg")); }
Returns:
an object
Throws:
CellException - if a parameter is invalid

addPicture

public GRObject addPicture(double x1,
                           double y1,
                           double x2,
                           double y2,
                           java.net.URL url)
                    throws CellException
Adds picture object to the worksheet

Parameters:
x1 - - double that is the first of two coordinates that represent the first anchor point of the object. X1 is measured in columns from the left edge of the worksheet
y1 - - double that is the second of two coordinates that represent the first anchor point of the object. nY1 is measured in rows from the top edge of the worksheet.
x2 - - double that is the first of two coordinates that represent the second anchor point of the object. x2 is measured in columns from the left edge of the worksheet.
y2 - - double that is the second of two coordinates that represent the second anchor point of the object. y2 is measured in rows from the top edge of the worksheet.
url - a java.net.URL object that poins to a jpeg or gif picture. try { // Now create a data based picture. First we need to // get the data into a byte array. java.net.URL url = new java.net.URL("http://CNNSI.com/basketball/college/ news/1998/03/01/kansas_oklast/t1_lafrentz_ap.jpg"); java.io.InputStream is = url.openStream(); if (is != null) { java.io.ByteArrayOutputStream os = new java.io.ByteArrayOutputStream(256); byte buf[] = new byte[256]; while (true) { int bytes = is.read(buf); if (bytes < 0) break; if (bytes > 0) os.write(buf, 0, bytes); } m_f1.addPicture(4.1, 1.1, 6.9, 14.9, * os.toByteArray()); os.close(); is.close(); } } catch (Throwable e) { System.out.println("got exception trying to add * picture e=" + e); }
Returns:
an object
Throws:
CellException - if a parameter is invalid

addPolygon

public GRObject addPolygon(double x1,
                           double y1,
                           double x2,
                           double y2,
                           java.awt.Point[] apoint,
                           boolean closed)
                    throws CellException
Creates and adds a polygon to a view, and specifieds the placement of points in the polygon.

Parameters:
x1 - - coordinate of the first anchor point of the object; measured in columns from the left edge of the worksheet
y1 - - coordinate of the first anchor point of the object; measured in rows from the top edge of the worksheet
x2 - - coordinate of the second anchor point; measured in columns from the left edge of the worksheet
y2 - - coordinate of the second anchor point; measured in rows from the top edge of the worksheet
apoint - - An array for the x and y points on the polygon, which can have as few as 2 points and as many a 4096.
closed - - Sets the polygon closed flag. If the flag is True, the polygon is closed and can be filled.
Returns:
a polygon object
Throws:
CellException - if a parameter is invalid

addRowPageBreak

public void addRowPageBreak(int row)
                     throws CellException
Adds a horizontal page break adjacent to the top edge of the specified row

Parameters:
row - - integer indicating the row where the page break is to be added
Throws:
CellException - if a parameter is invalid

addSelection

public void addSelection(int row1,
                         int col1,
                         int row2,
                         int col2)
                  throws CellException
Adds a new selection to the current selection list Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
row1 - - the beginning row coordinate of the selection to add to the selection list.
col1 - - the beginning column coordinate of the selection.
row2 - - the ending row coordinate
col2 - - the ending column coordinate
Throws:
CellException - if a parameter is invalid

addSelection

public void addSelection(GRObject grobject)
Selects an additional object. All previously selected objects remain selected.

Parameters:
grobject - - the object to be added to the selection list

addSelectionChangedListener

public void addSelectionChangedListener(SelectionChangedListener selectionchangedlistener)
Adds the specified listener to receive SelectionChanged events

Parameters:
selectionchangedlistener - - the SelectionChanged listener to be added

addStartEditListener

public void addStartEditListener(StartEditListener starteditlistener)
Adds the specified listener to receive StartEdit events

Parameters:
starteditlistener - - the StartEdit listener to be added

addStartRecalcListener

public void addStartRecalcListener(StartRecalcListener startrecalclistener)
Adds the specified listener to receive StartRecalc events

Parameters:
startrecalclistener - - the StartRecalc listener to be added

addUpdateListener

public void addUpdateListener(UpdateListener updatelistener)
Adds the specified listener to receive Update events

Parameters:
updatelistener - - the Update listener to be added

addValidationFailedListener

public void addValidationFailedListener(ValidationFailedListener validationfailedlistener)
Adds the specified listener to receive ValidationFailed events

Parameters:
validationfailedlistener - - the ValidationFailed listener to be added

addViewChangedListener

public void addViewChangedListener(ViewChangedListener viewchangedlistener)
Adds the specified listener to receive ViewChanged events

Parameters:
viewchangedlistener - - the ViewChanged listener to be added

attach

public void attach(java.lang.String workbookName)
            throws CellException
Searches for a workbook with the specified name, and attaches the current view to it. This method starts with a default view using only the data from the specified workbook. Settings specified in the workbook are not applied to the current view. NOTE: Both workbooks must be in the same group.

Parameters:
workbookName - - the name of the workbook
Throws:
CellException - if the workbook cannot be located

attach

public void attach(View view)
Attaches the current view to the specified view's workbook, using the display properties of the specified view's workbook. Any display properties set thereafter, in the workbook, are not propagated between the views.

Parameters:
view - - the view from which to get the workbook to attach to

cancelEdit

public void cancelEdit()
Aborts edit mode and leaves the current cell unchanged


charWidthToTwips

public int charWidthToTwips(int nCharWidth)
                     throws CellException
Converts column widths to units equal to 1/256th of the character 0's width in the default font. This is the default column width unit.

Parameters:
nCharWidth - - the column width in characters
Returns:
the column width in twips
Throws:
CellException - if this view is not visible or a parameter is invalid

checkRecalc

public void checkRecalc()
Recalculates the worksheet if needed


childIsActive

public void childIsActive()
Informs the View that a child of the view is or soon will be active. A one shot flag is set which keeps the View from removing scrollbars and selection highlighting if they are set to eShowAutomatic. This flag is turned off the next time the view receives a focusGained() event. This should be used primarily by dialog boxes or other popup windows which are "logical children" of the View, even though they may not be literal child windows of the View.


clearRange

public void clearRange(int row1,
                       int col1,
                       int row2,
                       int col2,
                       short clearType)
                throws CellException
Clears the specified range Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
row1 - - Coordinate specifying the beginning row of the range.
col1 - - Coordinate specifying the beginning column of the range.
row2 - - Coordinate specifying the ending row of the range
col2 - - Coordinate specifying the ending column of the range
clearType - - Determines what is cleared, as follows: eClearFormats = 1 clears formats only eClearValues = 2 clears values only (including formulas) eClearAll = 3 clears values, formats, and objects
Throws:
CellException - if an invalid clearType value is specified

copyAll

public void copyAll(View view)
             throws CellException
Copies the contents of one workbook to another workbook Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
view - - a handle to the source view
Throws:
CellException - if an error occurs

copyDataFromArray

public void copyDataFromArray(int sheet,
                              int row1,
                              int col1,
                              int row2,
                              int col2,
                              double[][] data)
                       throws CellException
Copies data from an array into a sheet The array and the sheet do not have to be the same size. Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
sheet - - the sheet number
row1 - - the coordinate specifying the beginning row to copy to
col1 - - the coordinate specifying the beginning column to copy to
row2 - - the coordinate of the ending row
col2 - - the coordinate of the ending column
data - - a 2-dimensional array
Throws:
CellException - if an error occurs

copyDataToArray

public void copyDataToArray(int sheet,
                            int row1,
                            int col1,
                            int row2,
                            int col2,
                            double[][] data)
                     throws CellException
Copies data from the sheet into an array The array and the sheet do not have to be the same size. Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
sheet - - the sheet number
row1 - - the coordinate specifying the beginning row to copy to
col1 - - the coordinate specifying the beginning column to copy to
row2 - - the coordinate of the ending row
col2 - - the coordinate of the ending column
data - - a 2-dimensional array
Throws:
CellException - if an error occurs

copyRange

public void copyRange(int dstRow1,
                      int dstCol1,
                      int dstRow2,
                      int dstCol2,
                      View srcView,
                      int srcRow1,
                      int srcCol1,
                      int srcRow2,
                      int srcCol2)
               throws CellException
Copies a range of cells to a new location in the current workbook The source range can be in a different workbook. Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
dstRow1 - - the first row in the destination range
dstCol1 - - the first column in the destination range
dstRow2 - - the ending row in the destination range
dstCol2 - - the ending column in the destination range
srcView - - the handle to the source view
srcRow1 - - the first row in the source range
srcCol1 - - the first column in the source range
srcRow2 - - the ending row in the source range
srcCol2 - - the ending column in the source range
Throws:
CellException - if a parameter is invalid

copyRange

public void copyRange(int dstRow1,
                      int dstCol1,
                      int dstRow2,
                      int dstCol2,
                      View srcView,
                      int srcRow1,
                      int srcCol1,
                      int srcRow2,
                      int srcCol2,
                      short what)
               throws CellException
Copies a range of cells to a new location in the current workbook The source range can be in a different workbook. This method allows you to choose the type of data to copy: formulas only, values only, formats only, any combination of the previous types, or all of the types. Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
dstRow1 - - the first row in the destination range
dstCol1 - - the first column in the destination range
dstRow2 - - the ending row in the destination range
dstCol2 - - the ending column in the destination range
srcView - - the handle to the source view
srcRow1 - - the first row in the source range
srcCol1 - - the first column in the source range
srcRow2 - - the ending row in the source range
srcCol2 - - the ending column in the source range
what - - the type of copy operation, using one or more of the following constants: eCopyFormulas = 1 eCopyValues = 2 eCopyFormats = 4 eCopyAll = 7
Throws:
CellException - if a parameter is invalid

copyRange

public void copyRange(int dstSheet,
                      int dstRow1,
                      int dstCol1,
                      int dstRow2,
                      int dstCol2,
                      View srcView,
                      int srcSheet,
                      int srcRow1,
                      int srcCol1,
                      int srcRow2,
                      int srcCol2)
               throws CellException
Copies a range of cells to a new location in the current workbook Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
dstSheet - - an index identifying the destination worksheet. Do not confuse the index with the sheet name appearing on the sheet tab.
dstRow1 - - the first row in the destination range
dstCol1 - - the first column in the destination range
dstRow2 - - the ending row in the destination range
dstCol2 - - the ending column in the destination range
srcView - - the handle to the source view
srcSheet - - an index identifying the worksheet in the source view.
srcRow1 - - the first row in the source range
srcCol1 - - the first column in the source range
srcRow2 - - the ending row in the source range
srcCol2 - - the ending column in the source range
Throws:
CellException - if a parameter is invalid

copyRange

public void copyRange(int dstSheet,
                      int dstRow1,
                      int dstCol1,
                      int dstRow2,
                      int dstCol2,
                      View srcView,
                      int srcSheet,
                      int srcRow1,
                      int srcCol1,
                      int srcRow2,
                      int srcCol2,
                      short what)
               throws CellException
Copies a range of cells to a new location in the current workbook This method allows you to choose the type of data to copy: formulas only, values only, formats only, any combination of the previous types, or all of the types. Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
dstSheet - - an index identifying the destination worksheet. Do not confuse the index with the sheet name appearing on the sheet tab.
dstRow1 - - the first row in the destination range
dstCol1 - - the first column in the destination range
dstRow2 - - the ending row in the destination range
dstCol2 - - the ending column in the destination range
srcView - - the handle to the source view
srcSheet - - an index identifying the worksheet in the source view.
srcRow1 - - the first row in the source range
srcCol1 - - the first column in the source range
srcRow2 - - the ending row in the source range
srcCol2 - - the ending column in the source range
what - - the type of copy operation, using one or more of the following constants: eCopyFormulas = 1 eCopyValues = 2 eCopyFormats = 4 eCopyAll = 7
Throws:
CellException - if a parameter is invalid

deleteAutoFillItems

public void deleteAutoFillItems(int index)
                         throws CellException
Deletes the specified autofill list Autofill lists are frequently used series of data, such as months and days of the week. When you enter a value from an autofill list and move one cell down or to the right, the next value in the list is proposed for that cell. You can also use the fill handle to autofill a single row or column.

Parameters:
index - - identifies the list's position within all defined autofill lists. The first list has an index of 1.
Throws:
CellException - if a parameter is invalid

deleteDefinedName

public void deleteDefinedName(java.lang.String name)
                       throws CellException
Deletes the specified user-defined name You cannot delete a defined name that is currently referenced by a formula in a cell, another defined name, or a chart object.

Parameters:
name - - identifies the user-defined name to delete
Throws:
CellException - if a parameter is invalid

deleteRange

public void deleteRange(int row1,
                        int col1,
                        int row2,
                        int col2,
                        short shiftType)
                 throws CellException
Deletes cells, rows, or columns from the specified range in all selected sheets. Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
row1 - - Coordinate of the beginning row of the range to delete
col1 - - Coordinate of the beginning column of the range
row2 - - Coordinate of the ending row of the range
col2 - - Coordinate of the ending column of the range
shiftType - - Constants determining how the delete should occur: eShiftHorizontal = 1 eShiftVertical = 2 eshiftRows = 3 eShiftColumns = 4
Throws:
CellException - if a parameter is invalid

deleteSheets

public void deleteSheets(int sheet,
                         int sheets)
                  throws CellException
Deletes one or more worksheets from a workbook The names displayed on the sheet tabs are not affected by deletions; however, the worksheet index is adjusted.

Parameters:
sheet - - specifies the index to the first worksheet to be deleted. Do not confuse the index with the sheet name on the sheet tab.
sheets - - specifies how many sheets to delete, beginning with the worksheet specified by sheet.
Throws:
CellException - if a parameter is invalid

destroy

public void destroy()
Releases resources associated with this view. This method must be called if the view attached to this workbook has been added to a group by calling com.jxcell.View.setGroup(String group). If this is the last view which references the workbook, the workbook is removed from the group. If this leaves the group empty, the group is removed from the static collection of groups and the background thread for the group is killed.


draw

public void draw(java.awt.Graphics g,
                 int x,
                 int y,
                 int cx,
                 int cy,
                 int nRow,
                 int nCol,
                 int[] rows,
                 int[] cols,
                 int nFixedR1,
                 int nFixedRows,
                 int nFixedC1,
                 int nFixedCols)
          throws CellException
Draws a workbook to the specified device context, such as a printer or window. JXCell attempts to draw the specified number of rows and columns at the current print scale. If necessary, JXCell reduces the print scale until the rows and columns fit the specified drawing area or until print scale reaches 10 percent.

Parameters:
g - - handle to a device context specifying where the workbook is drawn
x - - column coordinate of the upper left corner of the drawn workbook
y - - row coordinate of the upper left corner of the drawn workbook
cx - - width of the drawn workbook
cy - - height of the drawn workbook
nRow - - beginning row in the workbook to be drawn
nCol - - beginning column in the workbook to be drawn
rows - - the number of rows to be drawn
cols - - the number of columns to be drawn
nFixedR1 - - beginning fixed row of the drawn worksheet
nFixedRows - - number of rows to fix in the drawn worksheet
nFixedC1 - - beginning fixed column in the drawn worksheet
nFixedCols - - number of columns to fix in the drawn worksheet
Throws:
CellException - if a parameter is invalid

editClear

public void editClear(short clearType)
               throws CellException
Clears all cells in the selected range and all selected objects in all selected sheets

Parameters:
clearType - - A constant specifying what is cleared: eClearDlg = 0 eClearFormats = 1 eClearValues = 2 eClearAll = 3
Throws:
CellException - if a parameter is invalid

editCopy

public void editCopy()
              throws CellException
Copies the selected range or objects to the clipboard Only one range can be selected. If more than one range is selected, an error is returned

Throws:
CellException - if an error occurs

editCopyDown

public void editCopyDown()
                  throws CellException
Copies cells in the top row a selection to the other rows in the selected range and adjusts relative cell references appropriately

Throws:
CellException - if an error occurs

editCopyRight

public void editCopyRight()
                   throws CellException
Copies cells in the left column of a selection to the other columns in the selected range and adjusts relative cell references appropriately

Throws:
CellException - if an error occurs

editCut

public void editCut()
             throws CellException
Cuts the selected range or object to the clipboard and clears the range or object from the active worksheet. Only one range can be selected. If more than one range is selected, an error is returned.

Throws:
CellException - if an error occurs

editDelete

public void editDelete(short shift)
                throws CellException
Deletes the selected range in all selected sheets

Parameters:
shift - - A constant that determines how the deletion should occur. eShiftHorizontal = 1 eShiftVertical = 2 eShiftRows = 3 eShiftColumns = 4

Throws:
CellException - if a parameter is invalid

editDeleteSheets

public void editDeleteSheets()
                      throws CellException
Deletes the selected sheets Sheet names displayed on the tabs are not affect by the deletion; however, the remaining worksheet indexes are adjusted to reflect the new position. You cannot delete the last sheet of a workbook.

Throws:
CellException - if an error occurs

editInsert

public void editInsert(short shift)
                throws CellException
Moves the selected range in all selected worksheets to insert new cells, rows, or columns

Parameters:
shift - - A constant that determines how the insertion should occur. eShiftHorizontal = 1 eShiftVertical = 2 eShiftRows = 3 eShiftColumns = 4 eFixupAppend = 32 eFixupNormal = 0 eFixupPrepend = 16

Throws:
CellException - if protection is enabled or if more than one range is selected

editInsertSheets

public void editInsertSheets()
                      throws CellException
Inserts one or more new worksheets, depending on the number and position of the currently selected worksheets. This method uses the number of selected worksheets and their positions to determine how many worksheets to add and where to add them. For example, if the second and third worksheets are selected, two new worksheets are inserted between them. The newly inserted worksheets are given the next available sheet name, regardless of their positions.

Throws:
CellException - if an error occurs

editPaste

public void editPaste()
               throws CellException
Pastes the contents of the clipboard to the selected range. The contents can be cell data, tab-delimited blocks of data, or objects. This method pastes information from the clipboard into the active worksheet. How the information is pasted depends upon the size of the selected range. If the selected range consists of a single cell, all information in the clipboard is pasted to the worksheet. If the selected range is smaller than the clipboard information, only as much information as will fit in the range is pasted. If the selected range is larger than the clipboard information, the clipboard information is replicated to fill the range.

Throws:
CellException - if an error occurs

editPasteSpecial

public void editPasteSpecial(short what)
                      throws CellException
Pastes data from the clipboard to the selected range This method allows you to choose the type of data to paste: formulas only, values only, formats only, any combination of the previous types, or all of the types.

Parameters:
what - - what to paste, represented as one or more of the following constants: eCopyFormulas = 1 eCopyValues = 2 eCopyFormats = 4 eCopyAll = 7

Throws:
CellException - if a parameter is invalid

endEdit

public void endEdit()
             throws CellException
Ends edit mode and applies changes to the active cell If an invalid entry has been made (e.g., an incorrect formula), edit mode cannot end. In this case, an error is returned.

Throws:
CellException - if an error occurs

errorNumberToText

public java.lang.String errorNumberToText(short error)
                                   throws CellException
Returns a string containing the text of the corresponding to the specified error number

Parameters:
error - - a JXCell error number
Returns:
the error text
Throws:
CellException

filePrint

public void filePrint(boolean showPrintDlg)
               throws CellException
Prints the selected worksheet If the user-defined name Print_Area is defined, only those ranges specified in Print_Area are printed. If Print_Area is not defined, the entire formatted section of the worksheet is printed.

Parameters:
showPrintDlg - - sets the show print dialog flag. If this flag is true, the Print dialog box is displayed before printing.
Throws:
CellException

findFirst

public FindReplaceInfo findFirst(int row1,
                                 int col1,
                                 int row2,
                                 int col2,
                                 java.lang.String findWhat,
                                 int flags)
                          throws CellException
Finds the first cell in the current sheet for the given range.

Parameters:
row1 - - the first row to search.
col1 - - the first column to search.
row2 - - the last row to search.
col2 - - the last col to search.
findWhat - - the text to search for.
flags - - one or more of the following search flags: FindReplaceInfo.kMatchCase to match case exactly. FindReplaceInfo.kMatchEntireCells to only return cells whose entire contents match findWhat. FindReplaceInfo.kByRows to search by rows and then by columns (default). FindReplaceInfo.kByColumns to search by columns and then by rows. This option is slower than FindReplaceInfo.kByRows. FindReplaceInfo.kInValues to search values (default). FindReplaceInfo.kInFormulas to search formulas. FindReplaceInfo.kReplaceAll to replace for all occurrences (replace only).
Returns:
an instance of FindReplaceInfo if successful, null otherwise.
Throws:
CellException - if any arguments are invalid

findFirst

public FindReplaceInfo findFirst(int sheet1,
                                 int row1,
                                 int col1,
                                 int sheet2,
                                 int row2,
                                 int col2,
                                 java.lang.String findWhat,
                                 int flags)
                          throws CellException
Finds the first cell in the current sheet for the given range. Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
sheet1 - - the first sheet to search
row1 - - the first row to search.
col1 - - the first column to search.
sheet2 - - the last sheet to search
row2 - - the last row to search.
col2 - - the last col to search.
findWhat - - the text to search for.
flags - - one or more of the following search flags FindReplaceInfo.kMatchCase FindReplaceInfo.kMatchEntireCells FindReplaceInfo.kByRows FindReplaceInfo.kByColumns FindReplaceInfo.kInValues FindReplaceInfo.kInFormulas FindReplaceInfo.kReplaceAll
Returns:
an instance of FindReplaceInfo if successful, null otherwise.
Throws:
CellException - if any arguments are invalid

findFirst

public FindReplaceInfo findFirst(java.lang.String findWhat,
                                 int flags)
                          throws CellException
Finds the first cell in the current sheet for the given range.

Parameters:
findWhat - - the text to search for
flags - - one or more of the following search flags FindReplaceInfo.kMatchCase FindReplaceInfo.kMatchEntireCells FindReplaceInfo.kByRows FindReplaceInfo.kByColumns FindReplaceInfo.kInValues FindReplaceInfo.kInFormulas FindReplaceInfo.kReplaceAll
Returns:
an instance of FindReplaceInfo if successful, null otherwise.
Throws:
CellException - if any arguments are invalid

findNext

public FindReplaceInfo findNext(java.lang.String findWhat,
                                int flags)
                         throws CellException
Finds the next cell containing the specified text

Parameters:
findWhat - - the text to search for
flags - - one or more of the following search flags FindReplaceInfo.kMatchCase FindReplaceInfo.kMatchEntireCells FindReplaceInfo.kByRows FindReplaceInfo.kByColumns FindReplaceInfo.kInValues FindReplaceInfo.kInFormulas FindReplaceInfo.kReplaceAll
Returns:
an instance of FindReplaceInfo if successful, null otherwise.
Throws:
CellException - if any arguments are invalid

findNext

public FindReplaceInfo findNext(java.lang.String findWhat,
                                int flags,
                                FindReplaceInfo findreplaceinfo)
Finds the next cell containing the specified text

Parameters:
findWhat - - the text to search for
flags - - one or more of the following search flags FindReplaceInfo.kMatchCase FindReplaceInfo.kMatchEntireCells FindReplaceInfo.kByRows FindReplaceInfo.kByColumns FindReplaceInfo.kInValues FindReplaceInfo.kInFormulas FindReplaceInfo.kReplaceAll
findreplaceinfo - - a FindReplaceInfo object
Returns:
an instance of FindReplaceInfo if successful, null otherwise.

flushModifiedEvents

public void flushModifiedEvents()
Sends modified events to Modified event listeners and clears the flags indicating the events needed to be sent


formatRCNr

public java.lang.String formatRCNr(int row,
                                   int col,
                                   boolean doAbsolute)
                            throws CellException
Returns a string containing a formatted row and column reference

Parameters:
row - - the row number of the reference
col - - the column number of the reference
doAbsolute - - if True, uses absolute references. If False, uses relative references
Returns:
the string containing the formatted reference
Throws:
CellException

formulaToRangeRef

public RangeRef formulaToRangeRef(java.lang.String formula)
                           throws CellException
Creates and returns an instance of RangeRef from a formula. Use RangeRef methods to retrieve the row and column numbers.

Parameters:
formula - - a string containing a range reference formula, such as "A1:D30".
Returns:
a RangeRef object
Throws:
CellException

getActiveCell

public CellRef getActiveCell()
                      throws CellException
Returns the row and column coordinates of the active cell The active cell is the cell in which the cursor is currently located. It is the cell in which data is entered or edited if the user starts typing.

Returns:
a CellRef object
Throws:
CellException

getAutoFillItems

public java.lang.String getAutoFillItems(int index)
                                  throws CellException
Returns an autofill list Autofill lists are frequently used series of text such as months and days of the week. When you enter a text value from an autofill list and move one cell down or to the right, the next text value in the list is proposed as an entry for the cell. You can also use the fill handle to autofile a single row or column.

Parameters:
index - - identifies the list's position with all defined autofill lists. The first autofill item has an index of 1.
Returns:
a semi-colon delimited list of autofill items
Throws:
CellException

getAutoFillItemsCount

public int getAutoFillItemsCount()
Returns the number of existing autofill lists

Returns:
an integer representing the number of lists

getBackColor

public java.awt.Color getBackColor()
Returns the background color of the current sheet.

Returns:
the background color of the current sheet in the form 0x00rrggbb.

getCellFormat

public CellFormat getCellFormat()
Returns the format of the selected range of cells

Returns:
an instance of a CellFormat object

getCellFormat

public CellFormat getCellFormat(int row1,
                                int col1,
                                int row2,
                                int col2)
                         throws CellException
Returns the format of the specified range of cells Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
row1 - - the first row in the range
col1 - - the first column in the range
row2 - - the ending row in the range
col2 - - the ending column in the range
Returns:
an instance of a CellFormat object
Throws:
CellException

getCellFormat

public CellFormat getCellFormat(int sheet1,
                                int row1,
                                int col1,
                                int sheet2,
                                int row2,
                                int col2)
                         throws CellException
Returns the format of the specified range of cells in the specified range of sheets Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
sheet1 - - the beginning sheet
row1 - - the first row in the range
col1 - - the first column in the range
sheet2 - - the ending sheet
row2 - - the ending row in the range
col2 - - the ending column in the range
Returns:
an instance of a CellFormat object
Throws:
CellException

getCellFormat

public void getCellFormat(CellFormat cellformat)
Returns the format of the selected range of cells into the specified CellFormat object You can use this method to loop through cells, retrieving cell formats through the same instance of the CellFormat object. You must first create an instance of a CellFormat object by calling a getCellFormat method that returns an object.

Parameters:
cellformat - - a CellFormat object

getCellFormat

public void getCellFormat(CellFormat cellformat,
                          int row1,
                          int col1,
                          int row2,
                          int col2)
                   throws CellException
Returns the format of the specified range of cells into the specified CellFormat object You can use this method to loop through cells, retrieving cell formats through the same instance of the CellFormat object. You must first create an instance of a CellFormat object by calling a getCellFormat method that returns an object. Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
cellformat - - a CellFormat object
row1 - - the first row in the range
col1 - - the first column in the range
row2 - - the ending row in the range
col2 - - the ending column in the range
Throws:
CellException

getCellFormat

public void getCellFormat(CellFormat cellformat,
                          int sheet1,
                          int row1,
                          int col1,
                          int sheet2,
                          int row2,
                          int col2)
                   throws CellException
Returns the format of the specified range of cells in the specified range of sheets into the specified CellFormat object You can use this method to loop through cells, retrieving cell formats through the same instance of the CellFormat object. You must first create an instance of a CellFormat object by calling a getCellFormat method that returns an object. Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
cellformat - - a CellFormat object
sheet1 - - the beginning sheet
row1 - - the first row in the range
col1 - - the first column in the range
sheet2 - - the ending sheet
row2 - - the ending row in the range
col2 - - the ending column in the range
Throws:
CellException

getClip

public java.lang.String getClip()
                         throws CellException
Imports tab-delimited text strings from workbooks. The imported text is obtained from the currently selected range. If multiple ranges are selected, only text from the first range is retrieved.

Returns:
tab-delimited text
Throws:
CellException

getClipboard

public static java.awt.datatransfer.Clipboard getClipboard()
Returns the clipboard to be used for clipboard operations. This method returns the clipboard to be used for clipboard operations. If this is the first call to getClipboard(), and setClipboard(...) has not been called, a new clipboard named "com.jxcell" will be created. JXCell does not use the system clipboard because it only works with java.awt.datatransfer.StringSelection objects on some platforms. To force JXCell to use the system clipboard you can call setClipboard(...).


getClipValues

public java.lang.String getClipValues()
                               throws CellException
Imports values from workbooks

Returns:
a tab-delimited string
Throws:
CellException

getCol

public int getCol()
           throws CellException
Returns the active column in the active worksheet.

Returns:
the column number.
Throws:
CellException

getColText

public java.lang.String getColText(int col)
                            throws CellException
Returns the label for a column.

Parameters:
col - - identifies a column by number
Returns:
the column label text
Throws:
CellException

getColWidth

public int getColWidth(int col)
                throws CellException
Returns the width of a single column. Column width can be specified in units equal to 1/256th of the character O's width in the default font, or to twips, depending on the column width units specified for the workbook.

Parameters:
col - - identifies a column by number
Returns:
the column width value
Throws:
CellException

getColWidthTwips

public int getColWidthTwips(int col)
                     throws CellException
Returns the width of the specified column in twips Column width can be specified in units equal to 1/256th of the character O's width in the default font, or to twips, depending on the column width units specified for the workbook.

Parameters:
col - - identifies a column by number
Returns:
the column width in twips
Throws:
CellException

getColWidthUnits

public short getColWidthUnits()
Returns whether column widths are stored and displayed in twips or character units.

Returns:
the type of units used for column widths eColWidthUnitsNormal = 0 eColWidthUnitsTwips = 1

getDefaultColWidth

public int getDefaultColWidth()
Returns the default column width

Returns:
the default column width value

getDefaultFontName

public java.lang.String getDefaultFontName()
Returns the name of the default font

Returns:
the name of the font

getDefaultFontSize

public int getDefaultFontSize()
Returns the size of the default font

Returns:
the default font size in twips. The size is returned in twips, even if the font size was originally specified in points. To convert twips to points, divide the number of twips by 20.

getDefaultRowHeight

public int getDefaultRowHeight()
Returns the default height for rows.

Returns:
the row height value in twips. A twip is 1/1440th of an inch.

getDefinedName

public java.lang.String getDefinedName(int name)
                                throws CellException
Returns a defined name

Parameters:
name - - identifies a name by index number. Defined names are numbered in the order in which they are created, beginning with 0.
Returns:
a string containing the name
Throws:
CellException - if an invalid index number is specified

getDefinedName

public java.lang.String getDefinedName(java.lang.String name)
                                throws CellException
Returns the definition associated with a name, in US English. A defined name can refer to a cell, a group of cells, a value, or a formula.

Parameters:
name - - a defined name
Returns:
a string containing the name's definition
Throws:
CellException - if the specified name does not exist

getDefinedNameCount

public int getDefinedNameCount()
Returns the number of defined names in a view

Returns:
the number of defined names

getDefinedNameLocal

public java.lang.String getDefinedNameLocal(java.lang.String name)
                                     throws CellException
Returns the definition of a defined name in the user's local language A defined name can refer to a cell, a group of cells, a value, or a formula. Use this method if users must see the name in their own language. The return value will change depending on the language, which can result in code that will not run correctly in other language versions of JXCell. To ensure names behave properly, use getDefinedName.

Parameters:
name - - a defined name in the user's language
Returns:
a string containing the name's definition, in the user's language
Throws:
CellException

getEntry

public java.lang.String getEntry()
                          throws CellException
Returns the contents of the active cell in the first selected worksheet in edit mode format For example, if the cell contains a formula, the text of the formula is displayed. Returned formulas are preceded by an equal sign (=).

Returns:
a string containing the cell contents
Throws:
CellException

getEntry

public java.lang.String getEntry(int row,
                                 int col)
                          throws CellException
Returns the text value of the specified cell in the first selected worksheet in edit mode format For example, if the cell contains a formula, the text of the formula is displayed. Returned formulas are preceded by an equal sign (=). NOTE: The returned string is always in the user's language and should only be used for interaction with the user. For internal purposes, use getFormula, getText, getNumber, and isLogical.

Parameters:
row - - the row number
col - - the column number
Returns:
a string containing the cell contents
Throws:
CellException

getEntry

public java.lang.String getEntry(int sheet,
                                 int row,
                                 int col)
                          throws CellException
Returns the text value of the specified cell in the first selected worksheet in edit mode format For example, if the cell contains a formula, the text of the formula is displayed. Returned formulas are preceded by an equal sign (=). NOTE: The returned string is always in the user's language and should only be used for interaction with the user. For internal purposes, use getFormula, getText, getNumber, and isLogical.

Parameters:
sheet - - the index number of the sheet in which the cell resides
row - - the row number
col - - the column number
Returns:
a string containing the cell contents
Throws:
CellException

getExtraColor

public java.awt.Color getExtraColor()
Returns the extra color of the current sheet. This color is used to fill any extra space to the right and below the sheet.

Returns:
the extra color of the current sheet in the form 0x00rrggbb.

getFileName

public java.lang.String getFileName()
Returns the name of the workbook file currently attached to a view. When two views have the same filename setting, they are attached to the same workbook.

Returns:
the name of the workbook file attached to the view

getFirstNumberFormat

public NumberFormat getFirstNumberFormat()
                                  throws CellException
Returns a NumberFormat object representing the first entry in the workbook's number format table. Subsequent calls to the getNextNumberFormat method advance the object to the next entry in the table.

Returns:
a NumberFormat object
Throws:
CellException

getFirstObject

public GRObject getFirstObject()
Returns the first object in the active worksheet This method can be used in conjunction with the getNextObject method to to loop through all the objects in a worksheet.

Returns:
the first object in the worksheet

getFirstView

public View getFirstView()
Returns the first view of the workbook attached to this view. Use this method to start iterating over all of the views of the workbook which is attached to this view.

Returns:
a View object

getFixedCol

public int getFixedCol()
Returns the starting fixed column.

Returns:
the starting fixed column.

getFixedCols

public int getFixedCols()
Returns the number of fixed columns or zero if there are none.

Returns:
the number of fixed columns or zero if there are none.

getFixedRow

public int getFixedRow()
Returns the starting fixed row.

Returns:
the starting fixed row.

getFixedRows

public int getFixedRows()
Returns the number of fixed rows or zero if there are none.

Returns:
the number of fixed rows or zero if there are none.

getFormattedText

public java.lang.String getFormattedText()
                                  throws CellException
Throws:
CellException

getFormattedText

public java.lang.String getFormattedText(int row,
                                         int col)
                                  throws CellException
Returns the formatted text value of the specified cell This method returns the text as it is seen in the worksheet, including all formatting. To return unformatted text, use the getText or getEntry methods.

Parameters:
row - - the row number of the cell from which the text is returned
col - - the column number of the cell from which the text is returned
Returns:
a string containing the formatted text
Throws:
CellException

getFormattedText

public java.lang.String getFormattedText(int sheet,
                                         int row,
                                         int col)
                                  throws CellException
Returns the value of the specified cell as it appears in the specified worksheet This method returns the text as it is seen in the worksheet, including all formatting. To return unformatted text, use the getText or getEntry methods.

Parameters:
sheet - - the worksheet number from which the text is returned
row - - the row number of the cell from which the text is returned
col - - the column number of the cell from which the text is returned
Returns:
a string containing the formatted text
Throws:
CellException

getFormula

public java.lang.String getFormula()
                            throws CellException
Returns the formula of the active cell.

Returns:
the formula of the active cell.
Throws:
CellException - if there is no active cell.

getFormula

public java.lang.String getFormula(int row,
                                   int col)
                            throws CellException
Returns the the text of the formula of the specified cell, in US English.

Parameters:
row - - the row number of the cell
col - - the column number of the cell
Returns:
the formula of the specified cell
Throws:
CellException

getFormula

public java.lang.String getFormula(int sheetnum,
                                   int row,
                                   int col)
                            throws CellException
Returns the the text of the formula of the specified cell, in US English.

Parameters:
sheetnum - - the sheet number
row - - the row number of the cell
col - - the column number of the cell
Returns:
the formula of the specified cell
Throws:
CellException

getFormulaLocal

public java.lang.String getFormulaLocal()
                                 throws CellException
Returns the text of the formula of the active cell, in the user's language

Returns:
the formula of the active cell
Throws:
CellException

getFormulaLocal

public java.lang.String getFormulaLocal(int row,
                                        int col)
                                 throws CellException
Returns the the text of the formula of the specified cell, in the user's language

Parameters:
row - - the row number of the cell
col - - the column number of the cell
Returns:
the formula of the specified cell
Throws:
CellException

getFormulaLocal

public java.lang.String getFormulaLocal(int sheetnum,
                                        int row,
                                        int col)
                                 throws CellException
Returns the the text of the formula of the specified cell in the specified sheet, in the user's language

Parameters:
sheetnum - - the sheet number
row - - the row number of the cell
col - - the column number of the cell
Returns:
the formula of the specified cell
Throws:
CellException

getGroup

public java.lang.String getGroup()
Returns the group name for the workbook attached to this view.

Returns:
the group name for the workbook attached to this view.

getHeaderHeight

public int getHeaderHeight()
Returns the height of the column headers. Header height is specified in twips. A twip is 1/1440 of an inch.

Returns:
the header height

getHeaderWidth

public int getHeaderWidth()
Returns the width of the row headers. The units used to store or display widths depends on the of colWidthUnits setting. If the units are set to characters, the width is specified in units equal to 1/256th of the O character's width in the default font. If the units are set to twips, columns are measured in twips, which are 1/1440 of an inch.

Returns:
the width of the row headers

getIterationMax

public int getIterationMax()
Returns the maximum number of calculation iterations Iteration can be used to resolve circular references. JXCell calculates until it has iterated the number of times specified by the maximum number of iterations, or until all cells change by less than the amount specified as the maximum iteration change value. Iteration is enabled by calling the setIterationEnabled method.

Returns:
returns the maximum number of iterations

getIterationMaxChange

public double getIterationMaxChange()
Returns the maximum iteration change value Iteration can be used to resolve circular references. JXCell calculates until it has iterated the number of times specified by the maximum number of iterations, or until all cells change by less than the amount specified as the maximum iteration change value. Iteration is enabled by calling the setIterationEnabled method.

Returns:
the maximum iteration change value

getLastCol

public int getLastCol()
Returns the number of the last occupied column This method returns the last column that is not empty, including cells that contain only formatting.

Returns:
the last occupied column

getLastColForRow

public int getLastColForRow(int rownum)
                     throws CellException
Returns the number of the last occupied column in the specified row This method returns the last column that is not empty, including cells that contain only formatting.

Parameters:
rownum - - the specified row
Returns:
the last occupied column in the row
Throws:
CellException - if a parameter is invalid

getLastRow

public int getLastRow()
Returns the number of the last occupied row This method returns the last row that is not empty, including cells that contain only formatting.

Returns:
the number of the last row

getLeftCol

public int getLeftCol()
               throws CellException
Returns the first column currently displayed in this view.

Returns:
the first column currently displayed in this view.
Throws:
CellException - is the view is not visible

getLock

public void getLock()
Locks all views and workbooks in the current group. No other thread will be allowed to access these views or workbooks until releaseLock() is called. Calls to getLock() may be nested, but releaseLock() must be called once for each getLock(). Typically getLock() should be used in the following fashion: ... view.getLock(); try { ... } finally { view.releaseLock(); } ... A view should be locked before performing multiple related actions. This will ensure consistency and improve performance. Most methods and properties in JXCell call getLock() and releaseLock() internally.


getMaxCol

public int getMaxCol()
Returns the last column which may be displayed in the current sheet.

Returns:
the last column which may be displayed in the current sheet.

getMaxRow

public int getMaxRow()
Returns the last row which may be displayed in the current sheet.

Returns:
the last row which may be displayed in the current sheet.

getMinCol

public int getMinCol()
Returns the first column that can be displayed in the active worksheet. Columns before the first column are not displayed but can be used to hold data and formulas.

Returns:
the number of the first displayable column

getMinRow

public int getMinRow()
Returns the first row that can be displayed in the active worksheet. Rows above the first row are not displayed but can be used to hold data and formulas.

Returns:
the number of the first displayable row

getMode

public short getMode()
Returns the current mode for mouse actions in a view

Returns:
the current mode as one of the following: eModeNormal = 0 eModeLine = 1 eModeRectangle = 2 eModeOval = 3 eModeArc = 4 eModeText = 6 eModeButton = 7 eModePicture = 8 eModePolygon = 9 eModeDropDown = 101 eModeCheckBox = 102 eModeChart = 103

getNextColPageBreak

public int getNextColPageBreak(int col)
                        throws CellException
Returns the next column where there is a page break

Parameters:
col - - the starting column
Returns:
the column number of the next vertical page break, or zero if there is no page break after col.
Throws:
CellException

getNextNumberFormat

public NumberFormat getNextNumberFormat(NumberFormat numberformat)
                                 throws CellException
Returns a NumberFormat object containing the next entry in the workbook's number format table. Subsequent calls to this method advance the object to the next entry in the table. Use getFirstNumberFormat to create a NumberFormat object and return the first entry.

Returns:
a NumberFormat object containing the next entry
Throws:
CellException

getNextRowPageBreak

public int getNextRowPageBreak(int row)
                        throws CellException
Returns the next row where there is a page break

Parameters:
row - - the starting row
Returns:
the row number of the horizontal page break, or zero if there is no page break after row.
Throws:
CellException

getNextView

public View getNextView()
Returns the next view of a workbook. Use getFirstView to return the first view.

Returns:
the next View of the workbook attached to this view.

getNumber

public double getNumber()
                 throws CellException
Returns the numeric value of the active cell Cells containing a formula return the numeric result of the formula. If a cell contains text, an attempt is made to convert the text to a number. If the text cannot be converted, 0 (No Error) is returned. If the active cell contains a formula, the formula is deleted when the numeric value is assigned.

Returns:
the numeric value of the active cell
Throws:
CellException

getNumber

public double getNumber(int row,
                        int col)
                 throws CellException
Returns the numeric value of the specified cell. Cells containing a formula return the numeric result of the formula. If a cell contains text, an attempt is made to convert the text to a number. If the text cannot be converted, 0 (No Error) is returned. If the active cell contains a formula, the formula is deleted when the numeric value is assigned.

Parameters:
row - - the row coordinate
col - - the column coordinate
Returns:
the numeric value of the active cell
Throws:
CellException

getNumber

public double getNumber(int sheet,
                        int row,
                        int col)
                 throws CellException
Returns the numeric value of the specified cell in the specified worksheet Cells containing a formula return the numeric result of the formula. If a cell contains text, an attempt is made to convert the text to a number. If the text cannot be converted, 0 (No Error) is returned. If the active cell contains a formula, the formula is deleted when the numeric value is assigned.

Parameters:
sheet - - the specified sheet
row - - the row coordinate
col - - the column coordinate
Returns:
the numeric value of the active cell
Throws:
CellException

getNumSheets

public int getNumSheets()
Returns the number of worksheets in the current workbook

Returns:
the number of worksheets in the current workbook

getObject

public GRObject getObject(int objectID)
Returns an object specified by its identification number

Parameters:
objectID - - the object's identification number
Returns:
the specified object or null if no object is found

getObject

public GRObject getObject(java.lang.String name)
Returns an object specified by name

Parameters:
name - - the name of the object
Returns:
the specified object or null if no object is found

getPaletteEntry

public java.awt.Color getPaletteEntry(int entry)
                               throws CellException
Returns a color in the JXCell color palette

Parameters:
entry - - Zero-based index of the entry to change. JXCell presents a color palette with 56 color entries.
Returns:
a color from java.awt.Color
Throws:
CellException - if a parameter is invalid

getParentFrame

public java.awt.Frame getParentFrame()
Returns the parent window

Returns:
a java.awt.Frame object

getPolyEditMode

public short getPolyEditMode()
Returns the mode for interactive polygon editing In normal polygon editing mode (0), only the width and height of polygons can be interactively edited. To reshape and edit the point on a polyon, polygon point editing mode (1) must be enabled.

Returns:
the polygon editing mode ePolyEditModeNormal = 0 ePolyEditModePoints = 1

getPrintArea

public java.lang.String getPrintArea()
                              throws CellException
Returns the current print area The returned string is based on the user-defined name, Print_Area, which defines the worksheet range to be printed. The Print_Area definition can contain one or more ranges (e.g., A1:C3,A11:C13). If Print_Area is null (""), the selected portion of the active worksheet is printed.

Returns:
the current print area
Throws:
CellException

getPrintBottomMargin

public double getPrintBottomMargin()
Returns the bottom print margin in inches.

Returns:
the bottom print margin in inches.

getPrintFooter

public java.lang.String getPrintFooter()
Returns the current page footer The following list shows the special codes the footer text can contain. By default, footer text is centered unlies &L or &R is specified. &L Left-aligns the characters that follow. &C Centers the characters that follow. &R Right-aligns the characters that follow. &A Prints the sheet name. &D Prints the current date. &T Prints the current time. &F Prints the workbook name. &P Prints the page number. &P+number Prints the page number plus number. &P-number Prints the page number minus number. && Prints an ampersand. &N Prints the total number of pages in the document. The following font codes must appear before other codes and text or they are ignored. The alignmentcodes (e.g., &L) restart each section; new font codes can be specified after an alignment code. &B Use a bold font. &I Use an italic font. &U Underline the header. &S Strikeout the header. &O Ignored (Mac specific). &H Ignored (Mac specific). &"fontname" Use the specified font. &nn Use the specified font size - must be a two digit number.

Returns:
a string containing the current page footer

getPrintFooterMargin

public double getPrintFooterMargin()
Returns the page footer margin used during printing The header and footer margins can be printed. The value given is from the the bottom of the page. The values are measured in inches or metric units, depending on the localized settings.

Returns:
a value representing the page footer margin

getPrintHeader

public java.lang.String getPrintHeader()
Returns the page header printed at the top of each page The following list shows the special codes the footer text can contain. By default, header text is centered unlies &L or &R is specified. &L Left-aligns the characters that follow. &C Centers the characters that follow. &R Right-aligns the characters that follow. &A Prints the sheet name. &D Prints the current date. &T Prints the current time. &F Prints the workbook name. &P Prints the page number. &P+number Prints the page number plus number. &P-number Prints the page number minus number. && Prints an ampersand. &N Prints the total number of pages in the document. The following font codes must appear before other codes and text or they are ignored. The alignmentcodes (e.g., &L) restart each section; new font codes can be specified after an alignment code. &B Use a bold font. &I Use an italic font. &U Underline the header. &S Strikeout the header. &O Ignored (Mac specific). &H Ignored (Mac specific). &"fontname" Use the specified font. &nn Use the specified font size - must be a two digit number.

Returns:
a string containing the current page header

getPrintHeaderMargin

public double getPrintHeaderMargin()
Returns the page header margin used during printing The header and footer margins can be printed. The value given is from the the bottom of the page. The values are measured in inches or metric units, depending on the localized settings.

Returns:
the page header margin

getPrintLeftMargin

public double getPrintLeftMargin()
Returns the left print margin in inches.

Returns:
the left print margin in inches.

getPrintRightMargin

public double getPrintRightMargin()
Returns the right print margin in inches.

Returns:
the right print margin in inches.

getPrintScale

public int getPrintScale()
Returns the scale factor for the active worksheet

Returns:
the scale factor for the active worksheet

getPrintScaleFitHPages

public int getPrintScaleFitHPages()
Returns the number of horizontal pages to which the print job is fit

Returns:
the number of horizontal pages

getPrintScaleFitVPages

public int getPrintScaleFitVPages()
Returns the number of vertical pages to which the print job is fit

Returns:
the number of vertical pages

getPrintTitles

public java.lang.String getPrintTitles()
                                throws CellException
Returns the print titles to be printed at the top of each page Print titles are row and column titles that are printed on each page. Column titles print on the left side of each page; row titles print across the top of each page.

Returns:
a string containing the formula for the Print_Titles user_defined name. This can contain a single range or multiple ranges. The following example prints the first two rows and the first column on every page: A1:IV2,A1:A16384
Throws:
CellException

getPrintTopMargin

public double getPrintTopMargin()
Returns the top print margin in inches.

Returns:
the top print margin in inches.

getRow

public int getRow()
           throws CellException
Returns the row of the active cell.

Returns:
the row of the active cell.
Throws:
CellException

getRowHeight

public int getRowHeight(int row)
                 throws CellException
Returns the height of a single specified row.

Parameters:
row - - the row number
Returns:
the row height in twips. A twip is 1/1440th of an inch.
Throws:
CellException

getRowText

public java.lang.String getRowText(int row)
                            throws CellException
Returns the name of the specified row Naming a row is useful for providing labels that reflect the data in the row. The row name is displayed in the row heading is is used for display purposes only. The row is still referred to by normal cell references in formulas. Row names can be up to 254 characters long.

Parameters:
row - - the row number
Returns:
a string containing the row name
Throws:
CellException

getSelectedObject

public GRObject getSelectedObject(int selection)
                           throws CellException
Returns the ID of a selected object.

Parameters:
selection - - identifies the selected object by number
Returns:
GRObject
Throws:
CellException - if a parameter is invalid

getSelectedObjectCount

public int getSelectedObjectCount()
Returns the number of selected objects.

Returns:
the number of selected objects

getSelection

public java.lang.String getSelection()
Returns a formula that represents the row and column coordinates of the current selection.

Returns:
the start and end row and column of the current selection

getSelection

public RangeRef getSelection(int selection)
                      throws CellException
Returns the row and column coordinates of a selected range.

Parameters:
selection - - identifies the index of the selection. Index of 0 returns the row and column coordinates of the first selection
Returns:
a RangeRef object
Throws:
CellException

getSelectionCount

public int getSelectionCount()
Returns the number of selected ranges in the active worksheet.

Returns:
the number of selected ranges

getSelectionLocal

public java.lang.String getSelectionLocal()
Returns the start and end row and column of the specified selection, in the user's language.

Returns:
the start and end row and column

getSelEndCol

public int getSelEndCol()
                 throws CellException
Returns the last selected column.

Returns:
the last selected column
Throws:
CellException

getSelEndRow

public int getSelEndRow()
                 throws CellException
Returns the last selected row.

Returns:
the last selected row
Throws:
CellException

getSelStartCol

public int getSelStartCol()
                   throws CellException
Returns the first selected col.

Returns:
the first selected col
Throws:
CellException - if there are no ranges selected

getSelStartRow

public int getSelStartRow()
                   throws CellException
Returns the first selected row.

Returns:
the first selected row
Throws:
CellException - if there are no ranges selected

getSheet

public int getSheet()
Returns the active worksheet.

Returns:
identifies an existing worksheet by number

getSheetName

public java.lang.String getSheetName(int sheet)
                              throws CellException
Returns the name of the specified worksheet.

Parameters:
sheet - - identifies the worksheet by number
Returns:
the name of the worksheet
Throws:
CellException

getShowHScrollBar

public short getShowHScrollBar()
Returns the mode for the horizontal scroll bar.

Returns:
the mode for the horizontal scroll bar: eShowOff to never show eShowOn to always show eShowAutomatic to show when appropriate

getShowSelections

public short getShowSelections()
Returns the mode for highlighting selections.

Returns:
the mode for highlighting selections: eShowOff to never show eShowOn to always show eShowAutomatic to show when window is active

getShowTabs

public short getShowTabs()
Returns the display status and position of the sheet name tabs on a workbook.

Returns:
the display status value

getShowVScrollBar

public short getShowVScrollBar()
Returns the mode for the vertical scroll bar.

Returns:
the mode for the vertical scroll bar: eShowOff to never show eShowOn to always show eShowAutomatic to show when appropriate

getTabbedText

public java.lang.String getTabbedText(int row1,
                                      int row2,
                                      int col1,
                                      int col2,
                                      boolean valuesOnly)
                               throws CellException
Takes the specified range of data and converts it to a tab-delimited block of text.

Parameters:
row1 - - the beginning row for the range
row2 - - the ending row for the range
col1 - - the beginning column for the range
col2 - - the ending column for the range
valuesOnly - - true if text is unformatted, false if text is formatted
Returns:
the tab-delimited text string
Throws:
CellException

getText

public java.lang.String getText()
                         throws CellException
Returns the text representation of the value of the active cell.

Returns:
the text representation of the value of the active cell
Throws:
CellException - if there is no active cell

getText

public java.lang.String getText(int row,
                                int col)
                         throws CellException
Returns the text value of the specified cell

Parameters:
row - - identifies the cell row by number
col - - identifies the cell column by number
Returns:
the text value of the specified cell
Throws:
CellException

getText

public java.lang.String getText(int sheet,
                                int row,
                                int col)
                         throws CellException
Returns the text value of the specified cell

Parameters:
sheet - - identifies the worksheet by number
row - - identifies the cell row by number
col - - identifies the cell column by number
Returns:
the text value of the specified cell
Throws:
CellException

getTopLeftText

public java.lang.String getTopLeftText()
Returns the text displayed at the intersection of the row and column headings in the top left corner, affects all selected sheets.

Returns:
the top left corner text

getTopRow

public int getTopRow()
              throws CellException
Returns the top row displayed in the active worksheet.

Returns:
the row number
Throws:
CellException - if the view is not visible

getType

public short getType()
              throws CellException
Returns the cell type of the active cell.

Returns:
the cell type of the active cell
Throws:
CellException

getType

public short getType(int row,
                     int col)
              throws CellException
Returns the cell type of the specified cell.

Parameters:
row - - identifies the cell row by number
col - - identifies the cell column by number
Returns:
the cell type of the active cell
Throws:
CellException

getType

public short getType(int sheet,
                     int row,
                     int col)
              throws CellException
Returns the cell type of the specified cell.

Parameters:
sheet - - identifies the worksheet by number
row - - identifies the cell row by number
col - - identifies the cell column by number
Returns:
the cell type of the active cell
Throws:
CellException

getVersion

public static int getVersion()
Returns the version of the component.

Returns:
the version of the component

getVersionString

public static java.lang.String getVersionString()
Returns the version of the component in a string.

Returns:
a string describing the version of the component

getViewScale

public int getViewScale()
Returns the current display scale for a workbook.

Returns:
the current display scale, ranging from 10 to 400 percent, 100 percent is normal

getWorkbookName

public java.lang.String getWorkbookName()
Returns the name assigned to the workbook associated with the current view control

Returns:
the name assigned to the workbook associated with the current view.

init

public void init()
Reads and acts on applet parameters. The parameters, in the order they are read are: GROUP: Calls com.jxcell.View.setGroup(GROUP). WORKBOOKNAME: Attempts to attach to another workbook by calling com.jxcell.View.attach(WORKBOOKNAME). If this fails, the workbook name is set by calling com.jxcell.View.setWorkbookName(WORKBOOKNAME). WORKBOOK: Ignored if the WORKBOOKNAME parameter causes this view to successfully attach to another workbook. Otherwise, the WORKBOOK parameter is used to attempt to read a workbook from a URL by calling com.jxcell.View.readURL(WORKBOOK);


initWorkbook

public void initWorkbook()
                  throws CellException,
                         java.lang.OutOfMemoryError
Throws:
CellException
java.lang.OutOfMemoryError

insertRange

public void insertRange(int row1,
                        int col1,
                        int row2,
                        int col2,
                        short shifttype)
                 throws CellException
Moves the specified range in order to insert new cells, rows or columns. Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0

Parameters:
row1 - - range starting row
col1 - - range starting column
row2 - - range ending row
col2 - - range ending column
shifttype - - determines how the range cells should be shifted: eShiftHorizontal = 1; eShiftVertical = 2; eShiftRows = 3; eShiftColumns = 4;
Throws:
CellException

insertSheets

public void insertSheets(int sheet,
                         int sheets)
                  throws CellException
Inserts one or more worksheets at the specified location.

Parameters:
sheet - - identifies the index of the worksheet in front of which you want to insert the new sheets Sheets are indexed from left to right beginning with 0. Do not confuse the index with the sheet name that appears on the sheet tab.
sheets - - determines how many sheets are inserted before sheet
Throws:
CellException

isAllowArrows

public boolean isAllowArrows()
Returns true if arrow keys can be used to navigate the worksheet. If true, the arrow keys on your keyboard move the active cell in the spreadsheet.

Returns:
true if arrow keys can be used to navigate the worksheet, false otherwise

isAllowAutoFill

public boolean isAllowAutoFill()
Returns true if auto fill is enabled.

Returns:
true if auto fill is enabled, false otherwise

isAllowDelete

public boolean isAllowDelete()
Returns true if the delete key deletes records and clears selection.

Returns:
true if the delete key deletes records and clears selection, false otherwise

isAllowDesigner

public boolean isAllowDesigner()
Returns true if the Workbook Designer can be launched at run time. When this property is True, you can display the Workbook Designer by double-clicking the right mouse on the workbook control.

Returns:
true if the Workbook Designer can be launched at run-time, false otherwise

isAllowEditHeaders

public boolean isAllowEditHeaders()
Returns true if users can edit row, column and top left headers.

Returns:
true if users can edit headers, false otherwise.

isAllowFillRange

public boolean isAllowFillRange()
Returns true if the user is allowed to fill a range by clicking and dragging with the mouse, false otherwise.

Returns:
true if the user is allowed to fill a range by clicking and dragging with the mouse, false otherwise.

isAllowFormulas

public boolean isAllowFormulas()
Returns true if the user is allowed to enter and edit formulas, false otherwise.

Returns:
true if the user is allowed to enter and edit formulas, false otherwise

isAllowInCellEditing

public boolean isAllowInCellEditing()
Returns true if cells are edited in place, false otherwise.

Returns:
true if cells are edited in place, false otherwise

isAllowMoveRange

public boolean isAllowMoveRange()
Returns true of the user is allowed to move a range by clicking and dragging with the mouse, false otherwise.

Returns:
true of the user is allowed to move a range by clicking and dragging with the mouse, false otherwise

isAllowObjSelections

public boolean isAllowObjSelections()
Returns true if objects can be selected.

Returns:
true if objects can be selected, false otherwise.

isAllowResize

public boolean isAllowResize()
Returns true if the user is allowed to resize rows and columns with the mouse, false otherwise.

Returns:
true if the user is allowed to resize rows and columns with the mouse, false otherwise

isAllowSelections

public boolean isAllowSelections()
Returns true if the user is allowed to change the selection with the keyboard or mouse, false otherwise.

Returns:
true if the user is allowed to change the selection with the keyboard or mouse, false otherwise

isAllowTabs

public boolean isAllowTabs()
Returns true if the TAB key can be used to reposition the active cell in a selected range. The tab key moves the active cell through the selected range from left to right through each row in the range.

Returns:
true if the TAB key can be used to reposition the active cell, false otherwise

isApplet

public boolean isApplet()
Returns true if JXCell is being run as an applet.


isAutoRecalc

public boolean isAutoRecalc()
Returns whether or not automatic recalc is on.

Returns:
true if automatic recalc is on, false otherwise

isBorder

public boolean isBorder()
Returns whether or not a black border is painted around the workbook.

Returns:
true if workbook border is on, false otherwise

isCanEditPaste

public boolean isCanEditPaste()
Returns true if the internal clipboard or Windows' clipboard contains items that can be pasted to the worksheet.

Returns:
true if there is data to paste, false otherwise

isCanEditPasteSpecial

public boolean isCanEditPasteSpecial()
Returns true if the internal clipboard or Windows' clipboard contains items that can be pasted to the worksheet using the Paste Special command.

Returns:
true if there is data to paste, false otherwise

isColHeaderSelected

public boolean isColHeaderSelected()
Returns true if the column headings are selected.

Returns:
true if the column headings are selected, false otherwise

isColHidden

public boolean isColHidden(int col)
                    throws CellException
Returns true if the column is hidden.

Parameters:
col - - identifies a column by number, columns are indexed from left to right beginning at 0
Returns:
true if the column is hidden, false otherwise.
Throws:
CellException - if a parameter is invalid

isCompressed

public boolean isCompressed()
Returns true if a workbook is saved in a compressed format.

Returns:
true if workbook is saved in compressed format, false otherwise

isDefaultRowHeightAutomatic

public boolean isDefaultRowHeightAutomatic()
Returns true if row height is automatic.

Returns:
true if row height is automatic, false otherwise

isEnableProtection

public boolean isEnableProtection()
Returns true if protection is enabled for all sheets in a workbook. Enabling protection means that any cells marked as hidden or locked are actually hidden and locked.

Returns:
true if protection is enabled for the current sheet, false otherwise

isEnableProtection

public boolean isEnableProtection(int sheet)
                           throws CellException
Returns true if protection is enabled for all sheets in a workbook.

Parameters:
sheet - - the number of the sheet to check. Enabling protection means that any cells marked as hidden or locked are actually hidden and locked.
Returns:
true if protection is enabled for the current sheet, false otherwise
Throws:
CellException

isEnterMovesDown

public boolean isEnterMovesDown()
Returns true if the enter key moves to the next cell.

Returns:
true if the enter key moves to the next cell, false otherwise

isFormatPaintMode

public boolean isFormatPaintMode()
Returns true if FormatPaint Mode is enabled. FormatPaintMode implies that formats from a selected range of cells are available to be copied to another range of cells. If true, this method has the same effect as clicking the Format Painter toolbar button in the Workbook Designer. The Format Painter allows you to select cells, click the Format Painter icon in order to copy their formats, and then "internal" those formats to another selection of cells.

Returns:
true if FormatPaintMode is enabled, false otherwise.

isIterationEnabled

public boolean isIterationEnabled()
Returns true if iteration is enabled.

Returns:
true if iteration is enabled, false otherwise Iteration can be used to solve circular references. JXCell calculates until it iterates the number of times specified by the setIterationMax property or until all cells change by less than the amount specified in the setIterationMaxChange property.

isLaunchWorkbookDesigner

public boolean isLaunchWorkbookDesigner()
Returns false.

Returns:
false

isLogical

public boolean isLogical()
                  throws CellException
Returns the logical (True or False) value of the active cell. If the cell contains a number, its logical value is True for nonzero values, and False for zero values. If the cell has text that can be converted to a number, the text is converted and treated as a numeric cell. If the cell contains a formula, the above rules apply depending on the formula's result. All other cells, including empty cells, have a False logical value. The text "True" and "False" are returned as True and False, respectively. If the cell contains a formula, the formula is deleted when the logical value is assigned.

Returns:
the logical value of the active cell
Throws:
CellException

isLogical

public boolean isLogical(int row,
                         int col)
                  throws CellException
Returns the logical (True or False) value of the specified cell. If the cell contains a number, its logical value is True for nonzero values, and False for zero values. If the cell has text that can be converted to a number, the text is converted and treated as a numeric cell. If the cell contains a formula, the above rules apply depending on the formula's result. All other cells, including empty cells, have a False logical value. The text "True" and "False" are returned as True and False, respectively. If the cell contains a formula, the formula is deleted when the logical value is assigned.

Parameters:
row - - identifies the row by number
col - - identifies the column by number
Returns:
the logical value of the specified cell.
Throws:
CellException

isLogical

public boolean isLogical(int nSheet,
                         int nRow,
                         int nCol)
                  throws CellException
Returns the logical (True or False) value of the specified cell. If the cell contains a number, its logical value is True for nonzero values, and False for zero values. If the cell has text that can be converted to a number, the text is converted and treated as a numeric cell. If the cell contains a formula, the above rules apply depending on the formula's result. All other cells, including empty cells, have a False logical value. The text "True" and "False" are returned as True and False, respectively. If the cell contains a formula, the formula is deleted when the logical value is assigned.

Parameters:
nSheet - - identifies the sheet by number
nRow - - identifies the row by number
nCol - - identifies the column by number
Returns:
the logical value of the specified cell.
Throws:
CellException

isPrecisionAsDisplayed

public boolean isPrecisionAsDisplayed()
Returns true if all cell values are rounded to the displayed precision, False otherwise. If True, the value in each cell is rounded to the precision displayed in the cell. If False, the value in each cell is stored as entered or calculated. If this method returns True on a workbook already containing data, all data in the workbook will permanently lose its precision.

Returns:
true if all cell values are rounded to the displayed precision, false otherwise

isPrintColHeading

public boolean isPrintColHeading()
Returns True if column headings are enabled and printed at the top of the worksheet, False otherwise.

Returns:
True if column headings are enabled and printed at the top of the worksheet, False otherwise

isPrintGridLines

public boolean isPrintGridLines()
Returns True if grid lines are printed for the current sheet, False otherwise

Returns:
true if grid lines are printed for the current sheet, false otherwise

isPrintHCenter

public boolean isPrintHCenter()
Returns whether or not the current sheet centered horizontally when printed.

Returns:
true if the current sheet is centered horizontally when printed, false otherwise

isPrintLandscape

public boolean isPrintLandscape()
Returns True if the workbook is printed with a landscape orientation, False otherwise.

Returns:
True if the workbook is printed with a landscape orientation, False otherwise

isPrintLeftToRight

public boolean isPrintLeftToRight()
Returns whether the current sheet is printed left to right then top to bottom, or top to bottom then left to right.

Returns:
true if the current sheet is printed left to right, false otherwise

isPrintNoColor

public boolean isPrintNoColor()
Returns True if all workbook colors are converted to black and white, and all patterns are removed, False otherwise.

Returns:
true if all workbook colors are converted to black and white, and all patterns are removed, false otherwise

isPrintRowHeading

public boolean isPrintRowHeading()
Returns whether or not row headings are printed for the current sheet.

Returns:
true if row headings are printed for the current sheet, false otherwise

isPrintScaleFitToPage

public boolean isPrintScaleFitToPage()
Returns True if the workbook is printed on the number of vertical and horizontal pages returned by the setPrintScaleFitHPages method, returns False if the scale percentage returned is used to print the workbook.

Returns:
true if the workbook is printed on the number of vertical and horizontal pages returned by the setPrintScaleFitHPages method, returns false if the scale percentage returned is used to print the workbook.

isPrintVCenter

public boolean isPrintVCenter()
Returns True if the current sheet is centered vertically when printed, False otherwise.

Returns:
true if the current sheet is centered vertically when printed, false otherwise

isRepaint

public boolean isRepaint()
Returns True if repainting occurs in the entire window when Windows sends a WM_PAINT message, False otherwise.

Returns:
The repaint flag is not saved to disk. The default repaint setting for a new view is always True.

isRowHeaderSelected

public boolean isRowHeaderSelected()
Returns True if row headings are selected, False otherwise.

Returns:
true if row headings are selected, false otherwise

isRowHeightAutomatic

public boolean isRowHeightAutomatic(int row)
                             throws CellException
Returns True if row height is automatic, False otherwise.

Parameters:
row - - identifies the row by number
Returns:
true if row height is automatic, false otherwise
Throws:
CellException - if a parameter is invalid

isRowHidden

public boolean isRowHidden(int row)
                    throws CellException
Returns True if row is hidden, False otherwise. .

Parameters:
row - - identifies the row by number
Returns:
true if row is hidden, false otherwise
Throws:
CellException

isRowMode

public boolean isRowMode()
Returns True if an entire row is selected when you select a cell, false otherwise.

Returns:
Returns True if an entire row is selected when you select a cell, false otherwise.

isScrollToLastRC

public boolean isScrollToLastRC()
Returns True if scroll bars can scroll the last filled cell in the workbook to the top-left edge of the window. Returns False if scrolling stops when the last filled row and column reach the bottom-right edge of the screen.

Returns:
true if the last filled cell scrolls to the top-left edge of the window

isSheetSelected

public boolean isSheetSelected(int sheet)
                        throws CellException
Returns True if worksheet is selected, False otherwise.

Parameters:
sheet - - identifies the worksheet by number
Returns:
true if worksheet is selected, false otherwise
Throws:
CellException - if a parameter is invalid

isShowColHeading

public boolean isShowColHeading()
Returns True if column headings are displayed, False otherwise.

Returns:
true if column headings are displayed.

isShowEditBar

public boolean isShowEditBar()
Returns True if the edit bar is displayed with the workbook, False otherwise. The edit bar does not appear until the container makes it UI active (provides a window for it)

Returns:
true if the edit bar is displayed with the workbook, false otherwise

isShowEditBarCellRef

public boolean isShowEditBarCellRef()
Returns True if isShowEditBar is True. If isShowEditBar is True, the cell reference of the active cell in the active worksheet is displayed with the edit bar. If isShowEditBar is False, ShowEditBarCellRef has no effect.

Returns:
true if isShowEditBar is true

isShowFormulas

public boolean isShowFormulas()
Returns True if formula text is displayed in cells instead of the values formulas produce, False otherwise. In order to accomplish this, column widths are shown at twice their actual size.

Returns:
true if formula text is displayed in cells instead of values, false otherwise.

isShowGridLines

public boolean isShowGridLines()
Returns true if grid lines are shown, false otherwise.

Returns:
true if grid lines are shown, false otherwise

isShowRowHeading

public boolean isShowRowHeading()
Returns true if row headings are shown, false otherwise.

Returns:
true if row headings are shown, false otherwise

isShowTypeMarkers

public boolean isShowTypeMarkers()
Returns True if the following frame types are used to identify different types of cells, False otherwise: Cell Type Frame Marker Empty cell None Blank formatted cell Blue frame Value cell (holds a number or text) Green frame Formula cell Red frame

Returns:
true if frame types are used to identify different types of cells

isShowZeroValues

public boolean isShowZeroValues()
Returns True if cells with zero values are displayed, False, otherwise

Returns:
true if cells with zero values are displayed

isTopLeftHeaderSelected

public boolean isTopLeftHeaderSelected()
Returns True if top left header is selected, False otherwise.

Returns:
true if top left header is selected, false otherwise

launchDesigner

public void launchDesigner()
Displays the Workbook Designer.


messageBox

public int messageBox(java.lang.String message,
                      java.lang.String caption,
                      short type)
Displays a message in a dialog box, waits for the user to click a button, and returns an Integer indicating which button the user clicked.

Parameters:
message - - the text displayed in the message box
caption - - text displayed in the title bar of the message box
type - - the sum of values specifying the number and type of buttons to display in the message box
Returns:
int number identifying the button the user clicked in response

moveRange

public void moveRange(int row1,
                      int col1,
                      int row2,
                      int col2,
                      int rowOffset,
                      int colOffset)
               throws CellException
Moves a range of cells.

Parameters:
row1 - - specifies the source row of the range
col1 - - specifies the source column of the range
row2 - - specifies the destination row of the range
col2 - - specifies the destination column of the range
rowOffset - - specifies the offset of the destination row from the source row
colOffset - - specifies the offset of the destination column from the source column
Throws:
CellException

objectBringToFront

public void objectBringToFront()
Places the selected objects in front of all unselected objects in a view. If the selected objects overlap unselected objects in the active worksheet, the selected objects are displayed in front of the unselected objects. If a group of objects are selected, the order of the objects within the selection is unchanged.


objectPosToTwips

public short objectPosToTwips(double x1,
                              double y1,
                              double x2,
                              double y2,
                              java.awt.Rectangle rectangle)
                       throws CellException
Given an object position in relation to rows and columns, this method returns the object position in twips.

Parameters:
x1 - - number of columns from the left edge of the worksheet to where the left edge of the object is placed.
y1 - - number of rows from the top edge of the worksheet to where the top of the object is placed.
x2 - - number of columns from the left edge of the worksheet to where the right edge of the object is placed.
y2 - - number of rows from the top edge of the worksheet to where the bottom of the object is placed.
Returns:
an instance of the Rect object
Throws:
CellException

objectSendToBack

public void objectSendToBack()
Places the selected objects behind all unselected objects in a view. If the selected objects overlap unselected objects in the active worksheet, the selected objects are displayed behind the unselected objects. If a group of objects are selected, the order of the objects within the selection is unchanged.


rangeToPixels

public short rangeToPixels(int row1,
                           int col1,
                           int row2,
                           int col2,
                           java.awt.Rectangle rectangle)
                    throws CellException
Returns the offset, width, and height of the specified range in pixels.

Parameters:
row1 - - the beginning row of the range
col1 - - the beginning column of the range
row2 - - the ending row of the range
col2 - - the ending column of the range
Returns:
1 if range is visible, 2 if range is partially visible or 0 if range is not visible
Throws:
CellException

rangeToTwips

public short rangeToTwips(int row1,
                          int col1,
                          int row2,
                          int col2,
                          java.awt.Rectangle rectangle)
                   throws CellException
Determines the offset, width, and height of the specified range in twips.

Parameters:
row1 - - the beginning row of the range
col1 - - the beginning column of the range
row2 - - the ending row of the range
col2 - - the ending column of the range
Returns:
1 is range is visible, 2 if range is partially visible or 0 if range is not visible
Throws:
CellException

read

public short read(java.io.InputStream inputstream)
           throws java.io.IOException,
                  CellException
Reads a worksheet or workbook from disk

Parameters:
inputstream - - an input stream
Returns:
the value retrieved from the stream
Throws:
CellException
java.io.IOException

read

public short read(java.lang.String string)
           throws java.io.IOException,
                  CellException
Reads a worksheet or workbook from disk. If the filename begins with "http:" or "https:" or "file:", read() calls readURL()

Parameters:
string - - the path and filename of the worksheet or workbook
Returns:
the value retrieved from the string
Throws:
CellException
java.io.IOException

readFromBlob

public short readFromBlob(byte[] blob)
                   throws CellException,
                          java.io.IOException
Reads a worksheet or workbook that has been stored in memory in a byte array

Parameters:
blob - - reference to a byte array
Returns:
the value retrieved from the byte array
Throws:
CellException - if an error occurs reading the file
java.io.IOException - if an IO error occurs

readURL

public short readURL(java.lang.String spec)
              throws java.io.IOException,
                     CellException
Loads a worksheet from a URL address.

Parameters:
spec - - the string containing the URL address
Returns:
short the value retrieved from the stream
Throws:
CellException
java.io.IOException

recalc

public void recalc()
            throws CellException
Recalculates the workbook attached to a view. Recalc recalculates all formulas in the workbook attached to the specified view

Throws:
CellException

releaseLock

public final void releaseLock()
Release a lock obtained by getLock(). ReleaseLock() must be called once for each call to getLock(). Typically releaseLock() should be used in the following fashion: ... view.getLock() try { ... } finally { view.releaseLock(); } ...


removeCancelEditListener

public void removeCancelEditListener(CancelEditListener canceleditlistener)
Removes the specified listener so it no longer receives events

Parameters:
canceleditlistener - - the CancelEdit listener to be removed

removeColPageBreak

public void removeColPageBreak(int col)
                        throws CellException
Removes a a vertical page break adjacent to the left edge of the specified column.

Parameters:
col - - identifies the current column where the page break is removed.
Throws:
CellException

removeEndEditListener

public void removeEndEditListener(EndEditListener endeditlistener)
Removes the specified listener so it no longer receives events

Parameters:
endeditlistener - - the EndEdit listener to be removed

removeEndRecalcListener

public void removeEndRecalcListener(EndRecalcListener endrecalclistener)
Removes the specified listener so it no longer receives events

Parameters:
endrecalclistener - - the EndRecalc listener to be removed

removeModifiedListener

public void removeModifiedListener(ModifiedListener modifiedlistener)
Removes the specified listener so it no longer receives events

Parameters:
modifiedlistener - - the Modified listener to be removed

removeObject

public void removeObject(GRObject grobject)
                  throws CellException
Removes the specified object.

Parameters:
grobject - - an instance of GRObject
Throws:
CellException - if the object is not found

removeObjectListener

public void removeObjectListener(ObjectListener objectlistener)
Removes the specified listener so it no longer receives events

Parameters:
objectlistener - - the Object listener to be removed

removePageBreak

public void removePageBreak()
                     throws CellException
Removes vertical and horizontal page breaks adjacent to the current cell. If a horizontal page break is adjacent to the top edge of the active cell, it is removed. In addition, if a vertical page break is adjacent to the left edge of the active cell, it is also removed.

Throws:
CellException

removeRowPageBreak

public void removeRowPageBreak(int row)
                        throws CellException
Removes a horizontal page break adjacent to the current cell

Parameters:
row - - row where the page break is removed
Throws:
CellException

removeSelectionChangedListener

public void removeSelectionChangedListener(SelectionChangedListener selectionchangedlistener)
Removes the specified listener so it no longer receives events

Parameters:
selectionchangedlistener - - the SelectionChanged listener to be removed

removeStartEditListener

public void removeStartEditListener(StartEditListener starteditlistener)
Removes the specified listener so it no longer receives events

Parameters:
starteditlistener - - the StartEdit listener to be removed

removeStartRecalcListener

public void removeStartRecalcListener(StartRecalcListener startrecalclistener)
Removes the specified listener so it no longer receives events

Parameters:
startrecalclistener - - the StartRecalc listener to be removed

removeUpdateListener

public void removeUpdateListener(UpdateListener updatelistener)
Removes the specified listener so it no longer receives events

Parameters:
updatelistener - - the Update listener to be removed

removeValidationFailedListener

public void removeValidationFailedListener(ValidationFailedListener validationfailedlistener)
Removes the specified listener so it no longer receives events

Parameters:
validationfailedlistener - - the ValidationFailed listener to be removed

removeViewChangedListener

public void removeViewChangedListener(ViewChangedListener viewchangedlistener)
Removes the specified listener so it no longer receives events

Parameters:
viewchangedlistener - - the ViewChanged listener to be removed

replace

public boolean replace(java.lang.String findWhat,
                       java.lang.String replaceWith,
                       int flags,
                       FindReplaceInfo findreplaceinfo)
                throws CellException
Invokes a find and replace session in a JXCell workbook and sets the criteria for the find and replace actions. The Replace method allows you to indicate the search string you wish to find, the replace string you wish to replace it with, and the range of cells you wish to search within the worksheet. When the search locates a matching string, it highlights the cell containing that string with a selection border. You can also set a series of flags indicating how the search session should be conducted and the particular replace action you desire.

Parameters:
findWhat - - the search string
replaceWith - - the replace string
flags - - one or more of the following search flags: FindReplaceInfo.kMatchCase to match case exactly. FindReplaceInfo.kMatchEntireCells to only return cells whose entire contents match findWhat. FindReplaceInfo.kByRows to search by rows and then by columns (default). FindReplaceInfo.kByColumns to search by columns and then by rows. This option is slower than FindReplaceInfo.kByRows. FindReplaceInfo.kInValues to search values (default). FindReplaceInfo.kInFormulas to search formulas. FindReplaceInfo.kReplaceAll to replace for all occurrences (replace only).
findreplaceinfo - - an instance of FindReplaceInfo
Returns:
boolean True if a replace operation was performed
Throws:
CellException

saveWindowInfo

public void saveWindowInfo()

setActiveCell

public void setActiveCell(int row,
                          int col)
                   throws CellException
Sets the row and column coordinates of the active cell The active cell is the cell in which the cursor is currently located. It is the cell in which data is entered or edited if the user starts typing.

Parameters:
row - - the active cell row coordinate
col - - the active cell column coordinate
Throws:
CellException

setAllowArrows

public void setAllowArrows(boolean allowArrows)
Sets a value indicating whether or not arrows keys can reposition the active cell.

Parameters:
allowArrows - - true if the arrow keys on your keyboard move the active cell in the spreadsheet false if arrow keys cannot move the active cell.

setAllowAutoFill

public void setAllowAutoFill(boolean allowAutoFill)
Sets a value indicating whether auto fill is enabled.

Parameters:
allowAutoFill - - true if autofill is enabled.

setAllowDelete

public void setAllowDelete(boolean allowDelete)
Sets a value indicating whether the delete key clears selections.

Parameters:
allowDelete - - true if the delete key clears selections.

setAllowDesigner

public void setAllowDesigner(boolean allowDesigner)
Sets whether the Workbook Designer can be launched at run time

Parameters:
allowDesigner - - true if the designer can be launched at run time.

setAllowEditHeaders

public void setAllowEditHeaders(boolean allowEditHeaders)
Sets a value indicating whether row, column, and top left headers can be edited.

Parameters:
allowEditHeaders - - true if row, column and top left headers can be edited, false, otherwise You can edit the names displayed in row, column, and top left headers by double-clicking a header. This displays the Header Name dialog box, which allows you to enter a new header name.

setAllowFillRange

public void setAllowFillRange(boolean allowFillRange)
Sets the flag which determines whether users are allowed to fill a range by clicking and dragging with the mouse.

Parameters:
allowFillRange - - true if the user will be allowed to fill a range by clicking and dragging with the mouse

setAllowFormulas

public void setAllowFormulas(boolean allowFormulas)
Sets the flag which determines whether the user is allowed to enter and edit formulas.

Parameters:
allowFormulas - - true if the user will be allowed to enter and edit formulas, false otherwise

setAllowInCellEditing

public void setAllowInCellEditing(boolean allowInCellEditing)
Sets the flag which determines whether cells are edited in place.

Parameters:
allowInCellEditing - - true if cells are to be edited in place, false otherwise

setAllowMoveRange

public void setAllowMoveRange(boolean allowMoveRange)
Sets the flag which determines whether users are allowed to move a range by clicking and dragging with the mouse

Parameters:
allowMoveRange - - true if the user will be allowed to move a range by clicking and dragging with the mouse

setAllowObjectSelections

public void setAllowObjectSelections(boolean allowObjectSelections)
Sets a flag indicating whether you can select objects at run time.

Parameters:
allowObjectSelections - - true if objects can be selected at run time, false otherwise

setAllowResize

public void setAllowResize(boolean allowResize)
Sets a value indicating whether you can resize rows and columns by dragging them.

Parameters:
allowResize - - true if rows and columns can be resized by dragging

setAllowSelections

public void setAllowSelections(boolean allowSelections)
Sets the flag which determines whether a user is allowed to change the selections with the keyboard or mouse.

Parameters:
allowSelections - - true if the user is allowed to change selections with the keyboard or mouse, false otherwise

setAllowTabs

public void setAllowTabs(boolean allowTabs)
Sets a value indicating whether you can use the TAB key to reposition the active cell in a selected range. When tabbing through a range, the active cell moves from left to right through each row in the range. By default, the allow tabs flag is True.

Parameters:
allowTabs - - true if the TAB key moves the active cell through a selected range, false, otherwise.

setAutoFillItems

public void setAutoFillItems(int index,
                             java.lang.String items)
                      throws CellException
Sets an autofill list.

Parameters:
index - - identifies the list's position within all defined autofill lists The first autofill list has an index of zero.
items - - the list of autofill items Autofill lists are frequently used series of text such as months and days of the week. When you enter a text value from an autofill list and move one cell down or to the right, the next text value in the list is proposed for that cell. You can also use the fill handle to autofill a single row or column
Throws:
CellException

setAutoRecalc

public void setAutoRecalc(boolean autoRecalc)
Sets the flag which determines whether or not automatic recalc is on.

Parameters:
autoRecalc - - true if the workbook should recalculate in the background, automatically, false otherwise

setBorder

public void setBorder(boolean border)
Sets wether the workbook has a border painted around it.

Parameters:
border - - true if the workbook should have a border painted around it, false otherwise

setBackColor

public void setBackColor(java.awt.Color color)
Sets the background color.

Parameters:
color - - the new background color in the form 0x00rrggbb

setCellFormat

public void setCellFormat(CellFormat cellformat)
                   throws CellException
Sets the format of the selected range of cells

Parameters:
cellformat - - an instance of the CellFormat object
Throws:
CellException

setCellFormat

public void setCellFormat(CellFormat cellformat,
                          int row1,
                          int col1,
                          int row2,
                          int col2)
                   throws CellException
Sets the format of the specified range of cells Rows are indexed from top to bottom beginning with 0; sheets and columns are indexed from left to right beginning with 0.

Parameters:
cellformat - - an instance of a CellFormat object
row1 - - the first row in the range
col1 - - the first column in the range
row2 - - the ending row in the range
col2 - - the ending column in the range
Throws:
CellException

setCellFormat

public void setCellFormat(CellFormat cellformat,
                          int sheet1,
                          int row1,
                          int col1,
                          int sheet2,
                          int row2,
                          int col2)
                   throws CellException
Sets the format of the specified range of cells in the specified range of sheets

Parameters:
cellformat - - an instance of a CellFormat object
sheet1 - - the beginning sheet
row1 - - the first row in the range
col1 - - the first column in the range
sheet2 - - the ending sheet
row2 - - the ending row in the range
col2 - - the ending column in the range
Throws:
CellException

setClip

public void setClip(java.lang.String text)
             throws CellException
Exports a tab-delimited text block to a worksheet at run time. When placing a block of text in a worksheet, text placement begins with the active cell. Tab characters (ANSI character 9) in the text block move text placement to the next column; carriage returns (ANSI character 13), line feeds (ANSI character 10), and carriage return/line feed pairs move text placement to the following row.

Parameters:
text - - identifies a tab-delimited text block
Throws:
CellException

setClipboard

public static void setClipboard(java.awt.datatransfer.Clipboard clipboard)
Sets the clipboard to be used for clipboard operations.

Parameters:
clipboard - - the clipboard to use for clipboard operations This method sets the clipboard to be used for clipboard operations. To force JXCell to use the system clipboard you can call this method and pass in java.awt.Toolkit.getDefaultToolkit().getSystemClipboard() for the value of clipboard. JXCell does not use the system clipboard because it only works with java.awt.datatransfer.StringSelection objects on some platforms. To force JXCell to use the system clipboard you can call setClipboard(...).

setClipValues

public void setClipValues(java.lang.String text)
                   throws CellException
Exports tab-delimited text strings to a workbook at run time ignoring any formatting applied to the text. When placing a block of text in a worksheet, text placement begins with the active cell. Tab characters (ANSI character 9) in the text block move text placement to the next column; carriage returns (ANSI character 13), line feeds (ANSI character 10), and carriage return/line feed pairs move text placement to the following row.

Parameters:
text - - identifies a tab-delimited text block
Throws:
CellException

setCol

public void setCol(int col)
            throws CellException
Sets the column of the active cell.

Parameters:
col - - the new column for the active cell.
Throws:
CellException

setColHeaderSelected

public void setColHeaderSelected(boolean ColHeaderSelected)
Sets a value indicating whether or not column headers can be selected.

Parameters:
ColHeaderSelected - - true if column headers can be selected, false otherwise

setColHidden

public void setColHidden(int col,
                         boolean colHidden)
                  throws CellException
Sets a value indicating whether or not the specified column is hidden.

Parameters:
col - - number identifying the column
colHidden - - if true, the specified column is hidden
Throws:
CellException

setColHidden

public void setColHidden(int col1,
                         int col2,
                         boolean colHidden)
                  throws CellException
Sets the display status of the specified range of columns

Parameters:
col1 - - number identifying the beginning column
col2 - - number identifying the ending column
colHidden - - if true, the specified columns are hidden
Throws:
CellException

setColText

public void setColText(int col,
                       java.lang.String colText)
                throws CellException
Sets the label for a column. Affects all selected sheets. Naming a column is useful for labeling columns so they reflect the data in the column (e.g., column G might be named Total Sales). The column name is displayed in the column heading and is used for display purposes only. The column is still referred to by letter reference in formulas. The column name can be up to 9 lines and 254 bytes. A CR (carriage return) and LF (line feed) combination are counted as two characters.

Parameters:
col - - identifies a column by number
colText - - the column label text
Throws:
CellException

setColWidth

public void setColWidth(int col,
                        int width)
                 throws CellException
Sets the width of a single column. Column width can be specified in units equal to 1/256th of the character 0's width in the default font, or twips, depending on the setting of setColWidthUnits.

Parameters:
col - - identifies a column by number
width - - the width of the column
Throws:
CellException

setColWidth

public void setColWidth(int col1,
                        int col2,
                        int width,
                        boolean defColWidth)
                 throws CellException
Sets the width of a single column. Column width can be specified in units equal to 1/256th of the character 0's width in the default font, or twips, depending on the setting of setColWidthUnits.

Parameters:
col1 - - number identifying the beginning column
col2 - - number identifying the ending column
width - - the column width
defColWidth - - true if specified column width becomes default column width, false otherwise
Throws:
CellException

setColWidthAuto

public void setColWidthAuto(int row1,
                            int col1,
                            int row2,
                            int col2,
                            boolean setDefaults)
                     throws CellException
Sets the widths of the specified columns to automatically adjust to the largest column entry, including the header. SetColWidthAuto specifies that the widths of the columns in the specified range are automatically set to display the largest entry in the columns. The columns are set at least as wide as the default column width. If all rows are specified, the columns are made wide enough for the column headers as well as the specified cells.

Parameters:
row1 - - desc
col1 - - desc
row2 - - desc
col2 - - desc
setDefaults - - true if columns larger or smaller than the default column width are set to the default column width, false otherwise
Throws:
CellException

setColWidthTwips

public void setColWidthTwips(int col1,
                             int width)
                      throws CellException
Changes the width of one or more columns to the specified number of twips.

Parameters:
col1 - - identifies column whose width you want to change
width - - indicates the column width value in twips.
Throws:
CellException

setColWidthTwips

public void setColWidthTwips(int col1,
                             int col2,
                             int width,
                             boolean defColWidth)
                      throws CellException
Changes the width of one or more columns to the specified number of twips.

Parameters:
col1 - - identifies the beginning column in the block of cells whose width you want to change
col2 - - identifies the ending column in the block of cells whose width you want to change
width - - indicates the column width value in twips.
defColWidth - - true if the default width is set to Width, and the specified columns are set to the default width. In addition, any columns that use the default width are updated with the new default. False specifies that the default width is unchanged.
Throws:
CellException

setColWidthUnits

public void setColWidthUnits(short colWidthUnits)
                      throws CellException
Sets how the column width is stored and displayed. When you change the column width unit you are changing how widths are stored. Use care when switching back and forth. If you switch from character units to twips and back again, the character unit values may be slightly different due to mathematical rounding used in the conversion process.

Parameters:
colWidthUnits - - one of the following column width units: eColWidthUnitsNormal All column widths are converted to units equal to 1/256th of the character 0's width in the default font. This is the default column width unit. eColWidthUnitsTwips All widths in the workbook are converted to twips. This can allow more consistent sizing between printer output and screen display.
Throws:
CellException

setCompressed

public void setCompressed(boolean compressed)
Sets whether a workbook is saved in compressed format. JXCell save files in a compressed format. This format creates smaller, more efficient files. If you prefer to save the file in the older uncompressed format, set this method to False.

Parameters:
compressed - - true if workbook is compressed, false otherwise

setDefaultColWidth

public void setDefaultColWidth(int width)
                        throws CellException
Sets the default column width. Column width can be specified in units equal to 1/256th of the character 0's width in the default font, or twips, depending on the setting of setColWidthUnits.

Parameters:
width - - the column width This can allow more consistent sizing between printer output and screen display.
Throws:
CellException

setDefaultFont

public void setDefaultFont(java.lang.String fontName,
                           int fontSize)
Sets the default font and the font size.

Parameters:
fontName - - indicates the default font name
fontSize - - indicates the default font size When setting the size, you can specify points or twips. When specifying size in points, use a positive number; use a negative number when specifying twips. When specifying twips, setDefaultFont uses the absolute value of the number you provide for size.

setDefaultFontName

public void setDefaultFontName(java.lang.String fontName)
Sets the default font by name.

Parameters:
fontName - - indicates the default font name

setDefaultFontSize

public void setDefaultFontSize(int fontSize)
Sets the default font size.

Parameters:
fontSize - - indicates the size of the default font. When setting the size, you can specify points or twips. When specifying size in points, use a positive number; use a negative number when specifying twips. When specifying twips, setDefaultFontSize uses the absolute value of the number you provide for size.

setDefaultRowHeight

public void setDefaultRowHeight(int height)
                         throws CellException
Sets the default row height.

Parameters:
height - - indicates the row height value in twips. A twip is 1/1440th of an inch.
Throws:
CellException

setDefaultRowHeightAutomatic

public void setDefaultRowHeightAutomatic(boolean automatic)
                                  throws CellException
Sets whether the default row height is determined automatically.

Parameters:
automatic - - true if default row height is automatic
Throws:
CellException

setDefinedName

public void setDefinedName(java.lang.String name,
                           java.lang.String formula)
                    throws CellException
Sets the formula associated with a defined name, in US English.

Parameters:
name - - A defined name. Enter an existing name if you are returning the formula associated with the name or changing the value associated with the name. Enter a unique name if you are creating a new value.
formula - - Describes the range represented by name. A name can refer to a cell, a group of cells, a value, or a formula. When setting name, do not include a leading equal sign (=)in the formula
Throws:
CellException

setDefinedNameLocal

public void setDefinedNameLocal(java.lang.String name,
                                java.lang.String formula)
                         throws CellException
Sets the formula definition for a user-defined name, in the user's language. setDefinedNameLocal sets a string describing the formula for the specified name. For example, if the range $B$10:$F$10 is named TotalSales, a string is set containing the range reference $B$10:$F$10. Relative references in defined name formulas are relative to the active cell. Changing the active cell will offset relative references in defined names. Use this method if the user must see or enter the name in their own language. The values of this method change depending on the user's language. This can result in code that will not run correctly in another language version of JXCell.

Parameters:
name - - A defined name, in the user's language. Enter an existing name if you are setting the formula associated with the name or changing the value associated with the name. Enter a unique name if you are creating a new value.
formula - - Describes the range represented by name. A name can refer to a cell, a group of cells, a value, or a formula. When setting name, do not include a leading equal sign (=)in the formula
Throws:
CellException - if a parameter is invalid

setEnableProtection

public void setEnableProtection(boolean enableProtection)
Sets whether protection is enabled for all selected sheets. Enabling protection means that any cells marked as hidden or locked are actually hidden and locked.

Parameters:
enableProtection - - true if protection is enabled, false otherwise

setEnterMovesDown

public void setEnterMovesDown(boolean enterMovesDown)
Sets whether pressing the ENTER key moves the active cell down to the next cell.

Parameters:
enterMovesDown - - true if the ENTER key moves the active cell down

setEntry

public void setEntry(java.lang.String entry)
              throws CellException
Enters text in the active cell of all selected worksheets. This method allows you to enter information in a cell just as a user would enter information. The program automatically determines the kind of data entered (e.g., number, text, formula). It also recognizes dates, times, percentages, currency, fractions, and scientific notation and applies an appropriate number format. When setting formulas, precede the formula with an equal sign (=). Note This value is always in the user's language and should only be used to interact with the user. For internal purposes, use setFormula, setText, setNumber, and setLogical.

Parameters:
entry - - the cell value.
Throws:
CellException - if there is no selected cell

setEntry

public void setEntry(int row,
                     int col,
                     java.lang.String entry)
              throws CellException
Sets the value of a specified cell of all selected worksheets. This method allows you to enter information in a cell just as a user would enter information. The program automatically determines the kind of data entered (e.g., number, text, formula). It also recognizes dates, times, percentages, currency, fractions, and scientific notation and applies an appropriate number format. When setting formulas, precede the formula with an equal sign (=). Note This value is always in the user's language and should only be used to interact with the user. For internal purposes, use setFormula, setText, setNumber, and setLogical.

Parameters:
row - - a row number that identifies a cell.
col - - a column number that identifies a cell.
entry - - a cell value.
Throws:
CellException

setEntry

public void setEntry(int sheet,
                     int row,
                     int col,
                     java.lang.String entry)
              throws CellException
Sets the value of a specified cell on the specified worksheet This method allows you to enter information in a cell just as a user would enter information. The program automatically determines the kind of data entered (e.g., number, text, formula). It also recognizes dates, times, percentages, currency, fractions, and scientific notation and applies an appropriate number format. When setting formulas, precede the formula with an equal sign (=). Note This value is always in the user's language and should only be used to interact with the user. For internal purposes, use setFormula, setText, setNumber, and setLogical.

Parameters:
sheet - - a sheet number that identifies a worksheet.
row - - a row number that identifies a cell.
col - - a column number that identifies a cell.
entry - - a cell value.
Throws:
CellException

setExtraColor

public void setExtraColor(java.awt.Color extraColor)
Sets the color used to fill any extra space to the right and below the sheet.

Parameters:
extraColor - - new extra color in the form 0x00rrggbb

setFileName

public void setFileName(java.lang.String fileName)
                 throws java.io.IOException
Attaches a worksheet or workbook file to a view. If two views are in existence at the same time with the same setFileName setting, they are attached to the same file. This provides the same result as using the Attach method to attach two or more views to one workbook file. If the filename is set to an existing file at design time, a dialog box asks whether the file should be read immediately, not read immediately, or if the read request should be canceled. If the file is read immediately, the worksheet or workbook is loaded. The file can be a JXCell file or a tab-delimited text file. If you have purchased the Excel Read/Write add-0n package for JXCell, you can also open Excel files. When the form is saved, the workbook is saved in the file specified by setFileName as a JXCell file. You can also use the Read command on the File menu in the Workbook Designer to read in a file that you want to save in a form. Use setTableName and not setFileName to change the workbook name used by external references in formulas.

Parameters:
fileName - - a valid filename.
Throws:
java.io.IOException

setFixedCol

public void setFixedCol(int col)
                 throws CellException
Sets the number of fixed columns. The setFixedCol method is used with the setFixedCols method to fix one or more columns at the left edge of the active worksheet. The fixed columns do not scroll when the worksheet is scrolled horizontally. Individual cells in fixed columns cannot be selected with the mouse or keyboard.

Parameters:
col - - number of first fixed column.
Throws:
CellException - if col is not a valid column or if (col+ getFixedCols()) > kNrCols

setFixedCols

public void setFixedCols(int cols)
                  throws CellException
Sets the number of fixed columns. The setFixedCol method is used with the setFixedCols method to fix one or more columns at the left edge of the active worksheet. The fixed columns do not scroll when the worksheet is scrolled horizontally. Individual cells in fixed columns cannot be selected with the mouse or keyboard.

Parameters:
cols - - number of fixed columns Set this to zero to turn off fixed columns.
Throws:
CellException - if cols is less than zero or the value of getFixedCol + cols is greater than 256.

setFixedCols

public void setFixedCols(int nCol1,
                         int nCols)
                  throws CellException
Sets the number of fixed columns.

Parameters:
nCol1 - - the number of the first fixed column
nCols - - number of fixed columns. Set this to zero to turn off fixed columns.
Throws:
CellException

setFixedRow

public void setFixedRow(int row)
                 throws CellException
Sets the starting fixed row. The setFixedRow method is used with the setFixedRows method to fix one or more rows at the top of the worksheet. The fixed rows do not scroll when the worksheet is scrolled vertically. Individual cells in fixed rows cannot be selected with the mouse or keyboard.

Parameters:
row - - number of the starting fixed row.
Throws:
CellException - if row is not a valid row

setFixedRows

public void setFixedRows(int rows)
                  throws CellException
Sets the number of fixed rows. The setFixedRow method is used with the setFixedRows method to fix one or more rows at the top of the worksheet. The fixed rows do not scroll when the worksheet is scrolled vertically. Individual cells in fixed rows cannot be selected with the mouse or keyboard.

Parameters:
rows - - number of fixed rows Set this to zero to turn off fixed rows
Throws:
CellException - if rows is less than zero or getFixedRow + rows exceeds 256.

setFixedRows

public void setFixedRows(int nRow1,
                         int nRows)
                  throws CellException
Sets the number of fixed rows. The setFixedRow method is used with the setFixedRows method to fix one or more rows at the top of the worksheet. The fixed rows do not scroll when the worksheet is scrolled vertically. Individual cells in fixed rows cannot be selected with the mouse or keyboard.

Parameters:
nRow1 - - the number of the first row to fix
nRows - - number of fixed rows Set this to zero to turn off fixed rows.
Throws:
CellException - if rows is less than zero or getFixedRow + rows exceeds 256

setFormatPaintMode

public void setFormatPaintMode(boolean isFormatPaintMode)
                        throws CellException
Sets the Format Paint Mode. Calling this method with a True parameter has the same effect as clicking the Format Painter toolbar button in the Workbook Designer. The Format Painter allows you to select cells having formats to be copied, click the Format Painter icon, and then select other cells to which the formats are to be applied.

Parameters:
isFormatPaintMode - - Boolean that determines the state of the Format Paint Mode.
Throws:
CellException

setFormula

public void setFormula(java.lang.String formula)
                throws CellException
Sets the formula for the active cell for all selected sheets.

Parameters:
formula - - The formula for the active cell. The string should not have a leading equal sign (=).
Throws:
CellException - If there is no active cell or formula is not a valid workbook formula.

setFormula

public void setFormula(int row,
                       int col,
                       java.lang.String formula)
                throws CellException
Sets the formula for the specified cell in all selected sheets.

Parameters:
row - - number of a row that identifies a specific cell.
col - - number of a column that identifies a specific cell.
formula - - formula for the active cell. The string should not have a leading equal sign (=).
Throws:
CellException - If the string is not a valid workbook formula.

setFormula

public void setFormula(int sheet,
                       int row,
                       int col,
                       java.lang.String formula)
                throws CellException
Sets the formula for the specified cell on the specified sheet.

Parameters:
sheet - - The number of a worksheet.
row - - number of a row that identifies a specific cell.
col - - number of a column that identifies a specific cell.
formula - - formula for the active cell. The string should not have a leading equal sign (=).
Throws:
CellException - If the string is not a valid workbook formula.

setFormulaLocal

public void setFormulaLocal(java.lang.String formula)
                     throws CellException
Sets the text version of the formula in the active cell, in the user's language. Use this method to enter the text version (in the user's language) of the formula string in the active cell. Note Use this method if the user must see or enter the formula in their own language. The valid formula strings change depending on the user's language. This can result in code that will not run correctly in another language version of JXCell. If you want to ensure that formulas behave correctly regardless of the language they are loaded in, use the setFormula method.

Parameters:
formula - - The formula for the active cell. The string should not have a leading equal sign (=).
Throws:
CellException - If the string is not a valid workbook formula.

setFormulaLocal

public void setFormulaLocal(int row,
                            int col,
                            java.lang.String formula)
                     throws CellException
Sets the text version of the formula of the specified cell, in the user's language. Use this method to enter the text version (in the user's language) of the formula string in the active cell. Note Use this method if the user must see or enter the formula in their own language. The valid formula strings change depending on the user's language. This can result in code that will not run correctly in another language version of JXCell. If you want to ensure that formulas behave correctly regardless of the language they are loaded in, use the setFormula method.

Parameters:
row - - number of a row that identifies a specific cell..
col - - number of a column that identifies a specific cell.
formula - - The formula for the active cell. The string should not have a leading equal sign (=).
Throws:
CellException - If the string is not a valid workbook formula.

setFormulaLocal

public void setFormulaLocal(int sheet,
                            int row,
                            int col,
                            java.lang.String formula)
                     throws CellException
Sets the text version of the formula of the specified cell in the specified worksheet in the user's language. Use this method to enter the text version (in the user's language) of the formula string in the active cell. Note Use this method if the user must see or enter the formula in their own language. The valid formula strings change depending on the user's language. This can result in code that will not run correctly in another language version of JXCell. If you want to ensure that formulas behave correctly regardless of the language they are loaded in, use the setFormula method.

Parameters:
sheet - - The number of a worksheet.
row - - number of a row that identifies a specific cell..
col - - number of a column that identifies a specific cell.
formula - - The formula for the active cell. The string should not have a leading equal sign (=).
Throws:
CellException - If the string is not a valid workbook formula.

setGroup

public void setGroup(java.lang.String group)
              throws CellException
Sets the group name for the workbook attached to this view. Reasons to put multiple workbooks in the same group are: To enable external cell references between workbooks. To enable the com.jxcell.View.attach(String workbookName) method. To enable the WORKBOOKNAME applet parameter to attach multiple views (applets) to the same workbook. To ensure that all background processing is done on a single thread. To save resources (memory) by having multiple workbooks share resources. Disadvantages of putting multiple workbooks in the same group are: Lack of concurrency when manipulating multiple workbooks. Public methods must acquire a lock for all workbooks in it's group before proceeding. To allow this view, workbook, and other resources associated with it to be automatically garbage collected. If the workbook is part of a named group, it is referenced by a static collection of groups. This static reference makes it impossible for the Java VM to garbage collect this view and workbook. This can be overcome by calling the com.jxcell.View.destroy() method when the view is no longer needed. Each group has it's own thread for background processing as well as certain other resources used primarily for workbook formulas.

Parameters:
group - - the new group name for the workbook attached to this view. A value of null or "" will put the workbook in it's own group.
Throws:
CellException - if the group cannot be set due to lack of resources.

setHeaderHeight

public void setHeaderHeight(int height)
                     throws CellException
Sets the height of the column headers on all selected sheets.

Parameters:
height - - The height of the column header in twips. A twip is 1/1440 of an inch.
Throws:
CellException - if a parameter is invalid

setHeaderSelection

public void setHeaderSelection(boolean topLeftHeader,
                               boolean rowHeader,
                               boolean colHeader)
Sets whether the row and column headings are selected.

Parameters:
topLeftHeader - - Boolean that specifies whether the cell at the intersection of the row and column headings is selected.
rowHeader - - Boolean that specifies whether the row headers are selected.
colHeader - - Boolean that specifies whether the column headers are selected.

setHeaderWidth

public void setHeaderWidth(int width)
                    throws CellException
Sets the width of the row headers of all selected sheets. The units used to store or display width units depends on the column width units mode set by the * setColWidthUnits. If the mode is set to characters, the width is specified in units equal to 1/256th of the character 0's width in the default font. If the mode is set to twips, column widths are set in twips which are 1/440th of an inch. If you do any addition or subtraction of widths in your code, make sure that the units of the items you are using are the same.

Parameters:
width - - width of the row header.
Throws:
CellException

setIterationEnabled

public void setIterationEnabled(boolean iterationEnabled)
Sets whether iteration is enabled. Iteration can be used to solve circular references. JXCell calculates until it iterates the number of times specified by the setIterationMax method or until all cells change by less than the amount specified in the setIterationMaxChange method.

Parameters:
iterationEnabled - - Boolean that determines if iteration is enabled.

setIterationMax

public void setIterationMax(int iterationMax)
Sets the maximum number of iterations. Iteration can be used to solve circular references. JXCell calculates until it iterates the number of times specified by the setIterationMax method or until all cells change by less than the amount specified in the setIterationMaxChange method.

Parameters:
iterationMax - - Maximum number of iterations

setIterationMaxChange

public void setIterationMaxChange(double iterationMaxChange)
Sets the maximum iteration change value. Iteration can be used to solve circular references. JXCell calculates until it iterates the number of times specified by the setIterationMax method or until all cells change by less than the amount specified in the setIterationMaxChange method.

Parameters:
iterationMaxChange - - The maximum change value for iterations.

setLaunchWorkbookDesigner

public void setLaunchWorkbookDesigner(boolean launchWorkbookDesigner)
Brings up the Workbook Designer. Calling this method with a True parameter displays the Worksheet Designer. This is meant primarily for environments which let a JavaBean property be set but do not support customizers.

Parameters:
launchWorkbookDesigner - - Boolean that determins if the designer is launced.

setLeftCol

public void setLeftCol(int leftCol)
                throws CellException
Sets the leftmost column currently displayed in the view.

Parameters:
leftCol - - number of the leftmost column
Throws:
CellException

setLogical

public void setLogical(boolean logical)
                throws CellException
Sets the logical (True or False) value of the active cell in all selected worksheets.

Parameters:
logical - - Boolean specifies logical value for the active cell.
Throws:
CellException

setLogical

public void setLogical(int row,
                       int col,
                       boolean logical)
                throws CellException
Sets the logical (True or False) value of the specified cell in all selected worksheets.

Parameters:
row - - number of a row that identifies a specific cell.
col - - number of a column that identifies a specific cell.
logical - - Boolean specifies logical value for the cell.
Throws:
CellException

setLogical

public void setLogical(int sheet,
                       int row,
                       int col,
                       boolean logical)
                throws CellException
Sets the logical (True or False) value of the specified cell in the specified worksheet.

Parameters:
sheet - - number of a worksheet.
row - - number of a row that identifies a specific cell.
col - - number of a column that identifies a specific cell.
logical - - Boolean specifies logical value for the cell.
Throws:
CellException

setMaxCol

public void setMaxCol(int maxCol)
               throws CellException
Sets the maximum column which may be displayed in the current sheet. Columns beyond the last column are not displayed but can be used to hold data and formulas.

Parameters:
maxCol - - the maximum column which may be displayed in the current sheet.
Throws:
CellException - if maxCol is not a valid column number or if maxCol is less than getMinCol( )

setMaxRow

public void setMaxRow(int maxRow)
               throws CellException
Sets the maximum row which may be displayed in the current sheet. Rows beyond the last row are not displayed but can be used to hold data and formulas.

Parameters:
maxRow - - the maximum row which may be displayed in the current sheet.
Throws:
CellException - if maxRow is not a valid row number or if maxRow is less than getMinRow

setMinCol

public void setMinCol(int minCol)
               throws CellException
Sets the first column that can be displayed in the current worksheet. Columns before the first column are not displayed but can be used to hold data and formulas.

Parameters:
minCol - - the minimum column which may be displayed in the current sheet.
Throws:
CellException - if minCol is not a valid col number or if minCol is greater than getMaxCol

setMinRow

public void setMinRow(int minRow)
               throws CellException
Sets the first row that can be displayed in the current worksheet. Row before the first row are not displayed but can be used to hold data and formulas.

Parameters:
minRow - - the minimum column which may be displayed in the current sheet.
Throws:
CellException - if minRow is not a valid row number of if minRow is greater than getMaxRow

setMode

public void setMode(short mode)
             throws CellException
Sets the current mode for mouse actions in a view

Parameters:
mode - - mouse action mode: eModeNormal eModeLine eModeRectangle eModeOval eModeArc eModeText eModeButton eModePicture eModePolygon eModeDropDown eModeCheckBox eModeChart
Throws:
CellException - if a parameter is invalid

setNumber

public void setNumber(double number)
               throws CellException
Sets the numeric value of the active cell in all selected sheets.

Parameters:
number - - the cell value
Throws:
CellException - if there is no active cell.

setNumber

public void setNumber(int row,
                      int col,
                      double number)
               throws CellException
Sets the numeric value of the specified cell in all selected sheets.

Parameters:
row - - the number of a row that identifies a specific cell.
col - - the number of a column that identifies a specific cell.
number - - the cell value
Throws:
CellException - if row or column numbers are not valid

setNumber

public void setNumber(int sheet,
                      int row,
                      int col,
                      double number)
               throws CellException
Sets the numeric value of the specified cell in the specified worksheet.

Parameters:
sheet - - the number of a worksheet
row - - the number of a row that identifies a specific cell.
col - - the number of a column that identifies a specific cell.
number - - the cell value
Throws:
CellException - if sheet, row, or column numbers are not valid

setNumSheets

public void setNumSheets(int sheets)
                  throws CellException
Sets the number of worksheets in the current workbook. Use this method to change the number of worksheets in the workbook. Worksheets are added to or deleted from the end of the current list of worksheets. To add worksheets between existing worksheets, use insertSheets. To delete worksheets between existing worksheets, use deleteSheets.

Parameters:
sheets - - the number of worksheets that make up the workbook
Throws:
CellException

setPaletteEntry

public void setPaletteEntry(int entry,
                            java.awt.Color color)
                     throws CellException
Sets a color in the JXCell color palette.

Parameters:
entry - - Zero-based index of the entry to change. JXCell presents a color palette with 56 colors
color - - a java.awt.color object that describes a specific color
Throws:
CellException - if entry is invalid

setParentFrame

public void setParentFrame(java.awt.Frame frame)
Sets the window to display JXCell in.

Parameters:
frame - - a java.awt.frame object that describes the window.

setPolyEditMode

public void setPolyEditMode(short polyEditMode)
                     throws CellException
Sets the mode for interactive polygon editing. In normal polygon editing mode (0), only the width and height of polygons can be interactively edited. To reshape and edit the points on a polygon, polygon point editing mode (1) must be enabled.

Parameters:
polyEditMode - - indicates one of the following polyEdit modes: ePolyEditModeNormal = 0; ePolyEditModePoints = 1
Throws:
CellException - if a parameter is invalid

setPrecisionAsDisplayed

public void setPrecisionAsDisplayed(boolean precisionAsDisplayed)
Determines whether cell values are stored as entered or as displayed

Parameters:
precisionAsDisplayed - - If true, the value in each cell is rounded to the precision displayed in the cell. If false, the value is stored as entered or calculated.

setPrintArea

public void setPrintArea()
                  throws CellException
Sets the current print area. Use this method to change the worksheet ranges to be printed to the currently selected range.

Throws:
CellException

setPrintArea

public void setPrintArea(java.lang.String formula)
                  throws CellException
Sets the current print area to the specified range. The print area formula can contain one or more ranges (e.g. A1:C3,A11:C13). If "Print_Area" is Null (""), the selected portion of the active worksheet is printed. Set print areas as absolute ranges, i.e. $A$1:$J$30. If you set the print area to a relative range (based on the active cell), an unexpected print result will occur.

Parameters:
formula - - description
Throws:
CellException

setPrintBottomMargin

public void setPrintBottomMargin(double printBottomMargin)
Sets the bottom print margin.

Parameters:
printBottomMargin - - the bottom print margin.

setPrintColHeading

public void setPrintColHeading(boolean printColHeading)
Determines whether column headings are printed.

Parameters:
printColHeading - - boolean that determines whether headings are printed.

setPrintFooter

public void setPrintFooter(java.lang.String printFooter)
Sets the current page footer The following list shows the special codes the footer text can contain. By default, footer text is centered unless &L or &R is specified. &L Left-aligns the characters that follow. &C Centers the characters that follow. &R Right-aligns the characters that follow. &A Prints the sheet name. &D Prints the current date. &T Prints the current time. &F Prints the workbook name. &P Prints the page number. &P+number Prints the page number plus number. &P-number Prints the page number minus number. && Prints an ampersand. &N Prints the total number of pages in the document. The following font codes must appear before other codes and text or they are ignored. The alignmentcodes (e.g., &L) restart each section; new font codes can be specified after an alignment code. &B Use a bold font. &I Use an italic font. &U Underline the header. &S Strikeout the header. &O Ignored (Mac specific). &H Ignored (Mac specific). &"fontname" Use the specified font. &nn Use the specified font size - must be a two digit number.

Parameters:
printFooter - - String that contains the codes and text that make up the footer.

setPrintFooterMargin

public void setPrintFooterMargin(double printFooterMagrin)
Sets the page footer margin used during printing The header and footer margins can be printed. The value given is from the bottom of the page. The values are measured in inches or metric units, depending on the localized settings.

Parameters:
printFooterMagrin - - size of the margin

setPrintGridLines

public void setPrintGridLines(boolean printGridLines)
Sets the flag which determines whether or not grid lines are printed for the current sheet.

Parameters:
printGridLines - - true if grid lines should be printed for the current sheet, false otherwise.

setPrintHCenter

public void setPrintHCenter(boolean printHCenter)
Sets the flag which determines whether or not the current sheet is centered horizontally when printed.

Parameters:
printHCenter - - true if the current sheet is to be centered horizontally when printed, false otherwise.

setPrintHeader

public void setPrintHeader(java.lang.String printHeader)
Sets the page header printed at the top of each page The following list shows the special codes the footer text can contain. By default, header text is centered unless &L or &R is specified. &L Left-aligns the characters that follow. &C Centers the characters that follow. &R Right-aligns the characters that follow. &A Prints the sheet name. &D Prints the current date. &T Prints the current time. &F Prints the workbook name. &P Prints the page number. &P+number Prints the page number plus number. &P-number Prints the page number minus number. && Prints an ampersand. &N Prints the total number of pages in the document. The following font codes must appear before other codes and text or they are ignored. The alignmentcodes (e.g., &L) restart each section; new font codes can be specified after an alignment code. &B Use a bold font. &I Use an italic font. &U Underline the header. &S Strikeout the header. &O Ignored (Mac specific). &H Ignored (Mac specific). &"fontname" Use the specified font. &nn Use the specified font size - must be a two digit number.

Parameters:
printHeader - - string that contains text and codes for header.

setPrintHeaderMargin

public void setPrintHeaderMargin(double printHeaderMargin)
Sets the page header margin used during printing The header and footer margins can be printed. The value given is from the the bottom of the page. The values are measured in inches or metric units, depending on the localized settings.

Parameters:
printHeaderMargin - - size of the margin.

setPrintLandscape

public void setPrintLandscape(boolean printLandscape)
Determines the direction of the print job.

Parameters:
printLandscape - - boolean, if True job is printed Landscape, if False job is printed portrait.

setPrintLeftMargin

public void setPrintLeftMargin(double printLeftMargin)
Sets the left print margin.

Parameters:
printLeftMargin - - the left print margin.

setPrintLeftToRight

public void setPrintLeftToRight(boolean printLeftToRight)
Sets the flag which determines whether the current sheet is to be printed left to right then top to bottom, or top to bottom then left to right.

Parameters:
printLeftToRight - - true if the current sheet is to be printed left to right then top to bottom, false otherwise.

setPrintNoColor

public void setPrintNoColor(boolean printNoColor)
Determines whether job is printed in color or black and white Color formats are translated by the printer driver and printed as patterns. This translation sometimes makes text unreadable. If this method is passed with True paramenter, all workbook colors are converted to black and white, and all patterns are removed. A cleaner output is produced.

Parameters:
printNoColor - - True turns off colors and patterns

setPrintRightMargin

public void setPrintRightMargin(double printRightMargin)
Sets the right print margin.

Parameters:
printRightMargin - - the right print margin.

setPrintRowHeading

public void setPrintRowHeading(boolean printRowHeading)
Sets the flag which determines whether or not row headings are printed for the current sheet.

Parameters:
printRowHeading - - true if row headings should be printed for the current sheet, false otherwise.

setPrintScale

public void setPrintScale(int scale,
                          boolean fitToPage,
                          int verticalPages,
                          int horizontalPages)
                   throws CellException
Sets the scale factor for the active worksheet

Parameters:
scale - - description
fitToPage - - if true, worksheet is scaled to fit in the number of pages specified by verticalPages and horizontalPages. If False, scale is used to print worksheet.
verticalPages - - the number of vertical pages to which the print job is fit.
horizontalPages - - the number of horizontal pages to which the print job is fit.
Throws:
CellException - if a parameter is invalid

setPrintScale

public void setPrintScale(int scale)
                   throws CellException
Sets the scale factor for the active worksheet To print a worksheet at the largest scale possible, set this value to 400 and setPrintScaleToFitPage to True.Then, specify the number of pages on which you want the worksheet printed.

Parameters:
scale - - Indicates the scale factor. Scale factor can range * from 10 to 400.
Throws:
CellException - if a parameter is invalid

setPrintScaleFitToPage

public void setPrintScaleFitToPage(boolean fitToPage)
Sets sets whether pages are scaled to fit the specified number of pages when printed. If this value is False, the scale factor in setPrintScale is used to print the workbook. If this value is True, the workbook is printed on the number of vertical and horizontal pages specified by setPrintScaleFitHPages and setPrintScaleFitVPages.

Parameters:
fitToPage - - controls whether pages are fitted.

setPrintScaleFitHPages

public void setPrintScaleFitHPages(int horizontalPages)
                            throws CellException
Sets the number of horizontal pages to which the print job is fit This value has no effect if setPrintScaleFitToPage is False.

Parameters:
horizontalPages - - the number of horizontal pages to which the print job is fit.
Throws:
CellException - if a parameter is invalid

setPrintScaleFitVPages

public void setPrintScaleFitVPages(int verticalPages)
                            throws CellException
Sets the number of vertical pages to which the print job is fit. This value has no effect if setPrintScaleFitToPage is False.

Parameters:
verticalPages - - the number of vertical pages to which the print job it fit.
Throws:
CellException - if a parameter is invalid

setPrintTitles

public void setPrintTitles()
                    throws CellException
Sets the current selection to be the print titles to be printed at the top of each page Print titles are row and column titles that are printed on each page. Column titles print on the left side of each page; row titles print across the top of each page.

Throws:
CellException - if a parameter is invalid

setPrintTitles

public void setPrintTitles(java.lang.String formula)
                    throws CellException
Sets the print titles to be printed at the top of each page

Parameters:
formula - that identifies the range or ranges holding the titles. This formula can contain a single range or multiple ranges (e.g., A1:IV2, A1:A16384 prints the first two rows and the first column on every page). Print titles are row or column titles that are printed on each page. Row titles are printed at the top of each new page; column titles are printed on the left of each new page. If this value is set to null (" "), no titles are printed.
Throws:
CellException - if formula is invalid

setPrintTopMargin

public void setPrintTopMargin(double printTopMargin)
Sets the top print margin.

Parameters:
printTopMargin - - the top print margin.

setPrintVCenter

public void setPrintVCenter(boolean printVCenter)
Sets the flag which determines whether or not the current sheet is centered verticall when printed.

Parameters:
printVCenter - - true if the current sheet is to be centered vertically when printed, false otherwise.

setRepaint

public void setRepaint(boolean repaint)
Sets the flag which determines whether or not this view is painted. The repaint flag can be set to false to speed up processing of large amounts of data. When it is false, the view will not bother keeping track of what needs to be painted. This can significantly speed up API's which normally need to check whether or not painting needs to happen. Calls to the following two methods are also ignored: public void update(Graphics g); // Overridden from java.awt.Component public void internal(Graphics g); // Overridden from java.awt.Component When this flag is true, painting information is accumulated and painting actually occurs in the background. When this flag is changed from false to true, the entire view is marked as needing to be painted. The painting will occur during background thread processing.

Parameters:
repaint - - true if the view should internal, false otherwise.

setRow

public void setRow(int row)
            throws CellException
Sets the row of the active cell.

Parameters:
row - - the new row for the active cell.
Throws:
CellException - if there is not an active cell or row is not a valid row number

setRowHeaderSelected

public void setRowHeaderSelected(boolean rowHeaderSelected)
Determines if the row header is selected.

Parameters:
rowHeaderSelected - - Boolean that determines selection. True = selected, False = not unselected.

setRowHeight

public void setRowHeight(int row,
                         int height)
                  throws CellException
Sets the height of a single specified row.

Parameters:
row - - the row number
height - - the row height in twips. A twip is 1/1440th of an inch.
Throws:
CellException

setRowHeight

public void setRowHeight(int row1,
                         int row2,
                         int height,
                         boolean defRowHeight,
                         boolean automatic)
                  throws CellException
Sets the height of a range of rows.

Parameters:
row1 - - the first row in the range.
row2 - - the last row in the range.
height - - the height in twips
defRowHeight - - Specifies whether the default row height is changed. True specifies that the default height is set to height. In addition, any rows that use the default height are updated with the new default. False specifies that the default height is unchanged.
automatic - - boolean flag that determines if the rows resize automatically with font changes
Throws:
CellException

setRowHeightAuto

public void setRowHeightAuto(int row1,
                             int col1,
                             int row2,
                             int col2,
                             boolean setDefaults)
                      throws CellException
Specifies that the heights of the rows in the specified range are automatically set to display the tallest entry in the specified rows. The rows are set at least as tall as the default row height.

Parameters:
row1 - - the first row in the range.
col1 - - first column in the range
row2 - - last row in the range
col2 - - last column in the range
setDefaults - - Determines when the specified rows are resized. If True, all specified rows are adjusted automatically. If False, only rows in the specified row range that need to be larger than their current size are adjusted.
Throws:
CellException

setRowHeightAutomatic

public void setRowHeightAutomatic(int row,
                                  boolean automatic)
                           throws CellException
Specifies that the heights of the specified row is automatically set to display the tallest entry in the row. The row is set at least as tall as the default row height.

Parameters:
row - - the row number
automatic - - boolean that specifies rows are automatically resized with font changes.
Throws:
CellException

setRowHidden

public void setRowHidden(int row,
                         boolean rowHidden)
                  throws CellException
Changes the display status of the specified row.

Parameters:
row - - the row number
rowHidden - - boolean that specifies whether the row is hidden (True) or displayed False)
Throws:
CellException

setRowHidden

public void setRowHidden(int row1,
                         int row2,
                         boolean rowHidden)
                  throws CellException
Changes the display status of the specified rows.

Parameters:
row1 - - the first row number
row2 - - the last row number
rowHidden - - boolean that specifies whether the row is hidden (True) or displayed False)
Throws:
CellException

setRowMode

public void setRowMode(boolean rowMode)
Sets the row mode status for a view.

Parameters:
rowMode - - boolean that sets the row mode. If True, and entire row is selected when you select a cell. If False one cell is selected.

setRowText

public void setRowText(int row,
                       java.lang.String rowText)
                throws CellException
Sets the name for the specified row. Setting this name affects all selected sheets. Naming a row is useful for labeling rows so they reflect the data in the row (e.g., row 2 might be named Central Region). The row name is displayed in the row heading and is used for display purposes only. The row is still referred to by normal cell references in formulas. Row names can be up to 254 bytes long.

Parameters:
row - - a row number
rowText - - row name
Throws:
CellException

setScrollToLastRC

public void setScrollToLastRC(boolean scrollToLastRC)
Sets how scrollbars work. Normally scroll bars can scroll the last filled cell to the top- left edge of the window. If this method is called with a False parameter, it causes scrolling to stop when the last filled row and column reach the bottom-right edge of the screen.

Parameters:
scrollToLastRC - - boolean that sets the scroll flag.

setSelection

public void setSelection(GRObject grobject)
Selects a graphical object on the worksheet

Parameters:
grobject - - a GRObject that describes the object to be selected.

setSelection

public void setSelection(int row1,
                         int col1,
                         int row2,
                         int col2)
                  throws CellException
Selects the range represented by the specified parameters and moves the active cell to the top left cell in the range.

Parameters:
row1 - - number of the first row.
col1 - - number of the first column
row2 - - number of the last row.
col2 - - number of the last column.
Throws:
CellException

setSelectionLocal

public void setSelectionLocal(java.lang.String string)
                       throws CellException
Selects the range represented by the specified formula and moves the active cell to the top left cell in the range. The formula is in the user's local language. Use this method if the user must enter the selection range in their own language. The values of this formula change depending on the user's language. This can result in code that will not run correctly in another language version of JXCell. If you want to ensure that selections behave correctly regardless of the language they are loaded in, use the setSelection method.

Parameters:
string - - Identifies the starting and ending rows and columns of the selection or a defined name that represents the selection.
Throws:
CellException

setSelEndCol

public void setSelEndCol(int selEndCol)
                  throws CellException
Sets the last selected column.

Parameters:
selEndCol - - the last column to select.
Throws:
CellException - if there are no ranges selected or selEndCol is not a valid column number.

setSelEndRow

public void setSelEndRow(int selEndRow)
                  throws CellException
Sets the last selected row.

Parameters:
selEndRow - - the last row to select.
Throws:
CellException - if there are no ranges selected or selEndRow is not a valid row number.

setSelStartCol

public void setSelStartCol(int selStartCol)
                    throws CellException
Sets the first selected column.

Parameters:
selStartCol - - the first column to select.
Throws:
CellException - if there are no ranges selected or selStartCol is not a valid column number.

setSelStartRow

public void setSelStartRow(int selStartRow)
                    throws CellException
Sets the first selected row.

Parameters:
selStartRow - - the first row to select.
Throws:
CellException - if there are no ranges selected or selStartRow is not a valid row number

setSheet

public void setSheet(int sheet)
              throws CellException
Sets the active worksheet.

Parameters:
sheet - - index number of the sheet. Worksheets are indexed from left to right beginning with 0.
Throws:
CellException

setSheetName

public void setSheetName(int sheet,
                         java.lang.String sheetName)
                  throws CellException
Assigns a name to the specified worksheet . This name appears on the sheet tab. When you change a sheet name, formulas that reference the worksheet are updated to reference the new sheet name.

Parameters:
sheet - - index number of the sheet. Worksheets are indexed from left to right beginning with 0.
sheetName - - the name of the sheet
Throws:
CellException

setSheetSelected

public void setSheetSelected(int sheet,
                             boolean selected)
                      throws CellException
Sets which sheet is selected.

Parameters:
sheet - - a sheet number
selected - - boolean that specifies whether the sheet is selected. True = selected, False = not selected.
Throws:
CellException - if a parameter is invalid

setShowColHeading

public void setShowColHeading(boolean showColHeadings)
Sets whether column headings are displayed

Parameters:
showColHeadings - - boolean that specifies whether headings are displayed. True = displayed, False = hidden.

setShowEditBar

public void setShowEditBar(boolean showEditBar)
Sets whether the edit bar is displayed.

Parameters:
showEditBar - - boolean that specifies if the edit bar is displayed.True = displayed, False = hidden.

setShowEditBarCellRef

public void setShowEditBarCellRef(boolean showEditBarCellRef)
Sets whether the reference of the active cell appears with the edit bar.

Parameters:
showEditBarCellRef - - boolean that specifies if the edit bar cell reference field is displayed. True = displayed, False = hidden.

setShowFormulas

public void setShowFormulas(boolean showFormulas)
Sets whether formulas are displayed in place of cell values

Parameters:
showFormulas - - boolean that determines whether formulas are displayed. True = formulas displayed, False = values are displayed

setShowGridLines

public void setShowGridLines(boolean showGridLines)
Sets whether grid lines are displayed.

Parameters:
showGridLines - - boolean that determines whether grid lines are displayed. True = displayed, False = hidden

setShowHScrollBar

public void setShowHScrollBar(short showHScrollBar)
                       throws CellException
Sets the mode for the horizontal scroll bar

Parameters:
showHScrollBar - - the mode for the horizontal scroll bar: eShowOff to never show eShowOn to always show eShowAutomatic to show when appropriate
Throws:
CellException - if showHScrollBar is not a valid mode

setShowRowHeading

public void setShowRowHeading(boolean showRowHeading)
Sets the flag which determines whether row headings are shown.

Parameters:
showRowHeading - - true if row headings are to be shown, false otherwise.

setShowSelections

public void setShowSelections(short showSelections)
                       throws CellException
Sets the mode for highlighting selections.

Parameters:
showSelections - - the mode for highlighting selections: eShowOff to never show eShowOn to always show eShowAutomatic to show when window is active
Throws:
CellException - if showSelections is not a valid mode.

setShowTabs

public void setShowTabs(short showTabs)
                 throws CellException
Sets the display status and position of the sheet name tabs on a workbook.

Parameters:
showTabs - - the mode for displaying the sheet name tabs eTabs Off hide tabs eTabsBottom tabs on bottom eTabsTop tabs on top
Throws:
CellException

setShowTypeMarkers

public void setShowTypeMarkers(boolean showTypeMarkers)
Sets whether frames are displayed around cells to identify the cell types. Empty cell None Blank formatted cell Blue frame Value cell (number or text) Green frame Formula cell Red frame

Parameters:
showTypeMarkers - - boolean that specifies display mode for markers. True = display, False = hidden.

setShowZeroValues

public void setShowZeroValues(boolean showZeroValues)
Sets or returns whether zero value cells are displayed.

Parameters:
showZeroValues - - boolean that determines whether zeros are displayed.

setShowVScrollBar

public void setShowVScrollBar(short showVScrollBar)
                       throws CellException
Sets the mode for the vertical scroll bar.

Parameters:
showVScrollBar - - the mode for the vertical scroll bar: eShowOff to never show eShowOn to always show eShowAutomatic to show when appropriate
Throws:
CellException

setTabbedText

public RangeRef setTabbedText(int row1,
                              int col1,
                              boolean valuesOnly,
                              java.lang.String text)
                       throws CellException
Places a block of tab-delimited text in a workbook. The following example illustrates a tab-delimited string. "First Qtr" & Chr(9) & "Second Qtr" & Chr(9) & "Third Qtr"

Parameters:
row1 - - the starting row where the text block is to be placed
col1 - - the starting column where the text block is to be placed
valuesOnly - - boolean that determines whether the text is placed as unformatted text (True) or as formatted text(False)
text - - the tab-delimited block of text
Returns:
a Rangeref object
Throws:
CellException - if a parameter is invalid

setText

public void setText(java.lang.String text)
             throws CellException
Sets the value of the active cell for all selected sheets.

Parameters:
text - - the text value for the active cell.
Throws:
CellException - if there is no active cell or text is too long.

setText

public void setText(int row,
                    int Col,
                    java.lang.String text)
             throws CellException
Sets the value of the active cell for all selected sheets.

Parameters:
row - - number of row
Col - - number of column
text - - the text value for the active cell.
Throws:
CellException - if the cell reference is invalid or the text is too long.

setText

public void setText(int sheet,
                    int row,
                    int Col,
                    java.lang.String text)
             throws CellException
Sets the value of the specified cell in the specified sheet.

Parameters:
sheet - - number of sheet
row - - number of row
Col - - number of column
text - - the text value for the active cell.
Throws:
CellException - if the cell reference is invalid or the text is too long.

setTopLeftHeaderSelected

public void setTopLeftHeaderSelected(boolean topLeftHeaderSelected)
Sets whether the top left header is selected.

Parameters:
topLeftHeaderSelected - - Boolean that determines selection. True = selected, False = not selected.

setTopLeftText

public void setTopLeftText(java.lang.String topLeftText)
                    throws CellException
Sets the text displayed at the intersection of the row and column headings in the top left corner of all selected sheets.

Parameters:
topLeftText - - Up to 254 characters displayed in the row and column heading intersection. This is for display purposes only.
Throws:
CellException - if topLeftText is null or over 255 characters.

setTopRow

public void setTopRow(int leftRow)
               throws CellException
Sets the first row to display in this view.

Parameters:
leftRow - - the first row to display in this view.
Throws:
CellException - if topRow is not a valid row number.

setViewScale

public void setViewScale(int scale)
                  throws CellException
Sets the current display scale for a workbook

Parameters:
scale - - an integer ranging from 10 to 400. 100 percent is normal display.
Throws:
CellException - if the argument is invalid

setWorkbookName

public void setWorkbookName(java.lang.String workbookName)
Sets the name assigned to the workbook associated with the current view. A number of methods reference a workbook by its name instead of its handle. This is also the name used to refer to the workbook in external references. For example, if you set the workbook name to MySheet, you can refer to Sheet1!A1 in that workbook by entering the formula [MySheet]Sheet1!A1 in another workbook.

Parameters:
workbookName - - the worksheet name

showActiveCell

public void showActiveCell()
                    throws CellException
Positions the view to show the active cell if it is not currently displayed in the window.

Throws:
CellException

showError

public void showError(java.lang.String errorMsg)
Displays an error message in a message box

Parameters:
errorMsg - - a string containing the text of the message

showError

public void showError(java.lang.Throwable throwable)
Displays an error message in a message box

Parameters:
throwable - - the throwable exception

sort

public void sort(int row1,
                 int col1,
                 int row2,
                 int col2,
                 boolean sortByRows,
                 int[] keys)
          throws CellException
Specifies a range of data to be sorted and the keys by which to sort the data. If the data is sorted by rows, each row of data in the specified range is considered a record and sorted together. If data is sorted by columns, each column in the specified range is considered a record. When defining sort keys, specify the number of the row or column in the selected range that is to serve as a key. Use a positive number to define an ascending key; use a negative number to define a descending key.

Parameters:
row1 - - first row in range to be sorted.
col1 - - first column in range to be sorted.
row2 - - last row in range to be sorted
col2 - - last column in range to be sorted.
sortByRows - - Specifies how data is sorted. If True, data is sorted by rows; if False, data is sorted by columns.
keys - - Identifies the key or keys to use to sort the data. This argument can be a single integer or an array of integers.
Throws:
CellException

sort3

public void sort3(int row1,
                  int col1,
                  int row2,
                  int col2,
                  boolean sortByRows,
                  int keys,
                  int key2,
                  int key3)
           throws CellException
Specifies a range of data to be sorted and as many as three keys by which to sort the data. If the data is sorted by rows, each row of data in the specified range is considered a record and sorted together. If data is sorted by columns, each column in the specified range is considered a record. When defining sort keys, specify the number of the row or column in the selected range that is to serve as a key. Use a positive number to define an ascending key; use a negative number to define a descending key. For example, to specify the second column in the selected range as a primary descending key, enter -2 for key1. To sort on one key, key2 must be zero. To sort on two keys, key3 must be zero.

Parameters:
row1 - - first row in range to be sorted.
col1 - - first column in range to be sorted.
row2 - - last row in range to be sorted
col2 - - last column in range to be sorted.
sortByRows - - Specifies how data is sorted. If True, data is sorted by rows; if False, data is sorted by columns.
keys - - Identifies the key or keys to use to sort the data. This argument can be a single integer or an array of integers.
key2 - - Identifies the secondary key used to sort the data.
key3 - - Identifies the final key used to sort the data.
Throws:
CellException

startEdit

public void startEdit(boolean clear,
                      boolean inCellEditFocus,
                      boolean arrowsExitEditMode)
Begins edit mode for the active cell.

Parameters:
clear - - If True, the edit bar is cleared as edit mode commences.
inCellEditFocus - - If True, editing focus is given to in-cell editing; if False, editing focus is given to the edit bar.
arrowsExitEditMode - - If True, edit mode is exited if you press an arrow key on the keyboard.

swapWorkbooks

public void swapWorkbooks(View f1ToSwapWith)
Exchanges the workbooks attached to two views. When the workbooks are exchanged, the view information is not swapped, only the workbooks are swapped. This method must not be called while either view is locked (with com.jxcell.View.getLock()).

Parameters:
f1ToSwapWith - - identifies the view to swap workbooks with.

transactCommit

public void transactCommit()
                    throws CellException
Commits changes made during a transaction. Transactions allow the performance of multiple operations with the ability to undo changes if all operations do not succeed. Every operation between the start of a transaction and the end of a transaction can be undone by calling TransactRollback. If all operations succeed, TransactCommit should be called to make the changes permanent and release resources associated with the transaction. Every TransactStart method call must have a matching TransactCommit or TransactRollback method call.

Throws:
CellException

transactRollback

public void transactRollback()
                      throws CellException
Undoes all changes made to a table since the last TransactStart method was called. Transactions allow the performance of multiple operations with the ability to undo changes if all operations do not succeed. Every operation between the start of a transaction and the end of a transaction can be undone by calling TransactRollback. If all operations succeed, TransactCommit should be called to make the changes permanent and release resources associated with the transaction. Every TransactStart method call must have a matching TransactCommit or TransactRollback method call.

Throws:
CellException

transactStart

public void transactStart()
                   throws CellException
Starts a transaction. Transactions allow the performance of multiple operations with the ability to undo changes if all operations do not succeed. Every operation between the start of a transaction and the end of a transaction can be undone by calling TransactRollback. If all operations succeed, TransactCommit should be called to make the changes permanent and release resources associated with the transaction. Every TransactStart method call must have a matching TransactCommit or TransactRollback method call. Note TransactStart makes a copy of the entire workbook and should probably not be used on very large workbooks.

Throws:
CellException

twipsToCharWidth

public int twipsToCharWidth(int nTwips)
                     throws CellException
Converts twips (1/1440th of an inch) to character width based units.

Parameters:
nTwips - - the value to convert
Returns:
the number of twips in the character width of the default font
Throws:
CellException

twipsToRC

public CellRef twipsToRC(int x,
                         int y)
Converts a point in a worksheet, as specified by a set of coordinates, to the corresponding row and column at which the point is located.

Parameters:
x - - Horizontal coordinate of the point to convert.
y - - Vertical coordinate of the point to convert.
Returns:
CellRef Describes the referece of the cell at the specified location

update

public void update()
Updates all workbooks. Update updates everything that might be delayed. This includes recalculating any workbooks as needed, updating the scroll bar position, and firing a Modified event if needed. An update happens automatically when the system is idle. You should not normally need to call this method.


writeURL

public boolean writeURL(java.lang.String s1,
                        int i1,
                        java.lang.String s2,
                        java.lang.String s3,
                        short word0)
                 throws java.net.MalformedURLException,
                        java.io.IOException,
                        CellException
Throws:
java.net.MalformedURLException
java.io.IOException
CellException

writeURL

public boolean writeURL(java.lang.String s1,
                        short word0)
                 throws java.net.MalformedURLException,
                        java.io.IOException,
                        CellException
Throws:
java.net.MalformedURLException
java.io.IOException
CellException

writeURL

public boolean writeURL(java.net.URL url,
                        short word0)
                 throws java.io.IOException,
                        CellException
Throws:
java.io.IOException
CellException

write

public void write(java.io.OutputStream outputstream,
                  short fileType)
           throws java.io.IOException,
                  CellException
Saves the workbook to the specified output stream.

Parameters:
outputstream - - java.io.outputstream that describes where to save the file
fileType - - Constant that describes how the data in the workbook is saved. eFileTabbedText eFileExcel eFileJXCell eFileTabbedTextValuesOnly eFileCurrentFormat
Throws:
CellException - if a parameter is invalid
java.io.IOException - if an IO error occurs

write

public void write(java.io.OutputStream outputstream,
                  int sheet1,
                  int row1,
                  int col1,
                  int sheet2,
                  int row2,
                  int col2,
                  short fileType)
           throws java.io.IOException,
                  CellException
Writes a range of data to the specified output stream.

Parameters:
outputstream - - java.io.outputstream that describes where to save the file
sheet1 - - sheet number
row1 - - row number
col1 - - column number
sheet2 - - sheet number
row2 - - row number
col2 - - column number
fileType - - Constant that describes how the data in the workbook is saved. eFileTabbedText eFileExcel eFileJXCell eFileTabbedTextValuesOnly eFileCurrentFormat
Throws:
CellException - if a parameter is invalid
java.io.IOException - if an IO error occurs

write

public void write(java.lang.String pathName,
                  short fileType)
           throws java.io.IOException,
                  CellException
Saves the workbook to a file.

Parameters:
pathName - - path describing name and location of the file.
fileType - - Constant that describes how the data in the workbook is saved. eFileTabbedText eFileExcel eFileJXCell eFileTabbedTextValuesOnly eFileCurrentFormat
Throws:
CellException - if a parameter is invalid
java.io.IOException - if an IO error occurs

write

public void write(java.lang.String s,
                  int sheet1,
                  int row1,
                  int col1,
                  int sheet,
                  int row2,
                  int col2,
                  short fileType)
           throws java.io.IOException,
                  CellException
Writes specified portion of the workbook to a file.

Parameters:
sheet1 - - sheet number that identifies the beginning of a range
row1 - - row number
col1 - - column number
sheet - number that identifies the beginning of a range
row2 - - row number
col2 - - column number
fileType - - Constant that describes how the data in the workbook is saved. eFileTabbedText eFileExcel eFileJXCell eFileTabbedTextValuesOnly eFileCurrentFormat
Throws:
CellException - if a parameter is invalid
java.io.IOException - if an IO error occurs

writeToBlob

public byte[] writeToBlob()
                   throws java.io.IOException,
                          CellException
Writes the workbook to a blob.

Returns:
a byte array
Throws:
CellException - if a parameter is invalid
java.io.IOException - if an IO error occurs

mergeCell

public void mergeCell()

unMergeCell

public void unMergeCell()

isCellMerge

public boolean isCellMerge()

isCellMerge

public boolean isCellMerge(TRange trange)

isCellMerge

public boolean isCellMerge(int i,
                           int j)

imageUpdate

public boolean imageUpdate(java.awt.Image image,
                           int i,
                           int j,
                           int k,
                           int l,
                           int i1)
Specified by:
imageUpdate in interface java.awt.image.ImageObserver

repaint

public void repaint(DC dc,
                    Rect rect)

adjustmentValueChanged

public void adjustmentValueChanged(java.awt.event.AdjustmentEvent adjustmentevent)
Specified by:
adjustmentValueChanged in interface java.awt.event.AdjustmentListener

keyPressed

public void keyPressed(java.awt.event.KeyEvent keyevent)
Specified by:
keyPressed in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent keyevent)
Specified by:
keyReleased in interface java.awt.event.KeyListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent keyevent)
Specified by:
keyTyped in interface java.awt.event.KeyListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent mouseevent)
Specified by:
mousePressed in interface java.awt.event.MouseListener

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent mouseevent)
Specified by:
mouseDragged in interface java.awt.event.MouseMotionListener

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent mouseevent)
Specified by:
mouseMoved in interface java.awt.event.MouseMotionListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent mouseevent)
Specified by:
mouseReleased in interface java.awt.event.MouseListener

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent mouseevent)
Specified by:
mouseClicked in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent mouseevent)
Specified by:
mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent mouseevent)
Specified by:
mouseExited in interface java.awt.event.MouseListener

focusGained

public void focusGained(java.awt.event.FocusEvent focusevent)
Specified by:
focusGained in interface java.awt.event.FocusListener

focusLost

public void focusLost(java.awt.event.FocusEvent focusevent)
Specified by:
focusLost in interface java.awt.event.FocusListener

hasFocus

public boolean hasFocus()

getInsets

public java.awt.Insets getInsets()

doLayout

public void doLayout()

getTransferData

public java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor dataflavor)
                                 throws java.io.IOException,
                                        java.awt.datatransfer.UnsupportedFlavorException
Specified by:
getTransferData in interface java.awt.datatransfer.Transferable
Throws:
java.io.IOException
java.awt.datatransfer.UnsupportedFlavorException

getTransferDataFlavors

public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()
Specified by:
getTransferDataFlavors in interface java.awt.datatransfer.Transferable

isDataFlavorSupported

public boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor dataflavor)
Specified by:
isDataFlavorSupported in interface java.awt.datatransfer.Transferable

lostOwnership

public void lostOwnership(java.awt.datatransfer.Clipboard clipboard,
                          java.awt.datatransfer.Transferable transferable)
Specified by:
lostOwnership in interface java.awt.datatransfer.ClipboardOwner

getParameterInfo

public java.lang.String[][] getParameterInfo()

update

public void update(java.awt.Graphics g)

paint

public void paint(java.awt.Graphics g)

repaint

public void repaint(long l,
                    int i,
                    int j,
                    int k,
                    int i1)

getImg

public java.awt.Image getImg(java.net.URL url)
                      throws java.io.IOException
Throws:
java.io.IOException

isDebug

public static final boolean isDebug()

isTrace

public static final boolean isTrace()

Assert

public static final void Assert(boolean flag)

Verify

public static final void Verify(boolean flag)

TRACE

public static final void TRACE(java.lang.String s)