SpreadsheetWidget (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.util.HandleResource
- - com.goldencode.p2j.util.HandleChain
  - - com.goldencode.p2j.ui.GenericWidget<T>
    - - com.goldencode.p2j.ui.BaseEntity<SpreadsheetConfig>
      - com.goldencode.p2j.ui.SpreadsheetWidget

All Implemented Interfaces:

Checkable, CommonWidget, ConfigOwner<SpreadsheetConfig>, CustomFont, DisableRedraw, EmitsComEvents, ImageSupport, ImageWidgetSupport, Spreadsheet, WriteProtectable, CommonField, CommonHandle, CommonHandleChain, Coordinates, DatabaseInfo, Deletable, DynamicResource, HasVisible, InstantiatingProcedure, Nameable, Sensitive, Sizeable, WrappedResource, Printable
```
public class SpreadsheetWidget
extends BaseEntity<SpreadsheetConfig>
implements EmitsComEvents, Spreadsheet
```
SPREADSHEET widget server class.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) class SpreadsheetWidget.EventHandler
Event handling coming from the Spreadsheet backend.
- Nested classes/interfaces inherited from class com.goldencode.p2j.ui.BaseEntity
  BaseEntity.CharsPixels

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`SpreadsheetWidget.EventHandler` Event handling coming from the Spreadsheet backend.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`allowTabs` Flag keeping the allow-tabs state
`private SpreadsheetCache`	`cache` Represents the cache for storing frequently used spreadsheet data.
`private ClientExports`	`client` The client
`private ConfigManager`	`cm` Config manager reference
`private static SimpleCounter`	`CMD_HIT_COUNTER` This variable represents an instance of the SimpleCounter class used for counting the cache hits of spreadsheet commands.
`private static ValuesCounter`	`CMD_TIME_COUNTER` This variable represents an instance of the ValuesCounter class for measuring and tracking the time taken for spreadsheet commands to execute.
`private int`	`contextId` ID of the related spreadsheet web application context
`private boolean`	`inBatch` This variable represents whether the current process is running in a batch mode or not
`private boolean`	`initTimeout` This variable represents the initialization timeout state
`private boolean`	`isEnterMovesDown` Flag keeping the enter-moved-down state
`private java.lang.Object`	`lock` Lock
`private static CentralLogger`	`LOG` Logger
`private ComObject`	`obj` A definition of a corresponding COM-OBJECT used to raise the COM events.
`private SheetController`	`sheetController` Sheet controller

Fields inherited from class com.goldencode.p2j.ui.BaseEntity
group

Fields inherited from class com.goldencode.p2j.ui.GenericWidget
config, deleted, frame, internalScreenValueUsage, realizeOnAttributeAccess

Fields inherited from class com.goldencode.p2j.util.HandleChain
name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource
instProc, pm

Fields inherited from interface com.goldencode.p2j.ui.Spreadsheet
ErrorGeneral, OK

Constructor Summary

Constructors
Constructor and Description
`SpreadsheetWidget(boolean dynamic)` Constructor.
`SpreadsheetWidget(boolean dynamic, SpreadsheetConfig base)` Constructor.
`SpreadsheetWidget(boolean dynamic, SpreadsheetConfig base, BaseEntity<SpreadsheetConfig> before, boolean firstAsLast)` Constructor.
`SpreadsheetWidget(SpreadsheetConfig base, BaseEntity<SpreadsheetConfig> before, boolean firstAsLast)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_setVisible(boolean visible)` Sets the widget's config `visibility flag`.
`void`	`cancelEdit()` Cancels edit mode and leaves the contents of the active cell unchanged.
`void`	`clearBook()` Resets the book to the initial state - removes all sheets and creates new empty one.
`void`	`clearRange(NumberType row, NumberType column, NumberType lastRow, NumberType lastColumn, NumberType clearType)` Clears the specified range in all selected sheets.
`void`	`copyRange(NumberType dstRow, NumberType dstCol, NumberType dstLastRow, NumberType dstLastCol, NumberType sourceView, NumberType srcRow, NumberType srcCol, NumberType srcLastRow, NumberType srcLastCol)` Copies a range of data to the specified location.
`void`	`delete()` Perform actual delete of an resource.
`void`	`deleteDefinedName(character name)` Deletes the specified user-defined name.
`void`	`deleteRange(NumberType row, NumberType col, NumberType lastRow, NumberType lastCol, NumberType shiftType)` Deletes cells, rows, or columns from the specified range.
`void`	`deleteSheets(NumberType index, NumberType count)` Deletes the supplied sheets.
`void`	`editClear(NumberType clearType)` Clears all cells in the selected ranges.
`void`	`editCopy()` Copies the selected range or objects to the clipboard.
`void`	`editCopyDown()` Copies cells in the top row of a selection to the other rows in the selected range.
`void`	`editPaste()` Pastes the contents of the clipboard to the selected range.
`BaseDataType[]`	`emitComEvent(java.lang.String eventName, BaseDataType[] args)` The method is called when a COM event is to be emitted by the means of this instance.
`private void`	`emitEvent(java.lang.String name, BaseDataType... args)` Emits event on the server.
`private void`	`emitEvent(java.lang.String name, java.lang.Runnable initiation, java.util.function.Consumer<BaseDataType[]> completion, BaseDataType... args)`
`void`	`endBatch()` Disables batch mode.
`integer`	`endEdit()` Ends edit mode and applies changes to the active cell.
`void`	`filePrint(logical showPrintDlg)` Prints the selected worksheet.
`void`	`findDlg()` Displays the Find dialog.
`void`	`formatBorderDlg()` Displays the Border dialog box.
`void`	`formatFixed2()` Formats the selected ranges on all selected worksheets with fixed format and two decimal places.
`void`	`formatPatternDlg()` Displays the Pattern dialog box.
`void`	`getActiveCell(NumberType row, NumberType col)` Returns the row and column coordinates of the active cell.
`int64`	`getActiveColumn()` Determines the active column in the active worksheet.
`int64`	`getActiveRow()` Determines the active row in the active worksheet.
`logical`	`getAllowTabs()` Returns whether TAB key moves the active cell to the successive cell in the range of selected cells or in the range of all cells if no cells are selected.
`void`	`getBorder(NumberType left, NumberType right, NumberType top, NumberType bottom, NumberType shade, NumberType colorLeft, NumberType colorRight, NumberType colorTop, NumberType colorBottom)` Returns the border styles used to display cells.
`SpreadsheetCache`	`getCache()` Retrieves the SpreadsheetCache object associated with this instance.
`character`	`getClip()` Exports tab-delimited text strings from workbooks.
`character`	`getColText(NumberType column)` Returns the label for a column.
`integer`	`getColWidth(NumberType column)` Returns the width of a single column.
`character`	`getDefinedName(character name)` Returns the cell area reference string associated with a defined name.
`character`	`getEntry()` Returns the contents of the active cell in the first selected worksheet in the same format as it would be displayed while in edit mode.
`character`	`getEntryRC(NumberType row, NumberType col)` Returns the contents of the specified cell in the first selected worksheet in the same format as it would be displayed while in edit mode.
`character`	`getEntrySRC(NumberType sheet, NumberType row, NumberType col)` Returns the contents of the specified cell on the specified worksheet in the same format as it would be displayed while in edit mode.
`int64`	`getFixedCol()` Returns the starting fixed column for the active worksheet.
`int64`	`getFixedCols()` Returns how many columns to fix at the left of the active worksheet.
`int64`	`getFixedRow()` Returns the starting fixed row for the active worksheet.
`int64`	`getFixedRows()` Returns how many rows to fix at the top of the active worksheet.
`character`	`getFormattedText()` Returns the formatted text value of the active cell.
`character`	`getFormattedTextRC(NumberType row, NumberType col)` Returns the formatted text value of the specified cell.
`character`	`getFormattedTextSRC(NumberType sheet, NumberType row, NumberType col)` Returns the formatted text value of the specified cell as it appears in the specified worksheet.
`character`	`getFormulaRC(NumberType row, NumberType col)` Returns formula text of the specified cell in the active worksheet.
`int64`	`getLastCol()` Returns the number of the last occupied column.
`int64`	`getLastRow()` Returns the number of the last occupied row.
`int64`	`getLeftCol()` Returns the leftmost column currently displayed in the view.
`logical`	`getLogicalRC(NumberType row, NumberType col)` Returns the logical (True or False) value of the specified cell.
`logical`	`getLogicalSRC(NumberType sheet, NumberType row, NumberType col)` Returns the logical (True or False) value of the specified cell and sheet.
`int64`	`getMaxCol()` Returns the last displayable column in the active worksheet.
`int64`	`getMaxRow()` Returns the last displayable row in the active worksheet.
`logical`	`getModified()` Returns the state of the modified flag which indicates whether modifications have been made to a view.
`decimal`	`getNumber()` Returns the numeric value of the active cell.
`character`	`getNumberFormat()` Returns the number format for the active cell.
`decimal`	`getNumberRC(NumberType row, NumberType col)` Returns the numeric value of the specified cell.
`decimal`	`getNumberSRC(NumberType sheet, NumberType row, NumberType col)` Returns the numeric value of the specified cell.
`int64`	`getNumSheets()` Returns the number of worksheets in the current workbook.
`character`	`getObjItems(NumberType id)` Returns a semicolon-delimited list of items from a list box object.
`character`	`getObjName(NumberType id)` Returns the name of the specified object.
`character`	`getObjText(NumberType id)` Returns the text displayed by a specific button or check box object.
`integer`	`getObjValue(NumberType id)` Returns the value of a check box or list box object.
`logical`	`getObjVisible(NumberType id)` Returns whether an object is visible.
`void`	`getPattern(NumberType pattern, NumberType fgColor, NumberType bgColor)` Returns the pattern for the active cell.
`character`	`getPrintArea()` Returns the current print area.
`decimal`	`getPrintBottomMargin()` Returns the bottom page margin used during printing.
`logical`	`getPrintLandscape()` Returns whether a workbook is printed with a portrait or landscape orientation.
`decimal`	`getPrintLeftMargin()` Returns the left page margin used during printing.
`decimal`	`getPrintRightMargin()` Returns the right page margin used during printing.
`decimal`	`getPrintTopMargin()` Returns the top page margin used during printing.
`void`	`getProtection(logical locked, logical hidden)` Returns the protection status of the active cell.
`character`	`getRowText(NumberType row)` Returns the label for a row.
`void`	`getSelection(NumberType selection, NumberType row1, NumberType col1, NumberType row2, NumberType col2)` Returns the row and column coordinates of the currently selected range.
`integer`	`getSelectionCount()` Returns the number of selected ranges.
`int64`	`getSheet()` Returns the active worksheet.
`character`	`getSheetName(NumberType sheet)` This property returns the name of the specified worksheet.
`integer`	`getShowSelections()` Returns whether selections are displayed.
`character`	`getText()` Returns the text value of the active cell in the active worksheet.
`character`	`getTextRC(NumberType row, NumberType col)` Returns the text value of the specified cell in the active worksheet.
`character`	`getTextSRC(NumberType sheet, NumberType row, NumberType col)` Returns the text value of the specified cell in the specified worksheet.
`int64`	`getTopRow()` Returns the topmost row currently displayed in the view.
`integer`	`getType()` Returns the cell type of the active cell.
`integer`	`getTypeRC(NumberType row, NumberType col)` Returns the cell type of the specified cell.
`integer`	`getTypeSRC(NumberType sheet, NumberType row, NumberType col)` Returns the cell type of the specified cell of the specified sheet.
`void`	`insertRange(NumberType row, NumberType col, NumberType lastRow, NumberType lastCol, NumberType shiftType)` Moves the specified range in order to insert new cells, rows, or columns.
`private java.lang.Object`	`invokeWidgetCommand(SpreadsheetCommands command, java.lang.Object... args)` Invokes a command on the client widget implementation.
`private java.lang.Object`	`invokeWidgetCommandImpl(SpreadsheetCommands command, java.lang.Object... args)` Invokes a command on the client widget implementation.
`logical`	`isAllowDelete()` Returns whether the delete key clears selections.
`logical`	`isAllowEditHeaders()` Returns whether column headers can be edited.
`logical`	`isAllowInCellEditing()` Returns whether in-cell editing is allowed.
`logical`	`isAllowMoveRange()` Returns whether you can move ranges by dragging them.
`logical`	`isAllowResize()` Returns whether you can resize rows and columns by dragging them.
`logical`	`isAllowSelections()` Returns whether cells can be selected with user input.
`logical`	`isAutoRecalc()` Returns whether automatic recalculation is enabled.
`logical`	`isCanEditPaste()` Returns whether the internal clipboard contain items that can be pasted to the worksheet.
`logical`	`isColHidden(NumberType column)` Returns the display status of an individual column.
`logical`	`isEnableProtection()` Returns whether protection is enabled for all selected sheets.
`logical`	`isEnterMovesDown()` Returns whether pressing the ENTER key moves the active cell down to the next cell.
`logical`	`isRowHidden(NumberType row)` Returns the display status of an individual row.
`logical`	`isScrollToLastRC()` Returns how scrollbars work.
`logical`	`isShowColHeading()` Returns whether column headings are displayed.
`logical`	`isShowEditBar()` Returns whether the edit bar is displayed.
`logical`	`isShowRowHeading()` Returns whether row headings are displayed.
`logical`	`isShowZeroValues()` Returns whether zero value cells are displayed.
`void`	`objGetCell(NumberType id, NumberType hasCell, NumberType row, NumberType col)` Returns the worksheet cell assigned to hold the value displayed by the specified check box or list box object.
`void`	`objGetPos(NumberType id, NumberType x1, NumberType y1, NumberType x2, NumberType y2)` Gets the bounds of an object.
`int64`	`objNameToID(character name)` Returns the object identification number for an object specified by name.
`void`	`objNew(NumberType type, NumberType x1, NumberType y1, NumberType x2, NumberType y2, NumberType id)` Creates and adds an object to the active worksheet.
`void`	`objSetPos(NumberType id, NumberType x1, NumberType y1, NumberType x2, NumberType y2)` Sets the position and size of an object.
`void`	`read(character filePath, NumberType fileType)` Reads a worksheet or workbook from a file.
`void`	`recalc()` Recalculates the workbook attached to a view.
`void`	`setActiveCell(NumberType row, NumberType col)` Makes the specified cell the active cell.
`void`	`setActiveColumn(NumberType value)` Sets the active column in the active worksheet.
`void`	`setActiveRow(NumberType value)` Sets the active row in the active worksheet.
`void`	`setAlignment(NumberType hAlign, logical wordWrap, NumberType vAlign, NumberType orientation)` Changes the data alignment information for the currently selected cells.
`void`	`setAllowDelete(logical value)` Sets whether the delete key clears selections.
`void`	`setAllowEditHeaders(logical value)` Sets whether column headers can be edited by the user.
`void`	`setAllowInCellEditing(logical value)` Sets whether in-cell editing is allowed.
`void`	`setAllowMoveRange(logical value)` Sets whether you can move ranges by dragging them.
`void`	`setAllowResize(logical value)` Sets whether you can resize rows and columns by dragging them.
`void`	`setAllowSelections(logical value)` Sets whether cells can be selected with user input.
`void`	`setAllowTabEdit(logical value)` Sets whether tab editing is allowed (adding, renaming and removing sheets (or tabs) using the UI).
`void`	`setAllowTabs(logical value)` Sets whether TAB key moves the active cell to the successive cell in the range of selected cells or in the range of all cells if no cells are selected.
`void`	`setAutoRecalc(logical value)` Sets whether automatic recalculation is enabled.
`void`	`setBackColor(NumberType value)` Sets the background color of the view.
`void`	`setBorder(NumberType outline, NumberType left, NumberType right, NumberType top, NumberType bottom, NumberType shade, NumberType colorOutline, NumberType colorLeft, NumberType colorRight, NumberType colorTop, NumberType colorBottom)` Sets the border styles used to display cells in all selected sheets.
`void`	`setClip(character value)` Imports tab-delimited text strings to workbooks.
`void`	`setColHidden(NumberType column, logical value)` Sets or returns the display status of an individual column.
`void`	`setColText(NumberType column, character text)` Sets the label for a column.
`void`	`setColWidth(NumberType column, NumberType width)` Sets the width of a single column.
`void`	`setColWidth(NumberType firstColumn, NumberType lastColumn, NumberType width, logical defaultColumnWidth)` Sets the width of multiple columns.
`void`	`setColWidthAuto(NumberType row1, NumberType col1, NumberType row2, NumberType col2, logical setDefaults)` Sets the widths of the specified columns to automatically adjust to the largest column entry, including the header.
`void`	`setColWidthTwips(NumberType firstColumn, NumberType lastColumn, NumberType width, logical defaultColumnWidth)` Changes the width of one or more columns to the specified number of twips.
`void`	`setDefaultFont(character font, NumberType size)` Sets the default font and font size.
`void`	`setDefinedName(character name, character areaRef)` Associates a name with an area reference.
`void`	`setEnableProtection(logical value)` Sets whether protection is enabled for all selected sheets.
`void`	`setEnterMovesDown(logical value)` Sets whether pressing the ENTER key moves the active cell down to the next cell.
`void`	`setEntry(character value)` Enters text in the active cell of all selected worksheets.
`void`	`setEntryRC(NumberType row, NumberType col, character value)` Enters text in the specified cell of all selected worksheets.
`void`	`setEntrySRC(NumberType sheet, NumberType row, NumberType col, character value)` Enters text in the specified cell on the specified worksheet.
`void`	`setExtraColor(NumberType value)` Sets the background color of the view outside the workbook.
`void`	`setFixedCols(NumberType value)` Sets how many columns to fix at the left of the active worksheet.
`void`	`setFixedRows(NumberType value)` Sets how many rows to fix at the top of the active worksheet.
`void`	`setFont(character font, NumberType size, logical bold, logical italic, logical underline, logical strikeout, NumberType color, logical outline, logical shadow)` Sets font information for all selected cells.
`void`	`setFontBold(logical value)` Setter for the FONT-BOLD attribute.
`void`	`setFontSize(NumberType value)` Setter for the FONT-SIZE attribute.
`void`	`setFormulaRC(NumberType row, NumberType col, character value)` Enters formula text in the specified cell of all selected sheets.
`void`	`setLeftCol(NumberType value)` Sets the leftmost column currently displayed in the view.
`void`	`setLogicalRC(NumberType row, NumberType col, logical value)` Sets the logical (True or False) value of the specified cell.
`void`	`setLogicalSRC(NumberType sheet, NumberType row, NumberType col, logical value)` Sets the logical (True or False) value of the specified cell and sheet.
`void`	`setMaxCol(NumberType value)` Sets the last displayable column in a the active worksheet.
`void`	`setMaxRow(NumberType value)` Sets the last displayable row in a the active worksheet.
`void`	`setModified(logical value)` Defines if the SCREEN-VALUE attribute for this widget has changed.
`void`	`setNumber(NumberType value)` Sets the numeric value of the active cell.
`void`	`setNumberFormat(character format)` Sets or returns the number format for the active cell in all selected sheets.
`void`	`setNumberRC(NumberType row, NumberType col, NumberType value)` Sets the numeric value of the specified cell.
`void`	`setNumberSRC(NumberType sheet, NumberType row, NumberType col, NumberType value)` Sets the numeric value of the specified cell.
`void`	`setNumSheets(NumberType value)` Sets the number of worksheets in the current workbook.
`void`	`setObjItems(NumberType id, character items)` Assigns a list of values, a semicolon-delimited list of items, to a list box object.
`void`	`setObjName(NumberType id, character name)` Sets the name of the specified object.
`void`	`setObjText(NumberType id, character text)` Sets the text of the displayed by a specific button or check box object.
`void`	`setObjValue(NumberType id, NumberType value)` Sets the value of a check box or list box object.
`void`	`setObjVisible(NumberType id, logical value)` Sets whether an object is visible.
`void`	`setPattern(NumberType pattern, NumberType fgColor, NumberType bgColor)` Sets the pattern for all selected cells and objects in all selected sheets.
`void`	`setPrintArea(character formula)` Sets the current print area.
`void`	`setPrintBottomMargin(NumberType value)` Sets the bottom page margin used during printing.
`void`	`setPrintFooter(character value)` Sets the current page footer.
`void`	`setPrintHeader(character value)` Sets the current page header.
`void`	`setPrintLandscape(logical value)` Sets whether a workbook is printed with a portrait or landscape orientation.
`void`	`setPrintLeftMargin(NumberType value)` Sets the left page margin used during printing.
`void`	`setPrintRightMargin(NumberType value)` Sets the right page margin used during printing.
`void`	`setPrintTopMargin(NumberType value)` Sets the top page margin used during printing.
`void`	`setProtection(logical locked, logical hidden)` Sets the protection status of all selected cells in all selected sheets.
`void`	`setRowHeight(NumberType firstRow, NumberType lastRow, NumberType height, logical defaultRowHeight)` Changes the height of one or more rows to the specified number of twips.
`void`	`setRowHidden(NumberType row, logical value)` Sets or returns the display status of an individual row.
`void`	`setRowText(NumberType row, character text)` Sets the label for a row.
`void`	`setScrollToLastRC(logical value)` Sets how scrollbars work.
`void`	`setSelection(NumberType row1, NumberType col1, NumberType row2, NumberType col2)` Selects the specified range and moves the active cell to the top left cell in the range.
`void`	`setSheet(NumberType value)` Sets the active worksheet.
`void`	`setSheetController(SheetController sheetController)` Sets the SheetController instance.
`void`	`setSheetName(NumberType sheet, character name)` Assigns a name to a worksheet.
`void`	`setShowColHeading(logical value)` Sets whether column headings are displayed.
`void`	`setShowEditBar(logical value)` Sets whether the edit bar is displayed.
`void`	`setShowGridLines(logical value)` Sets or returns whether grid lines are displayed.
`void`	`setShowRowHeading(logical value)` Sets whether row headings are displayed.
`void`	`setShowSelections(NumberType value)` Sets whether selections are displayed.
`void`	`setShowTabs(NumberType value)` Sets or returns the display status and position of the sheet name tabs on a workbook.
`void`	`setShowToolBar(logical value)` Returns whether the tool bar is displayed.
`void`	`setShowZeroValues(logical value)` Sets whether zero value cells are displayed.
`void`	`setText(character value)` Enters text in the active cell of all selected sheets.
`void`	`setTextRC(NumberType row, NumberType col, character value)` Enters text in the specified cell of all selected sheets.
`void`	`setTextSRC(NumberType sheet, NumberType row, NumberType col, character value)` Enters text in the specified cell of the specified sheet.
`void`	`setTopRow(NumberType value)` Sets the topmost row currently displayed in the view.
`void`	`setType(NumberType value)` Sets the cell type of the active cell.
`void`	`setTypeRC(NumberType row, NumberType col, NumberType type)` Sets the cell type of the specified cell.
`void`	`setTypeSRC(NumberType sheet, NumberType row, NumberType col, NumberType type)` Sets the cell type of the specified cell in the specified sheet.
`void`	`showActiveCell()` Positions the view to show the active cell if it is not currently displayed in the window.
`void`	`sort3(NumberType row1, NumberType col1, NumberType row2, NumberType col2, logical sortByRows, NumberType key1, NumberType key2, NumberType key3)` Specifies a range of data to be sorted and as many as three keys by which to sort the data.
`void`	`startBatch()` Enables batch mode.
`void`	`startEdit(logical clear, logical inCellEditFocus, logical arrowsExitEditMode)` Begins edit mode for the active cell.
`void`	`write(character fileName, NumberType format)` Saves the workbook to the specified file.

Methods inherited from class com.goldencode.p2j.ui.BaseEntity
_getHeightChars, _getHeightPixels, _getWidthChars, _getWidthPixels, canSetPixelPositionInChui, changeFontWorker, emit4084Warning, emitUnableToAssignUnknownAttributeWarning, getBgColor, getBgColorRgb, getColumn, getDColor, getFgColor, getFgColorRgb, getFont, getFontInfo, getFontName, getFontSize, getFrameColumn, getFrameRow, getFrameX, getFrameY, getHeightChars, getHeightPixels, getNextSibling, getParent, getParent, getPfColor, getPrevSibling, getRow, getSizeAttrs, getTitle, getTooltip, getValidParentTypes, getWidthChars, getWidthPixels, getX, getY, isFontBold, isFontItalic, isFontUnderline, isMovable, isResizable, isSelected, isTabStop, prepareSizeChars, prepareSizePixels, pushLocAttrs, pushSizeAttrs, resetAutoResize, setAlign, setBgColor, setBgColor, setBgColor, setBgColorRgb, setBgColorRgb, setColon, setColon, setColumn, setColumn, setColumnOrRow, setColumnOrRowWorker, setDColor, setDColor, setDColor, setFgColor, setFgColor, setFgColor, setFgColorRgb, setFgColorRgb, setFont, setFontItalic, setFontName, setFontUnderline, setGroup, setHeightChars, setHeightChars, setHeightCharsWorker, setHeightImpl, setHeightPixels, setHeightPixels, setHeightPixelsWorker, setMaxHeightCharsWorker, setMaxHeightPixelsWorker, setMaxWidthCharsWorker, setMaxWidthPixelsWorker, setMinHeightCharsWorker, setMinHeightPixelsWorker, setMinWidthCharsWorker, setMinWidthPixelsWorker, setMovable, setMovable, setParent, setPfColor, setPfColor, setPfColor, setResizable, setResizable, setRow, setRow, setSelected, setSelected, setSizeChars, setSizePixels, setSystemParent, setTabStop, setTabStop, setTitle, setTitle, setTooltip, setTooltip, setVirtHeightCharsWorker, setVirtHeightPixelsWorker, setVirtWidthCharsWorker, setVirtWidthPixelsWorker, setWidthChars, setWidthChars, setWidthCharsWorker, setWidthImpl, setWidthPixels, setWidthPixels, setWidthPixelsWorker, setX, setX, setXorY, setXOrYWorker, setY, setY, useHandleChainSiblings, validateParent, validateSize, validColumnOrRow

Methods inherited from class com.goldencode.p2j.ui.GenericWidget
_dynamic, _getDbName, _getFormat, _getTable, _isEntered, _isHidden, _isNotEntered, _isRealized, _isVisible, _name, _setDynamic, afterConfigUpdate, apply, apply, apply, apply, asWidgetHandle, canAccess, canDelete, canPushWidgetAttr, cleanup, colorDisplay, colorPrompt, config, deselectRows, detachMenu, disable, dynamic, editUndo, enable, finishConfigProcessing, finishSetup, flushWidgetAttrs, genAssignUnknownWarning, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getColumnFont, getColumnLabel, getContextHelpId, getConvert3D, getCursorOffset, getDataType, getDbName, getFormat, getFrame, getFrameHandle, getFrameName, getHeight, getHelp, getHWND, getId, getImage, getLabel, getLabelFont, getLabelStr, getLogicalTerminal, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNextTabItem, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, getPreviousTabItem, getQuery, getRetainShape, getScreenValue, getScreenValue, getSideLabelHandle, getStretchToFit, getTable, getTabPosition, getTitleFont, getTransparent, getValidationExpression, getValidationMessage, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWidth, getWindow, getZOrderClass, hasFormat, hasNameReadOnly, hasParent, hide, hide, implicitDeletion, inputValue, isAutoCompletion, isAutoResize, isAutoReturn, isChained, isChecked, isDisableRedraw, isEntered, isExpandLabel, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isModified, isMultiple, isNotEntered, isReadOnly, isScrollable, isSelectable, isSelected, isSelected, isSensitive, isTabWidget, isTextSelected, isThreeD, isValidatable, isVisible, labelSizeCheck, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadMousePointer, loadMousePointer, moveAfterTabItem, moveAfterTabItem, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, moveToWorker, name, notQueryable, notQueryable, notSettable, notSettable, notWorker, openPopup, preRealizeCheck, processSideLabel, pushScreenDefinition, pushWidgetAttr, pushWidgetAttr, readOnlyError, readOnlyError, realize, refresh, resourceDelete, restoreSharedState, saveSharedState, selectAll, selectFocusedRow, setAtFormatLength, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttrs, setAutoCompletion, setAutoCompletion, setAutoResize, setAutoResize, setAutoReturn, setAutoReturn, setBlank, setChecked, setChecked, setColumnFont, setColumnFont, setColumnLabel, setColumnLabel, setContextHelpId, setContextHelpId, setConvert3D, setConvert3D, setCursorOffset, setCursorOffset, setDataType, setDataType, setDbname, setDeblank, setDisableAutoZap, setDisableRedraw, setFont, setFormat, setFormat, setFrame, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setFromOCX, setHeader, setHeight, setHelp, setHelp, setHelpDefault, setHelpStatic, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabel, setLabel, setLabel, setLabelFont, setLabelFont, setLabelInt, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setModified, setMultiple, setMultiple, setNextTabItem, setNoAutoValidate, setNumSelectedRows, setParentHandle, setParentHandle, setPopupMenu, setPopupMenu, setQuery, setReadOnly, setRetainShape, setRetainShape, setScreenLock, setScreenValue, setScreenValue, setScreenValue, setScreenValue, setScreenValueInt, setScreenValueNoErrorHandling, setScrollable, setScrollable, setSelectable, setSelectable, setSensitive, setSensitive, setSensitive, setSensitive, setSideLabelHandle, setStretchToFit, setStretchToFit, setTable, setThreeD, setThreeD, setTitleFont, setTitleFont, setTransparent, setTransparent, setValidation, setValidation, setVertical, setVirtHeight, setVirtHeightPixels, setVirtWidth, setVirtWidthPixels, setVisible, setVisible, setWidgetId, setWidgetId, setWidth, truncatePixelSize, type, underline, underline, valid, validate, validateFields, validateFields, validateFields, validateFields, validateLabelAssignment, view, warningAlreadyRealized, widgetName

Methods inherited from class com.goldencode.p2j.util.HandleChain
firstResource, firstResource, getHead, getNextSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNextSibling, hasPrevSibling, hasPrivateData, interlink, lastResource, lastResource, moveInChain, name, name, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource
_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, toString, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.ui.Spreadsheet
clearRange, setAlignment, setEntryRC, setFormulaRC, setObjValue, setSheet, setTextSRC

Methods inherited from interface com.goldencode.p2j.util.WrappedResource
id, id, unknown, valid

Methods inherited from interface com.goldencode.p2j.ui.CommonWidget
getIdEx, getListItems, isEditCanUndo, setListItems, setListItems, setScreenValue

Methods inherited from interface com.goldencode.p2j.util.CommonHandleChain
getPrivateData, setPrivateData, setPrivateData

Methods inherited from interface com.goldencode.p2j.util.CommonHandle
resourceType

Methods inherited from interface com.goldencode.p2j.util.Nameable
name, name

Methods inherited from interface com.goldencode.p2j.ui.DisableRedraw
setDisableRedraw

Methods inherited from interface com.goldencode.p2j.ui.WriteProtectable
setReadOnly

Methods inherited from interface com.goldencode.util.Printable
asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable
allowDelete

- Field Detail
  - LOG
```
private static CentralLogger LOG
```
    Logger
  - CMD_HIT_COUNTER
```
private static final SimpleCounter CMD_HIT_COUNTER
```
    This variable represents an instance of the SimpleCounter class used for counting the cache hits of spreadsheet commands.
  - CMD_TIME_COUNTER
```
private static final ValuesCounter CMD_TIME_COUNTER
```
    This variable represents an instance of the ValuesCounter class for measuring and tracking the time taken for spreadsheet commands to execute.
  - contextId
```
private final int contextId
```
    ID of the related spreadsheet web application context
  - obj
```
private ComObject obj
```
    A definition of a corresponding COM-OBJECT used to raise the COM events.
  - isEnterMovesDown
```
private boolean isEnterMovesDown
```
    Flag keeping the enter-moved-down state
  - allowTabs
```
private boolean allowTabs
```
    Flag keeping the allow-tabs state
  - sheetController
```
private SheetController sheetController
```
    Sheet controller
  - lock
```
private java.lang.Object lock
```
    Lock
  - cache
```
private SpreadsheetCache cache
```
    Represents the cache for storing frequently used spreadsheet data.
  - initTimeout
```
private boolean initTimeout
```
    This variable represents the initialization timeout state
  - inBatch
```
private boolean inBatch
```
    This variable represents whether the current process is running in a batch mode or not
  - client
```
private final ClientExports client
```
    The client
  - cm
```
private final ConfigManager cm
```
    Config manager reference
- Constructor Detail
  - SpreadsheetWidget
```
public SpreadsheetWidget(boolean dynamic)
```
    Constructor.
    
    Parameters:
    
    dynamic - Not used.
  - SpreadsheetWidget
```
public SpreadsheetWidget(boolean dynamic,
                         SpreadsheetConfig base)
```
    Constructor.
    
    Parameters:
    
    dynamic - Not used.
    
    base - The container for all state to be transferred to the client.
  - SpreadsheetWidget
```
public SpreadsheetWidget(SpreadsheetConfig base,
                         BaseEntity<SpreadsheetConfig> before,
                         boolean firstAsLast)
```
    Constructor.
    
    Parameters:
    
    base - The container for all state to be transferred to the client.
    
    before - The right neighbor of the BaseEntity been created or null if new BaseEntity will be the last in the chain. If before is the first element in the chain the new BaseEntity will become the new first element in the chain.
    
    firstAsLast - The flag indicating that this new entity must be inserted as last element in the chain in the case when before - is the first element of the chain. When before is the first element of the chain, default behavior (expected from the name of this parameter is to insert new element as the first. This flag allows to change the expected behavior of before parameter when
  - SpreadsheetWidget
```
public SpreadsheetWidget(boolean dynamic,
                         SpreadsheetConfig base,
                         BaseEntity<SpreadsheetConfig> before,
                         boolean firstAsLast)
```
    Constructor.
    
    Parameters:
    
    dynamic - Not used.
    
    base - The container for all state to be transferred to the client.
    
    before - The right neighbor of the BaseEntity been created or null if new BaseEntity will be the last in the chain. If before is the first element in the chain the new BaseEntity will become the new first element in the chain.
    
    firstAsLast - The flag indicating that this new entity must be inserted as last element in the chain in the case when before - is the first element of the chain. When before is the first element of the chain, default behavior (expected from the name of this parameter is to insert new element as the first. This flag allows to change the expected behavior of before parameter when
- Method Detail
  - delete
```
public void delete()
```
    Perform actual delete of an resource. At the time of this call, it is assumed the resource is valid for deletion (the handle and the resource are both valid).
    The method first calls GenericWidget.resourceDelete(), if the method returns false, the deletion is aborted.
    
    Specified by:
    
    delete in interface Deletable
    
    Overrides:
    
    delete in class GenericWidget<SpreadsheetConfig>
  - setSheetController
```
public void setSheetController(SheetController sheetController)
```
    Sets the SheetController instance.
    
    Parameters:
    
    sheetController - the SheetController object to be set
  - getCache
```
public SpreadsheetCache getCache()
```
    Retrieves the SpreadsheetCache object associated with this instance.
    
    Returns:
    
    The SpreadsheetCache object.
  - emitComEvent
```
public BaseDataType[] emitComEvent(java.lang.String eventName,
                                   BaseDataType[] args)
```
    The method is called when a COM event is to be emitted by the means of this instance.
    
    Specified by:
    
    emitComEvent in interface EmitsComEvents
    
    Parameters:
    
    eventName - Event name.
    
    args - Event arguments.
    
    Returns:
    
    The array of all output arguments produced by the event, if any.
  - isAllowDelete
```
public logical isAllowDelete()
```
    Returns whether the delete key clears selections.
    If this property is True, the delete key deletes the current selection. If this property is False, the delete key does not clear selections. By default, the allow delete flag is True.
    
    Specified by:
    
    isAllowDelete in interface Spreadsheet
    
    Returns:
    
    see above.
  - setAllowDelete
```
public void setAllowDelete(logical value)
```
    Sets whether the delete key clears selections.
    If this property is True, the delete key deletes the current selection. If this property is False, the delete key does not clear selections. By default, the allow delete flag is True.
    
    Specified by:
    
    setAllowDelete in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - isAllowEditHeaders
```
public logical isAllowEditHeaders()
```
    Returns whether column headers can be edited.
    
    Specified by:
    
    isAllowEditHeaders in interface Spreadsheet
    
    Returns:
    
    see above.
  - setAllowEditHeaders
```
public void setAllowEditHeaders(logical value)
```
    Sets whether column headers can be edited by the user.
    
    Specified by:
    
    setAllowEditHeaders in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - isAllowInCellEditing
```
public logical isAllowInCellEditing()
```
    Returns whether in-cell editing is allowed.
    
    Specified by:
    
    isAllowInCellEditing in interface Spreadsheet
    
    Returns:
    
    see above.
  - setAllowInCellEditing
```
public void setAllowInCellEditing(logical value)
```
    Sets whether in-cell editing is allowed.
    
    Specified by:
    
    setAllowInCellEditing in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - isAllowMoveRange
```
public logical isAllowMoveRange()
```
    Returns whether you can move ranges by dragging them.
    
    Specified by:
    
    isAllowMoveRange in interface Spreadsheet
    
    Returns:
    
    see above.
  - setAllowMoveRange
```
public void setAllowMoveRange(logical value)
```
    Sets whether you can move ranges by dragging them.
    
    Specified by:
    
    setAllowMoveRange in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - isAllowResize
```
public logical isAllowResize()
```
    Returns whether you can resize rows and columns by dragging them.
    
    Specified by:
    
    isAllowResize in interface Spreadsheet
    
    Returns:
    
    see above.
  - setAllowResize
```
public void setAllowResize(logical value)
```
    Sets whether you can resize rows and columns by dragging them.
    
    Specified by:
    
    setAllowResize in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - isAllowSelections
```
public logical isAllowSelections()
```
    Returns whether cells can be selected with user input.
    
    Specified by:
    
    isAllowSelections in interface Spreadsheet
    
    Returns:
    
    see above.
  - setAllowSelections
```
public void setAllowSelections(logical value)
```
    Sets whether cells can be selected with user input.
    
    Specified by:
    
    setAllowSelections in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - isAutoRecalc
```
public logical isAutoRecalc()
```
    Returns whether automatic recalculation is enabled.
    
    Specified by:
    
    isAutoRecalc in interface Spreadsheet
    
    Returns:
    
    see above.
  - setAutoRecalc
```
public void setAutoRecalc(logical value)
```
    Sets whether automatic recalculation is enabled.
    
    Specified by:
    
    setAutoRecalc in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - setBackColor
```
public void setBackColor(NumberType value)
```
    Sets the background color of the view. Use the value returned by RGB-VALUE.
    
    Specified by:
    
    setBackColor in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - setExtraColor
```
public void setExtraColor(NumberType value)
```
    Sets the background color of the view outside the workbook. Use the value returned by RGB-VALUE.
    
    Specified by:
    
    setExtraColor in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - startEdit
```
public void startEdit(logical clear,
                      logical inCellEditFocus,
                      logical arrowsExitEditMode)
```
    Begins edit mode for the active cell.
    
    Specified by:
    
    startEdit in interface Spreadsheet
    
    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 - Sets the arrows exit edit mode flag. If True, edit mode is exited if you press an arrow key on the keyboard.
  - cancelEdit
```
public void cancelEdit()
```
    Cancels edit mode and leaves the contents of the active cell unchanged.
    CancelEdit aborts cell editing and exits edit mode without altering the contents of the active cell.
    
    Specified by:
    
    cancelEdit in interface Spreadsheet
  - isCanEditPaste
```
public logical isCanEditPaste()
```
    Returns whether the internal clipboard contain items that can be pasted to the worksheet.
    If this property returns True, there is data available to paste. This is a read-only property.
    
    Specified by:
    
    isCanEditPaste in interface Spreadsheet
    
    Returns:
    
    see above.
  - clearBook
```
public void clearBook()
```
    Resets the book to the initial state - removes all sheets and creates new empty one.
    
    Specified by:
    
    clearBook in interface Spreadsheet
  - clearRange
```
public void clearRange(NumberType row,
                       NumberType column,
                       NumberType lastRow,
                       NumberType lastColumn,
                       NumberType clearType)
```
    Clears the specified range in all selected sheets.
    If nRow1 is -1, all rows are included in the range; if nCol1 is -1, all columns are included.
    
    Specified by:
    
    clearRange in interface Spreadsheet
    
    Parameters:
    
    row - Coordinate that specifies the range to clear. See above. If -1, all rows are included in the range.
    
    column - Coordinate that specifies the range to clear. See above. If -1, all columns are included in the range.
    
    lastRow - Coordinate that specifies the range to clear. See above.
    
    lastColumn - Coordinate that specifies the range to clear. See above.
    
    clearType - Determines what is cleared from the specified range: The following table lists the valid constants: Constant Description 0 Not supported. 1 All (values and formats). 2 Formats only. 3 Values only (including formulas).
  - getClip
```
public character getClip()
```
    Exports tab-delimited text strings from workbooks.
    The Clip property can set or obtain a tab-delimited text block in a workbook. When obtaining a block of text from a worksheet, it is obtained from the currently selected range. If multiple ranges are selected, only text from the first range is used.
    
    Specified by:
    
    getClip in interface Spreadsheet
    
    Returns:
    
    see above.
  - setClip
```
public void setClip(character value)
```
    Imports tab-delimited text strings to workbooks.
    The Clip property can set or obtain a tab-delimited text block in a workbook. 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.
    
    Specified by:
    
    setClip in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - getActiveColumn
```
public int64 getActiveColumn()
```
    Determines the active column in the active worksheet.
    The active cell is the cell on which the cursor is currently located. It is the cell in which data is entered or edited if the user starts typing. The Col property is used with the Row property to set the active cell in the worksheet.
    
    Specified by:
    
    getActiveColumn in interface Spreadsheet
    
    Returns:
    
    the returned value identifies a 1-based column number.
  - setActiveColumn
```
public void setActiveColumn(NumberType value)
```
    Sets the active column in the active worksheet.
    The active cell is the cell on which the cursor is currently located. It is the cell in which data is entered or edited if the user starts typing. The Col property is used with the Row property to set the active cell in the worksheet.
    
    Specified by:
    
    setActiveColumn in interface Spreadsheet
    
    Parameters:
    
    value - Identifies a 1-based column number.
  - isColHidden
```
public logical isColHidden(NumberType column)
```
    Returns the display status of an individual column.
    
    Specified by:
    
    isColHidden in interface Spreadsheet
    
    Parameters:
    
    column - 1-based column number.
    
    Returns:
    
    True, the column is hidden. If it is False, the column is displayed.
  - setColHidden
```
public void setColHidden(NumberType column,
                         logical value)
```
    Sets or returns the display status of an individual column.
    
    Specified by:
    
    setColHidden in interface Spreadsheet
    
    Parameters:
    
    column - 1-based column number.
    
    value - True, the column is hidden. If it is False, the column is displayed.
  - getColWidth
```
public integer getColWidth(NumberType column)
```
    Returns the width of a single column.
    
    Specified by:
    
    getColWidth in interface Spreadsheet
    
    Parameters:
    
    column - Identifies a column by number.
    
    Returns:
    
    See above.
  - setColWidth
```
public void setColWidth(NumberType column,
                        NumberType width)
```
    Sets the width of a single column. Setting this property affects all selected sheets.
    
    Specified by:
    
    setColWidth in interface Spreadsheet
    
    Parameters:
    
    column - Identifies a column by number.
    
    width - Indicates the column width value.
  - setColWidth
```
public void setColWidth(NumberType firstColumn,
                        NumberType lastColumn,
                        NumberType width,
                        logical defaultColumnWidth)
```
    Sets the width of multiple columns. Setting this property affects all selected sheets.
    
    Specified by:
    
    setColWidth in interface Spreadsheet
    
    Parameters:
    
    firstColumn - Identifies the first column.
    
    lastColumn - Identifies the last column.
    
    width - Indicates the column width value.
    
    defaultColumnWidth - Specifies whether the default column width is changed. True specifies that the default width is set to nWidth, and the specified columns are set to the default width.
  - setColWidthAuto
```
public void setColWidthAuto(NumberType row1,
                            NumberType col1,
                            NumberType row2,
                            NumberType col2,
                            logical setDefaults)
```
    Sets the widths of the specified columns to automatically adjust to the largest column entry, including the header.
    
    Specified by:
    
    setColWidthAuto in interface Spreadsheet
    
    Parameters:
    
    row1 - Specifies the first row of the range containing the columns for which to set the width.
    
    col1 - Specifies the first column of the range containing the columns for which to set the width.
    
    row2 - Specifies the last row of the range containing the columns for which to set the width.
    
    col2 - Specifies the last column of the range containing the columns for which to set the width.
    
    setDefaults - This parameter is not supported.
  - setColWidthTwips
```
public void setColWidthTwips(NumberType firstColumn,
                             NumberType lastColumn,
                             NumberType width,
                             logical defaultColumnWidth)
```
    Changes the width of one or more columns to the specified number of twips.
    
    Specified by:
    
    setColWidthTwips in interface Spreadsheet
    
    Parameters:
    
    firstColumn - Identifies the first column.
    
    lastColumn - Identifies the last column.
    
    width - Indicates the column width in twips.
    
    defaultColumnWidth - Specifies whether the default column width is changed. True specifies that the default width is set to width, and the specified columns are set to the default width.
  - setRowHeight
```
public void setRowHeight(NumberType firstRow,
                         NumberType lastRow,
                         NumberType height,
                         logical defaultRowHeight)
```
    Changes the height of one or more rows to the specified number of twips.
    
    Specified by:
    
    setRowHeight in interface Spreadsheet
    
    Parameters:
    
    firstRow - Identifies the first row.
    
    lastRow - Identifies the last row.
    
    height - Indicates the row height in twips.
    
    defaultRowHeight - Specifies whether the default row height is changed. True specifies that the default height is set to height, and the specified columns are set to the default height.
  - getColText
```
public character getColText(NumberType column)
```
    Returns the label for a column.
    
    Specified by:
    
    getColText in interface Spreadsheet
    
    Parameters:
    
    column - Identifies a column by number.
    
    Returns:
    
    The column label text.
  - setColText
```
public void setColText(NumberType column,
                       character text)
```
    Sets the label for a column. Setting this property affects all selected sheets.
    
    Specified by:
    
    setColText in interface Spreadsheet
    
    Parameters:
    
    column - Identifies a column by number.
    
    text - The column label text.
  - getRowText
```
public character getRowText(NumberType row)
```
    Returns the label for a row.
    
    Specified by:
    
    getRowText in interface Spreadsheet
    
    Parameters:
    
    row - Identifies a row by number.
    
    Returns:
    
    The row label text.
  - setRowText
```
public void setRowText(NumberType row,
                       character text)
```
    Sets the label for a row. Setting this property affects all selected sheets.
    
    Specified by:
    
    setRowText in interface Spreadsheet
    
    Parameters:
    
    row - Identifies a row by number.
    
    text - The row label text.
  - getDefinedName
```
public character getDefinedName(character name)
```
    Returns the cell area reference string associated with a defined name.
    
    Specified by:
    
    getDefinedName in interface Spreadsheet
    
    Parameters:
    
    name - An existing defined name associated with an area reference.
    
    Returns:
    
    Area reference string, $B$10:$F$10 for example.
  - setDefinedName
```
public void setDefinedName(character name,
                           character areaRef)
```
    Associates a name with an area reference.
    
    Specified by:
    
    setDefinedName in interface Spreadsheet
    
    Parameters:
    
    name - A unique name will create new association, an existing name will change the existing one.
    
    areaRef - Area reference string, $B$10:$F$10 for example.
  - deleteDefinedName
```
public void deleteDefinedName(character name)
```
    Deletes the specified user-defined name.
    
    Specified by:
    
    deleteDefinedName in interface Spreadsheet
    
    Parameters:
    
    name - Identifies the user-defined name to delete.
  - editClear
```
public void editClear(NumberType clearType)
```
    Clears all cells in the selected ranges.
    
    Specified by:
    
    editClear in interface Spreadsheet
    
    Parameters:
    
    clearType - Determines what is cleared from the specified range: The following table lists the valid constants: Constant Description 0 Not supported. 1 All (values and formats). 2 Formats only. 3 Values only (including formulas).
  - editCopy
```
public void editCopy()
```
    Copies the selected range or objects to the clipboard.
    
    Specified by:
    
    editCopy in interface Spreadsheet
  - editCopyDown
```
public void editCopyDown()
```
    Copies cells in the top row of a selection to the other rows in the selected range.
    EditCopyDown copies data in the top row of a selection to the other rows in the selection and adjusts relative cell references appropriately.
    
    Specified by:
    
    editCopyDown in interface Spreadsheet
  - editPaste
```
public void editPaste()
```
    Pastes the contents of the clipboard to the selected range.
    EditPaste pastes information from the clipboard to the selected range in the active worksheet. How the information is pasted in the worksheet depends on 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.
    
    Specified by:
    
    editPaste in interface Spreadsheet
  - isEnableProtection
```
public logical isEnableProtection()
```
    Returns whether protection is enabled for all selected sheets.
    If this property is True, protection is enabled. Enabling protection means that any cells marked as hidden or locked are actually hidden and locked.
    
    Specified by:
    
    isEnableProtection in interface Spreadsheet
    
    Returns:
    
    see above.
  - setEnableProtection
```
public void setEnableProtection(logical value)
```
    Sets whether protection is enabled for all selected sheets.
    If this property is True, protection is enabled. Enabling protection means that any cells marked as hidden or locked are actually hidden and locked.
    
    Specified by:
    
    setEnableProtection in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - endEdit
```
public integer endEdit()
```
    Ends edit mode and applies changes to the active cell.
    EndEdit ends cell editing and applies any changes made during edit mode to the active cell. If an invalid entry has been made (e.g., an incorrect formula), edit mode cannot end. In this case, Spreadsheet.ErrorGeneral is returned.
    
    Specified by:
    
    endEdit in interface Spreadsheet
  - isEnterMovesDown
```
public logical isEnterMovesDown()
```
    Returns whether pressing the ENTER key moves the active cell down to the next cell.
    If this property is True, pressing the ENTER key moves the active cell down to the next row, even if no range is selected. If False and a single cell is selected, pressing the ENTER key does not advance the active cell. When you create a new workbook, this property is True by default.
    
    Specified by:
    
    isEnterMovesDown in interface Spreadsheet
    
    Returns:
    
    see above.
  - setEnterMovesDown
```
public void setEnterMovesDown(logical value)
```
    Sets whether pressing the ENTER key moves the active cell down to the next cell.
    If this property is True, pressing the ENTER key moves the active cell down to the next row, even if no range is selected. If False and a single cell is selected, pressing the ENTER key does not advance the active cell. When you create a new workbook, this property is True by default.
    
    Specified by:
    
    setEnterMovesDown in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - getEntry
```
public character getEntry()
```
    Returns the contents of the active cell in the first selected worksheet in the same format as it would be displayed while in edit mode.
    The text returned by this property is in the same format as if you were entering or editing the cell's value. If the cell contains a formula, the text of the formula is returned. Formulas are returned preceded by an equal sign (=).
    
    Specified by:
    
    getEntry in interface Spreadsheet
    
    Returns:
    
    see above.
  - setEntry
```
public void setEntry(character value)
```
    Enters text in the active cell of all selected worksheets. Setting this property 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 (=).
    
    Specified by:
    
    setEntry in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - getEntryRC
```
public character getEntryRC(NumberType row,
                            NumberType col)
```
    Returns the contents of the specified cell in the first selected worksheet in the same format as it would be displayed while in edit mode.
    The text returned by this property is in the same format as if you were entering or editing the cell's value. If the cell contains a formula, the text of the formula is returned. Formulas are returned preceded by an equal sign (=).
    
    Specified by:
    
    getEntryRC in interface Spreadsheet
    
    Parameters:
    
    row - 1-based row number.
    
    col - 1-based column number.
    
    Returns:
    
    see above.
  - setEntryRC
```
public void setEntryRC(NumberType row,
                       NumberType col,
                       character value)
```
    Enters text in the specified cell of all selected worksheets. Setting this property 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 (=).
    
    Specified by:
    
    setEntryRC in interface Spreadsheet
    
    Parameters:
    
    row - 1-based row number.
    
    col - 1-based column number.
    
    value - The value to set.
  - getEntrySRC
```
public character getEntrySRC(NumberType sheet,
                             NumberType row,
                             NumberType col)
```
    Returns the contents of the specified cell on the specified worksheet in the same format as it would be displayed while in edit mode.
    The text returned by this property is in the same format as if you were entering or editing the cell's value. If the cell contains a formula, the text of the formula is returned. Formulas are returned preceded by an equal sign (=).
    
    Specified by:
    
    getEntrySRC in interface Spreadsheet
    
    Parameters:
    
    sheet - 1-based sheet number.
    
    row - 1-based row number.
    
    col - 1-based column number.
    
    Returns:
    
    see above.
  - setEntrySRC
```
public void setEntrySRC(NumberType sheet,
                        NumberType row,
                        NumberType col,
                        character value)
```
    Enters text in the specified cell on the specified worksheet. Setting this property 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 (=).
    
    Specified by:
    
    setEntrySRC in interface Spreadsheet
    
    Parameters:
    
    sheet - 1-based sheet number.
    
    row - 1-based row number.
    
    col - 1-based column number.
    
    value - The value to set.
  - filePrint
```
public void filePrint(logical showPrintDlg)
```
    Prints the selected worksheet.
    
    Specified by:
    
    filePrint in interface Spreadsheet
    
    Parameters:
    
    showPrintDlg - Sets the show print dialog flag. If this flag is True, the Print dialog box is displayed before printing. The Print dialog box allows the user to set printing parameters such as the page range and number of copies to print.
  - findDlg
```
public void findDlg()
```
    Displays the Find dialog.
    
    Specified by:
    
    findDlg in interface Spreadsheet
  - getFixedRow
```
public int64 getFixedRow()
```
    Returns the starting fixed row for the active worksheet.
    
    Specified by:
    
    getFixedRow in interface Spreadsheet
    
    Returns:
    
    see above.
  - getFixedRows
```
public int64 getFixedRows()
```
    Returns how many rows to fix at the top of the active worksheet. The FixedRows property is used with the FixedRow property to fix one or more rows at the top of the worksheet. The fixed rows do not scroll when the worksheet is scrolled vertically.
    
    Specified by:
    
    getFixedRows in interface Spreadsheet
    
    Returns:
    
    see above.
  - setFixedRows
```
public void setFixedRows(NumberType value)
```
    Sets how many rows to fix at the top of the active worksheet. The FixedRows property is used with the FixedRow property to fix one or more rows at the top of the worksheet. The fixed rows do not scroll when the worksheet is scrolled vertically.
    
    Specified by:
    
    setFixedRows in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - getFixedCol
```
public int64 getFixedCol()
```
    Returns the starting fixed column for the active worksheet.
    
    Specified by:
    
    getFixedCol in interface Spreadsheet
    
    Returns:
    
    see above.
  - getFixedCols
```
public int64 getFixedCols()
```
    Returns how many columns to fix at the left of the active worksheet. The FixedCols property is used with the FixedCol property to fix one or more columns at the left of the worksheet. The fixed columns do not scroll when the worksheet is scrolled horizontally.
    
    Specified by:
    
    getFixedCols in interface Spreadsheet
    
    Returns:
    
    see above.
  - setFixedCols
```
public void setFixedCols(NumberType value)
```
    Sets how many columns to fix at the left of the active worksheet. The FixedCols property is used with the FixedCol property to fix one or more columns at the left of the worksheet. The fixed columns do not scroll when the worksheet is scrolled horizontally.
    
    Specified by:
    
    setFixedCols in interface Spreadsheet
    
    Parameters:
    
    value - The value to set.
  - formatFixed2
```
public void formatFixed2()
```
    Formats the selected ranges on all selected worksheets with fixed format and two decimal places. Fixed format includes thousands separators (normally commas).
    
    Specified by:
    
    formatFixed2 in interface Spreadsheet
  - formatBorderDlg
```
public void formatBorderDlg()
```
    Displays the Border dialog box.
    
    Specified by:
    
    formatBorderDlg in interface Spreadsheet
  - formatPatternDlg
```
public void formatPatternDlg()
```
    Displays the Pattern dialog box.
    
    Specified by:
    
    formatPatternDlg in interface Spreadsheet
  - getFormattedText
```
public character getFormattedText()
```
    Returns the formatted text value of the active cell. This property returns the text as it is seen in the spreadsheet, including all formatting.
    
    Specified by:
    
    getFormattedText in interface Spreadsheet
    
    Returns:
    
    see above.
  - getFormattedTextRC
```
public character getFormattedTextRC(NumberType row,
                                    NumberType col)
```
    Returns the formatted text value of the specified cell. This property returns the text as it is seen in the spreadsheet, including all formatting.
    
    Specified by:
    
    getFormattedTextRC in interface Spreadsheet
    
    Parameters:
    
    row - 1-based row number of the cell from which the text is returned.
    
    col - 1-based column number of the cell from which the text is returned.
    
    Returns:
    
    see above.
  - getFormattedTextSRC
```
public character getFormattedTextSRC(NumberType sheet,
                                     NumberType row,
                                     NumberType col)
```
    Returns the formatted text value of the specified cell as it appears in the specified worksheet. This property returns the text as it is seen in the spreadsheet, including all formatting.
    
    Specified by:
    
    getFormattedTextSRC in interface Spreadsheet
    
    Parameters:
    
    sheet - 1-based number of the sheet from which the text is returned.
    
    row - 1-based row number of the cell from which the text is returned.
    
    col - 1-based column number of the cell from which the text is returned.
    
    Returns:
    
    see above.
  - insertRange
```
public void insertRange(NumberType row,
                        NumberType col,
                        NumberType lastRow,
                        NumberType lastCol,
                        NumberType shiftType)
```
    Moves the specified range in order to insert new cells, rows, or columns. The specified coordinates specify the range that identifies how many cells, rows, or columns are inserted and where they are inserted.
    
    Specified by:
    
    insertRange in interface Spreadsheet
    
    Parameters:
    
    row - First row.
    
    col - First column.
    
    lastRow - Last row.
    
    lastCol - Last column.
    
    shiftType - Determine how the insert should occur.
    Value Meaning ----- ------- 1 Cells of the specified range are shifted right to make room for the inserted cells. 2 Cells of the specified range are shifted down to make room for the inserted cells. 3 Rows in which the specified range resides are shifted down to make room for the inserted cells. 4 Columns in which the specified range resides are shifted right to make room for the inserted cells.
  - copyRange
```
public void copyRange(NumberType dstRow,
                      NumberType dstCol,
                      NumberType dstLastRow,
                      NumberType dstLastCol,
                      NumberType sourceView,
                      NumberType srcRow,
                      NumberType srcCol,
                      NumberType srcLastRow,
                      NumberType srcLastCol)
```
    Copies a range of data to the specified location. This method can be used to copy ranges within a worksheet.
    
    Specified by:
    
    copyRange in interface Spreadsheet
    
    Parameters:
    
    dstRow - First row of the destination range.
    
    dstCol - First column of the destination range.
    
    dstLastRow - Last row of the destination range.
    
    dstLastCol - Last column of the destination range.
    
    sourceView - Ignored.
    
    srcRow - First row of the source range.
    
    srcCol - First column of the source range.
    
    srcLastRow - Last row of the source range.
    
    srcLastCol - Last column of the source range.
  - deleteRange
```
public void deleteRange(NumberType row,
                        NumberType col,
                        NumberType lastRow,
                        NumberType lastCol,
                        NumberType shiftType)
```
    Deletes cells, rows, or columns from the specified range. The specified coordinates specify the range to delete.
    
    Specified by:
    
    deleteRange in interface Spreadsheet
    
    Parameters:
    
    row - First row.
    
    col - First column.
    
    lastRow - Last row.
    
    lastCol - Last column.
    
    shiftType - Determine how the delete should occur.
    Value Meaning ----- ------- 1 Cells to the right of the range are shifted left to fill the vacated space. 2 Cells below the range are shifted up to fill the vacated space. 3 Rows in which the range resides are deleted and lower rows are shifted up to fill the vacated space. 4 Columns in which the range resides are deleted and the rightmost columns are shifted left to fill the vacated space.
  - getActiveCell
```
public void getActiveCell(NumberType row,
                          NumberType col)
```
    Returns the row and column coordinates of the active cell.
    The active cell is the cell on which the cursor is currently located. It is the cell in which data is entered or edited if the user starts typing.
    
    Specified by:
    
    getActiveCell in interface Spreadsheet
    
    Parameters:
    
    row - The passed in argument will receive the 1-based row number of the active cell.
    
    col - The passed in argument will receive the 1-based column number of the active cell.
  - getProtection
```
public void getProtection(logical locked,
                          logical hidden)
```
    Returns the protection status of the active cell.
    After locking cells and hiding formulas, you must enable protection for the workbook before cell locking and formula hiding is enabled. Protection for a workbook is enabled using the EnableProtection property.
    
    Specified by:
    
    getProtection in interface Spreadsheet
    
    Parameters:
    
    locked - The passed in argument will receive the status of the locked cell flag. If the locked cell flag is True, the active cell is locked.
    
    hidden - The passed in argument will receive the status of the hide formulas flag. If the hide formulas flag is True, the formulas are hidden (formula results are not hidden).
  - getSelection
```
public void getSelection(NumberType selection,
                         NumberType row1,
                         NumberType col1,
                         NumberType row2,
                         NumberType col2)
```
    Returns the row and column coordinates of the currently selected range.
    
    Specified by:
    
    getSelection in interface Spreadsheet
    
    Parameters:
    
    selection - Identifies the index of the selection. An index of 0 returns the row and column coordinates of the first selection. Only first selection is supported (value of 0).
    
    row1 - The passed in argument will be assigned the 1-based row number of the selection start.
    
    col1 - The passed in argument will be assigned the 1-based column number of the selection start.
    
    row2 - The passed in argument will be assigned the 1-based row number of the selection end.
    
    col2 - The passed in argument will be assigned the 1-based column number of the selection end.
  - getSelectionCount
```
public integer getSelectionCount()
```
    Returns the number of selected ranges.
    
    Specified by:
    
    getSelectionCount in interface Spreadsheet
    
    Returns:
    
    see above.
  - getLastCol
```
public int64 getLastCol()
```
    Returns the number of the last occupied column. This property returns the last column that is not empty, including cells that contain only formatting.
    
    Specified by:
    
    getLastCol in interface Spreadsheet
    
    Returns:
    
    1-based column number.
  - getLastRow
```
public int64 getLastRow()
```
    Returns the number of the last occupied row. This property returns the last row that is not empty, including cells that contain only formatting.
    
    Specified by:
    
    getLastRow in interface Spreadsheet
    
    Returns:
    
    1-based column number.
  - getTopRow
```
public int64 getTopRow()
```
    Returns the topmost row currently displayed in the view.
    
    Specified by:
    
    getTopRow in interface Spreadsheet
    
    Returns:
    
    see above.
  - setTopRow
```
public void setTopRow(NumberType value)
```
    Sets the topmost row currently displayed in the view.
    
    Specified by:
    
    setTopRow in interface Spreadsheet
    
    Parameters:
    
    value - The new value to assign.
  - getLeftCol
```
public int64 getLeftCol()
```
    Returns the leftmost column currently displayed in the view.
    
    Specified by:
    
    getLeftCol in interface Spreadsheet
    
    Returns:
    
    see above.
  - setLeftCol
```
public void setLeftCol(NumberType value)
```
    Sets the leftmost column currently displayed in the view.
    
    Specified by:
    
    setLeftCol in interface Spreadsheet
    
    Parameters:
    
    value - The new value to assign.
  - getLogicalRC
```
public logical getLogicalRC(NumberType row,
                            NumberType col)
```
    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.
    
    Specified by:
    
    getLogicalRC in interface Spreadsheet
    
    Parameters:
    
    row - 1-based row number that identifies a cell.
    
    col - 1-based column number that identifies a cell.
    
    Returns:
    
    see above.
  - setLogicalRC
```
public void setLogicalRC(NumberType row,
                         NumberType col,
                         logical value)
```
    Sets the logical (True or False) value of the specified cell. Setting this property affects all selected sheets.
    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.
    
    Specified by:
    
    setLogicalRC in interface Spreadsheet
    
    Parameters:
    
    row - 1-based row number that identifies a cell.
    
    col - 1-based column number that identifies a cell.
    
    value - Indicates the specified cell's logical value.
  - getLogicalSRC
```
public logical getLogicalSRC(NumberType sheet,
                             NumberType row,
                             NumberType col)
```
    Returns the logical (True or False) value of the specified cell and sheet.
    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.
    
    Specified by:
    
    getLogicalSRC in interface Spreadsheet
    
    Parameters:
    
    sheet - 1-based number that identifies a sheet.
    
    row - 1-based row number that identifies a cell.
    
    col - 1-based column number that identifies a cell.
    
    Returns:
    
    see above.
  - setLogicalSRC
```
public void setLogicalSRC(NumberType sheet,
                          NumberType row,
                          NumberType col,
                          logical value)
```
    Sets the logical (True or False) value of the specified cell and sheet. Setting this property affects all selected sheets.
    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.
    
    Specified by:
    
    setLogicalSRC in interface Spreadsheet
    
    Parameters:
    
    sheet - 1-based number that identifies a sheet.
    
    row - 1-based row number that identifies a cell.
    
    col - 1-based column number that identifies a cell.
    
    value - Indicates the specified cell's logical value.
  - getMaxCol
```
public int64 getMaxCol()
```
    Returns the last displayable column in the active worksheet. Columns beyond the last column are not displayed but can be used to hold data and formulas. This property returns the current last displayable column.
    
    Specified by:
    
    getMaxCol in interface Spreadsheet
    
    Returns:
    
    the number of the last displayable column.
  - setMaxCol
```
public void setMaxCol(NumberType value)
```
    Sets the last displayable column in a the active worksheet. Columns beyond the last column are not displayed but can be used to hold data and formulas. Set this property to change the last displayable column.
    
    Specified by:
    
    setMaxCol in interface Spreadsheet
    
    Parameters:
    
    value - 1-based number of the last displayable column.
  - getMaxRow
```
public int64 getMaxRow()
```
    Returns the last displayable row in the active worksheet. Rows beyond the last row are not displayed but can be used to hold data and formulas. This property returns the current last displayable row.
    
    Specified by:
    
    getMaxRow in interface Spreadsheet
    
    Returns:
    
    the number of the last displayable row.
  - setMaxRow
```
public void setMaxRow(NumberType value)
```
    Sets the last displayable row in a the active worksheet. Rows beyond the last row are not displayed but can be used to hold data and formulas. Set this property to change the last displayable row.
    
    Specified by:
    
    setMaxRow in interface Spreadsheet
    
    Parameters:
    
    value - 1-based number of the last displayable row.
  - getModified
```
public logical getModified()
```
    Returns the state of the modified flag which indicates whether modifications have been made to a view.
    The value of this property indicates whether modifications have been made. When a new view is created the Modified property is set to False. When something in the view is changed, Modified is set to True and the Modified event is fired. If further changes are made, the Modified event is not fired again. It will not be fired again until you set this property to False.
    To cause the Modified event to be fired every time a change is made to the workbook, set the modified flag to False from within the Modified event.
    
    Specified by:
    
    getModified in interface Spreadsheet
    
    Returns:
    
    see above.
  - setModified
```
public void setModified(logical value)
```
    Defines if the SCREEN-VALUE attribute for this widget has changed.
    
    Specified by:
    
    setModified in interface CommonWidget
    
    Specified by:
    
    setModified in interface Spreadsheet
    
    Overrides:
    
    setModified in class GenericWidget<SpreadsheetConfig>
    
    Parameters:
    
    value - true to mark the screen value as changed.
  - getNumber
```
public decimal getNumber()
```
    Returns the numeric value of the active cell.
    When returning the value, cells containing a formula return the numeric result of the formula. If the 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.
    
    Specified by:
    
    getNumber in interface Spreadsheet
    
    Returns:
    
    the cell value.
  - setNumber
```
public void setNumber(NumberType value)
```
    Sets the numeric value of the active cell. Setting this property affects all selected sheets. If the active cell contains a formula, the formula is deleted when the numeric value is assigned.
    
    Specified by:
    
    setNumber in interface Spreadsheet
    
    Parameters:
    
    value - The cell value to set.
  - getNumberRC
```
public decimal getNumberRC(NumberType row,
                           NumberType col)
```
    Returns the numeric value of the specified cell.
    When returning the value, cells containing a formula return the numeric result of the formula. If the 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.
    
    Specified by:
    
    getNumberRC in interface Spreadsheet
    
    Parameters:
    
    row - 1-based row number that identifies the cell.
    
    col - 1-based column number that identifies the cell.
    
    Returns:
    
    the cell value.
  - setNumberRC
```
public void setNumberRC(NumberType row,
                        NumberType col,
                        NumberType value)
```
    Sets the numeric value of the specified cell. Setting this property affects all selected sheets. If the specified cell contains a formula, the formula is deleted when the numeric value is assigned.
    
    Specified by:
    
    setNumberRC in interface Spreadsheet
    
    Parameters:
    
    row - 1-based row number that identifies the cell.
    
    col - 1-based column number that identifies the cell.
    
    value - The cell value to set.
  - getNumberSRC
```
public decimal getNumberSRC(NumberType sheet,
                            NumberType row,
                            NumberType col)
```
    Returns the numeric value of the specified cell.
    When returning the value, cells containing a formula return the numeric result of the formula. If the 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.
    
    Specified by:
    
    getNumberSRC in interface Spreadsheet
    
    Parameters:
    
    sheet - 1-based number that identifies a sheet.
    
    row - 1-based row number that identifies the cell.
    
    col - 1-based column number that identifies the cell.
    
    Returns:
    
    the cell value.
  - setNumberSRC
```
public void setNumberSRC(NumberType sheet,
                         NumberType row,
                         NumberType col,
                         NumberType value)
```
    Sets the numeric value of the specified cell. Setting this property affects all selected sheets. If the specified cell contains a formula, the formula is deleted when the numeric value is assigned.
    
    Specified by:
    
    setNumberSRC in interface Spreadsheet
    
    Parameters:
    
    sheet - 1-based number that identifies a sheet.
    
    row - 1-based row number that identifies the cell.
    
    col - 1-based column number that identifies the cell.
    
    value - The cell value to set.
  - getNumberFormat
```
public character getNumberFormat()
```
    Returns the number format for the active cell.
    
    Specified by:
    
    getNumberFormat in interface Spreadsheet
    
    Returns:
    
    The number format string.
  - setNumberFormat
```
public void setNumberFormat(character format)
```
    Sets or returns the number format for the active cell in all selected sheets.
    
    Specified by:
    
    setNumberFormat in interface Spreadsheet
    
    Parameters:
    
    format - The number format string.
  - getNumSheets
```
public int64 getNumSheets()
```
    Returns the number of worksheets in the current workbook.
    
    Specified by:
    
    getNumSheets in interface Spreadsheet
    
    Returns:
    
    see above.
  - setNumSheets
```
public void setNumSheets(NumberType value)
```
    Sets the number of worksheets in the current workbook.
    Set NumSheets 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.
    
    Specified by:
    
    setNumSheets in interface Spreadsheet
    
    Parameters:
    
    value - The new number of sheets.
  - deleteSheets
```
public void deleteSheets(NumberType index,
                         NumberType count)
```
    Deletes the supplied sheets.
    
    Specified by:
    
    deleteSheets in interface Spreadsheet
    
    Parameters:
    
    index - 1-based index of the first sheet to delete.
    
    count - The number of sheets to delete.
  - objGetCell
```
public void objGetCell(NumberType id,
                       NumberType hasCell,
                       NumberType row,
                       NumberType col)
```
    Returns the worksheet cell assigned to hold the value displayed by the specified check box or list box object.
    
    Specified by:
    
    objGetCell in interface Spreadsheet
    
    Parameters:
    
    id - Identification number of the object.
    
    hasCell - The returned state of the object cell flag. The parameter is not supported and the passed in argument will be ignored.
    
    row - Upon return, the argument will be assigned 1-based row number that identifies the cell in which the object value is placed.
    
    col - Upon return, the argument will be assigned 1-based column number that identifies the cell in which the object value is placed.
  - getObjName
```
public character getObjName(NumberType id)
```
    Returns the name of the specified object.
    
    Specified by:
    
    getObjName in interface Spreadsheet
    
    Parameters:
    
    id - Identification number of the object.
    
    Returns:
    
    Object name.
  - setObjName
```
public void setObjName(NumberType id,
                       character name)
```
    Sets the name of the specified object.
    
    Specified by:
    
    setObjName in interface Spreadsheet
    
    Parameters:
    
    id - Identification number of the object.
    
    name - Object name.
  - objNameToID
```
public int64 objNameToID(character name)
```
    Returns the object identification number for an object specified by name.
    
    Specified by:
    
    objNameToID in interface Spreadsheet
    
    Parameters:
    
    name - Object name.
    
    Returns:
    
    The object's identification number.
  - objNew
```
public void objNew(NumberType type,
                   NumberType x1,
                   NumberType y1,
                   NumberType x2,
                   NumberType y2,
                   NumberType id)
```
    Creates and adds an object to the active worksheet. When specifying the location of the object, integers place the edge of the object on a row or column border; fractional numbers place the edge of the object between borders. For example, if X1 is 1.25, the first anchor point is placed one and a quarter columns from the left edge of the worksheet; if nY1 is 3, the first anchor point is placed exactly three rows from the top of the worksheet. The first anchor point (identified by X1 and Y1) can be to the right and below the second anchor point. When drawing rectangles, ovals, buttons, list boxes, and check boxes, the order of the anchor points is of no consequence. However, when drawing lines and arcs, the order and placement of the anchor points affects the angle and direction in which the object is drawn.
    
    Specified by:
    
    objNew in interface Spreadsheet
    
    Parameters:
    
    type - Identifies the type of object to create. The supported object types: Type Description 7 Button 9 Check-box 10 Combo-box
    
    x1 - The coordinate that represents the first anchor point of the object. It is measured in columns from the left edge of the worksheet.
    
    y1 - The coordinate that represents the first anchor point of the object. It is measured in rows from the top edge of the worksheet.
    
    x2 - The coordinate that represents the second anchor point of the object. It is measured in columns from the left edge of the worksheet.
    
    y2 - The coordinate that represents the second anchor point of the object. It is measured in rows from the top edge of the worksheet.
    
    id - Upon return will be assigned the identification number of the new object.
  - getObjVisible
```
public logical getObjVisible(NumberType id)
```
    Returns whether an object is visible.
    
    Specified by:
    
    getObjVisible in interface Spreadsheet
    
    Parameters:
    
    id - Object identification number.
    
    Returns:
    
    See above.
  - setObjVisible
```
public void setObjVisible(NumberType id,
                          logical value)
```
    Sets whether an object is visible. If this property is true, the specified object is displayed.
    
    Specified by:
    
    setObjVisible in interface Spreadsheet
    
    Parameters:
    
    id - Object identification number.
  - objGetPos
```
public void objGetPos(NumberType id,
                      NumberType x1,
                      NumberType y1,
                      NumberType x2,
                      NumberType y2)
```
    Gets the bounds of an object.
    
    Specified by:
    
    objGetPos in interface Spreadsheet
    
    Parameters:
    
    id - Identification number of the object to position.
    
    x1 - X-coordinate that represent the first anchor point of the object. It is measured in columns from the left edge of the worksheet.
    
    y1 - Y-coordinate that represent the first anchor point of the object. It is measured in rows from the left edge of the worksheet.
    
    x2 - X-coordinate that represent the last anchor point of the object. It is measured in columns from the left edge of the worksheet.
    
    y2 - Y-coordinate that represent the last anchor point of the object. It is measured in rows from the left edge of the worksheet.
  - objSetPos
```
public void objSetPos(NumberType id,
                      NumberType x1,
                      NumberType y1,
                      NumberType x2,
                      NumberType y2)
```
    Sets the position and size of an object.
    
    Specified by:
    
    objSetPos in interface Spreadsheet
    
    Parameters:
    
    id - Identification number of the object to position.
    
    x1 - X-coordinate that represent the first anchor point of the object. It is measured in columns from the left edge of the worksheet.
    
    y1 - Y-coordinate that represent the first anchor point of the object. It is measured in rows from the left edge of the worksheet.
    
    x2 - X-coordinate that represent the last anchor point of the object. It is measured in columns from the left edge of the worksheet.
    
    y2 - Y-coordinate that represent the last anchor point of the object. It is measured in rows from the left edge of the worksheet.
  - getObjText
```
public character getObjText(NumberType id)
```
    Returns the text displayed by a specific button or check box object.
    
    Specified by:
    
    getObjText in interface Spreadsheet
    
    Parameters:
    
    id - Identification number of the object.
    
    Returns:
    
    Object text.
  - setObjText
```
public void setObjText(NumberType id,
                       character text)
```
    Sets the text of the displayed by a specific button or check box object.
    
    Specified by:
    
    setObjText in interface Spreadsheet
    
    Parameters:
    
    id - Identification number of the object.
    
    text - Object text.
  - getObjValue
```
public integer getObjValue(NumberType id)
```
    Returns the value of a check box or list box object.
    For check box objects 0 is unchecked and 1 is checked. For list box objects -1 means no item is displayed, 0 means the first item is displayed, 1 means the second item is displayed, and so on.
    
    Specified by:
    
    getObjValue in interface Spreadsheet
    
    Parameters:
    
    id - Identification number of the object.
    
    Returns:
    
    Object value.
  - setObjValue
```
public void setObjValue(NumberType id,
                        NumberType value)
```
    Sets the value of a check box or list box object.
    For check box objects 0 is unchecked and 1 is checked. For list box objects -1 means no item is displayed, 0 means the first item is displayed, 1 means the second item is displayed, and so on.
    
    Specified by:
    
    setObjValue in interface Spreadsheet
    
    Parameters:
    
    id - Identification number of the object.
    
    value - Object value.
  - getObjItems
```
public character getObjItems(NumberType id)
```
    Returns a semicolon-delimited list of items from a list box object.
    
    Specified by:
    
    getObjItems in interface Spreadsheet
    
    Parameters:
    
    id - Identification number of the object.
    
    Returns:
    
    Semicolon-delimited list of items.
  - setObjItems
```
public void setObjItems(NumberType id,
                        character items)
```
    Assigns a list of values, a semicolon-delimited list of items, to a list box object.
    
    Specified by:
    
    setObjItems in interface Spreadsheet
    
    Parameters:
    
    id - Identification number of the object.
    
    items - Semicolon-delimited list of items.
  - read
```
public void read(character filePath,
                 NumberType fileType)
```
    Reads a worksheet or workbook from a file.
    Read initializes a workbook structure and reads a worksheet from the specified file. If there is not a workbook attached to the view, a new workbook is created.
    
    Specified by:
    
    read in interface Spreadsheet
    
    Parameters:
    
    filePath - Path of the file to read.
    
    fileType - The type of the read file. Currently not supported.
  - recalc
```
public void recalc()
```
    Recalculates the workbook attached to a view. Recalc recalculates all formulas in the workbook attached to the view.
    
    Specified by:
    
    recalc in interface Spreadsheet
  - getActiveRow
```
public int64 getActiveRow()
```
    Determines the active row in the active worksheet.
    The active cell is the cell on which the cursor is currently located. It is the cell in which data is entered or edited if the user starts typing. The Col property is used with the Row property to set the active cell in the worksheet.
    
    Specified by:
    
    getActiveRow in interface Spreadsheet
    
    Returns:
    
    the returned value identifies a 1-based row number.
  - setActiveRow
```
public void setActiveRow(NumberType value)
```
    Sets the active row in the active worksheet.
    The active cell is the cell on which the cursor is currently located. It is the cell in which data is entered or edited if the user starts typing. The Col property is used with the Row property to set the active cell in the worksheet.
    
    Specified by:
    
    setActiveRow in interface Spreadsheet
    
    Parameters:
    
    value - Identifies a 1-based row number.
  - isRowHidden
```
public logical isRowHidden(NumberType row)
```
    Returns the display status of an individual row.
    
    Specified by:
    
    isRowHidden in interface Spreadsheet
    
    Parameters:
    
    row - 1-based row number.
    
    Returns:
    
    True, the row is hidden. If it is False, the row is displayed.
  - setRowHidden
```
public void setRowHidden(NumberType row,
                         logical value)
```
    Sets or returns the display status of an individual row.
    
    Specified by:
    
    setRowHidden in interface Spreadsheet
    
    Parameters:
    
    row - 1-based row number.
    
    value - True, the row is hidden. If it is False, the row is displayed.
  - isScrollToLastRC
```
public logical isScrollToLastRC()
```
    Returns how scrollbars work.
    Normally scroll bars can scroll the last filled cell to the top-left edge of the window. If ScrollToLastRC is set to False, it causes scrolling to stop when the last filled row and column reach the bottom-right edge of the screen. The last row and column can still be set to the top-left edge of the window by setting the TopRow or LeftCol property to the appropriate value.
    
    Specified by:
    
    isScrollToLastRC in interface Spreadsheet
    
    Returns:
    
    see above.
  - setScrollToLastRC
```
public void setScrollToLastRC(logical value)
```
    Sets how scrollbars work.
    Normally scroll bars can scroll the last filled cell to the top-left edge of the window. If ScrollToLastRC is set to False, it causes scrolling to stop when the last filled row and column reach the bottom-right edge of the screen. The last row and column can still be set to the top-left edge of the window by setting the TopRow or LeftCol property to the appropriate value.
    
    Specified by:
    
    setScrollToLastRC in interface Spreadsheet
    
    Parameters:
    
    value - The new scroll value.
  - setActiveCell
```
public void setActiveCell(NumberType row,
                          NumberType col)
```
    Makes the specified cell the active cell.
    The active cell is the cell on which the cursor is currently located. It is the cell in which data is entered or edited if the user starts typing.
    The active cell is highlighted by a heavy border. If you use SetActiveCell to change the active cell to another cell in the same selection, only the active cell changes, the selection is not lost.
    
    Specified by:
    
    setActiveCell in interface Spreadsheet
    
    Parameters:
    
    row - Indicates the number of the row that contains the cell you want to make active.
    
    col - Indicates the number of the column that contains the cell you want to make active.
  - setPattern
```
public void setPattern(NumberType pattern,
                       NumberType fgColor,
                       NumberType bgColor)
```
    Sets the pattern for all selected cells and objects in all selected sheets.
    
    Specified by:
    
    setPattern in interface Spreadsheet
    
    Parameters:
    
    pattern - Indicates the pattern number used to display the cells or objects. The supported patterns are: 0... no pattern 1... solid fill
    
    fgColor - The foreground color. Use rgb-value function to encode the color value.
    
    bgColor - The background color. Use rgb-value function to encode the color value.
  - setProtection
```
public void setProtection(logical locked,
                          logical hidden)
```
    Sets the protection status of all selected cells in all selected sheets. After locking cells and hiding formulas, you must enable protection for the workbook before cell locking and formula hiding is enabled. Protection for a workbook is enabled using the EnableProtection property.
    The method only supports locking, the hidden parameter is ignored.
    
    Specified by:
    
    setProtection in interface Spreadsheet
    
    Parameters:
    
    locked - Sets the locked cell flag. If the locked cell flag is True, the active cell is locked. This is the default setting.
    
    hidden - Sets the hide formulas flag. If the hide formulas flag is True, the formulas are hidden (formula results are not hidden).
  - setSelection
```
public void setSelection(NumberType row1,
                         NumberType col1,
                         NumberType row2,
                         NumberType col2)
```
    Selects the specified range and moves the active cell to the top left cell in the range. nRow1, nCol1, nRow2, nCol2 Long Identifies the row and column coordinates you want to select.
    
    Specified by:
    
    setSelection in interface Spreadsheet
    
    Parameters:
    
    row1 - Identifies the top-left row coordinate you want to select.
    
    col1 - Identifies the top-left column coordinate you want to select.
    
    row2 - Identifies the bottom-right row coordinate you want to select.
    
    col2 - Identifies the bottom-right column coordinate you want to select.
  - getShowSelections
```
public integer getShowSelections()
```
    Returns whether selections are displayed.
    
    Specified by:
    
    getShowSelections in interface Spreadsheet
    
    Returns:
    
    The method always returns 1, meaning all selections are displayed at all times.
  - setShowSelections
```
public void setShowSelections(NumberType value)
```
    Sets whether selections are displayed.
    
    Specified by:
    
    setShowSelections in interface Spreadsheet
    
    Parameters:
    
    value - The only accepted value is 1, meaning all selections are displayed at all times.
  - getSheet
```
public int64 getSheet()
```
    Returns the active worksheet.
    
    Specified by:
    
    getSheet in interface Spreadsheet
    
    Returns:
    
    Index number that identifies an existing worksheet within the workbook attached to the view. Worksheets are indexed from left to right beginning with 1. Do not confuse the index with the sheet name that appears on the sheet tab.
  - setSheet
```
public void setSheet(NumberType value)
```
    Sets the active worksheet.
    
    Specified by:
    
    setSheet in interface Spreadsheet
    
    Parameters:
    
    value - Index number that identifies an existing worksheet within the workbook attached to the view. Worksheets are indexed from left to right beginning with 1. Do not confuse the index with the sheet name that appears on the sheet tab.
  - getSheetName
```
public character getSheetName(NumberType sheet)
```
    This property returns the name of the specified worksheet.
    
    Specified by:
    
    getSheetName in interface Spreadsheet
    
    Parameters:
    
    sheet - Index number that identifies an existing worksheet within the workbook attached to the view. Worksheets are indexed from left to right beginning with 1. Do not confuse the index with the sheet name that appears on the sheet tab.
    
    Returns:
    
    name associated with identified sheet.
  - setSheetName
```
public void setSheetName(NumberType sheet,
                         character name)
```
    Assigns a name to a worksheet. Set SheetName to give the specified worksheet a name, or change its existing name. When you change a sheet name, formulas that reference the worksheet are updated to reference the new sheet name.
    
    Specified by:
    
    setSheetName in interface Spreadsheet
    
    Parameters:
    
    sheet - Index number that identifies an existing worksheet within the workbook attached to the view. Worksheets are indexed from left to right beginning with 1. Do not confuse the index with the sheet name that appears on the sheet tab.
    
    name - Name associated with the identified sheet.
  - showActiveCell
```
public void showActiveCell()
```
    Positions the view to show the active cell if it is not currently displayed in the window. If the active cell is not displayed in the view window, the active worksheet is scrolled until the active cell becomes visible.
    
    Specified by:
    
    showActiveCell in interface Spreadsheet
  - isShowEditBar
```
public logical isShowEditBar()
```
    Returns whether the edit bar is displayed.
    If this property is True, the edit bar is displayed with the workbook.
    
    Specified by:
    
    isShowEditBar in interface Spreadsheet
    
    Returns:
    
    see above.
  - setShowEditBar
```
public void setShowEditBar(logical value)
```
    Sets whether the edit bar is displayed.
    If this property is True, the edit bar is displayed with the workbook.
    
    Specified by:
    
    setShowEditBar in interface Spreadsheet
    
    Parameters:
    
    value - The new value.
  - setShowToolBar
```
public void setShowToolBar(logical value)
```
    Returns whether the tool bar is displayed.
    If this property is True, the tool bar is displayed in the workbook.
    
    Specified by:
    
    setShowToolBar in interface Spreadsheet
    
    Parameters:
    
    value - The new value.
  - isShowZeroValues
```
public logical isShowZeroValues()
```
    Returns whether zero value cells are displayed.
    If this property is True, cells with zero values are displayed. If False, zero value cells are displayed as blanks.
    
    Specified by:
    
    isShowZeroValues in interface Spreadsheet
    
    Returns:
    
    see above.
  - setShowZeroValues
```
public void setShowZeroValues(logical value)
```
    Sets whether zero value cells are displayed.
    If this property is True, cells with zero values are displayed. If False, zero value cells are displayed as blanks.
    
    Specified by:
    
    setShowZeroValues in interface Spreadsheet
    
    Parameters:
    
    value - The new value.
  - isShowColHeading
```
public logical isShowColHeading()
```
    Returns whether column headings are displayed. If this property is True, column headings are displayed.
    
    Specified by:
    
    isShowColHeading in interface Spreadsheet
    
    Returns:
    
    see above.
  - setShowColHeading
```
public void setShowColHeading(logical value)
```
    Sets whether column headings are displayed. If this property is True, column headings are displayed.
    
    Specified by:
    
    setShowColHeading in interface Spreadsheet
    
    Parameters:
    
    value - The new state.
  - isShowRowHeading
```
public logical isShowRowHeading()
```
    Returns whether row headings are displayed. If this property is True, row headings are displayed.
    
    Specified by:
    
    isShowRowHeading in interface Spreadsheet
    
    Returns:
    
    see above.
  - setShowRowHeading
```
public void setShowRowHeading(logical value)
```
    Sets whether row headings are displayed. If this property is True, row headings are displayed.
    
    Specified by:
    
    setShowRowHeading in interface Spreadsheet
    
    Parameters:
    
    value - The new state.
  - setShowGridLines
```
public void setShowGridLines(logical value)
```
    Sets or returns whether grid lines are displayed.
    
    Specified by:
    
    setShowGridLines in interface Spreadsheet
    
    Parameters:
    
    value - If true, grid lines are displayed.
  - setShowTabs
```
public void setShowTabs(NumberType value)
```
    Sets or returns the display status and position of the sheet name tabs on a workbook.
    
    Specified by:
    
    setShowTabs in interface Spreadsheet
    
    Parameters:
    
    value - Controls the display of the sheet name tabs. Following are the valid values: Value Description ---------------------------------------------------------- 0 Tabs are not displayed. 1 Tabs are displayed along the bottom of the workbook.
  - sort3
```
public void sort3(NumberType row1,
                  NumberType col1,
                  NumberType row2,
                  NumberType col2,
                  logical sortByRows,
                  NumberType key1,
                  NumberType key2,
                  NumberType key3)
```
    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.
    
    Specified by:
    
    sort3 in interface Spreadsheet
    
    Parameters:
    
    row1 - Specifies the range of data to be sorted.
    
    col1 - Specifies the range of data to be sorted.
    
    row2 - Specifies the range of data to be sorted.
    
    col2 - Specifies the range of data to be sorted.
    
    sortByRows - Specifies how data is sorted. If True, data is sorted by rows; if False, data is sorted by columns.
    
    key1 - Sort key.
    
    key2 - Sort key.
    
    key3 - Sort key.
  - getText
```
public character getText()
```
    Returns the text value of the active cell in the active worksheet.
    Text returns the current text value of the active cell. If the cell contains a formula, the variable contains the result of the formula.
    
    Specified by:
    
    getText in interface Spreadsheet
    
    Returns:
    
    text value.
  - setText
```
public void setText(character value)
```
    Enters text in the active cell of all selected sheets.
    Set Text to place text into the active cell. If the active cell contains a formula, the formula is deleted when the text is placed in the cell.
    
    Specified by:
    
    setText in interface Spreadsheet
    
    Parameters:
    
    value - Text value.
  - getTextRC
```
public character getTextRC(NumberType row,
                           NumberType col)
```
    Returns the text value of the specified cell in the active worksheet.
    Text returns the current text value of the specified cell. If the cell contains a formula, the variable contains the result of the formula.
    
    Specified by:
    
    getTextRC in interface Spreadsheet
    
    Parameters:
    
    row - Row number of the cell that identifies the specific cell.
    
    col - Column number of the cell that identifies the specific cell.
    
    Returns:
    
    text value.
  - setTextRC
```
public void setTextRC(NumberType row,
                      NumberType col,
                      character value)
```
    Enters text in the specified cell of all selected sheets.
    Set Text to place text into the specified cell. If the specified cell contains a formula, the formula is deleted when the text is placed in the cell.
    
    Specified by:
    
    setTextRC in interface Spreadsheet
    
    Parameters:
    
    row - Row number of the cell that identifies the specific cell.
    
    col - Column number of the cell that identifies the specific cell.
    
    value - Text value.
  - getTextSRC
```
public character getTextSRC(NumberType sheet,
                            NumberType row,
                            NumberType col)
```
    Returns the text value of the specified cell in the specified worksheet.
    Text returns the current text value of the specified cell. If the cell contains a formula, the variable contains the result of the formula.
    
    Specified by:
    
    getTextSRC in interface Spreadsheet
    
    Parameters:
    
    sheet - Sheet number.
    
    row - Row number of the cell that identifies the specific cell.
    
    col - Column number of the cell that identifies the specific cell.
    
    Returns:
    
    text value.
  - setTextSRC
```
public void setTextSRC(NumberType sheet,
                       NumberType row,
                       NumberType col,
                       character value)
```
    Enters text in the specified cell of the specified sheet.
    Set Text to place text into the specified cell. If the specified cell contains a formula, the formula is deleted when the text is placed in the cell.
    
    Specified by:
    
    setTextSRC in interface Spreadsheet
    
    Parameters:
    
    sheet - Sheet number.
    
    row - Row number of the cell that identifies the specific cell.
    
    col - Column number of the cell that identifies the specific cell.
    
    value - Text value.
  - getFormulaRC
```
public character getFormulaRC(NumberType row,
                              NumberType col)
```
    Returns formula text of the specified cell in the active worksheet.
    
    Specified by:
    
    getFormulaRC in interface Spreadsheet
    
    Parameters:
    
    row - Row number of the cell that identifies the specific cell.
    
    col - Column number of the cell that identifies the specific cell.
    
    Returns:
    
    Formula text value.
  - setFormulaRC
```
public void setFormulaRC(NumberType row,
                         NumberType col,
                         character value)
```
    Enters formula text in the specified cell of all selected sheets.
    
    Specified by:
    
    setFormulaRC in interface Spreadsheet
    
    Parameters:
    
    row - Row number of the cell that identifies the specific cell.
    
    col - Column number of the cell that identifies the specific cell.
    
    value - Formula text value.
  - getType
```
public integer getType()
```
    Returns the cell type of the active cell.
    Following are all valid types: 0 Empty 1 Number -1 Formula returning number 2 Text -2 Formula returning text 3 Logical -3 Formula returning logical 4 Error -4 Formula returning error
    
    Specified by:
    
    getType in interface Spreadsheet
    
    Returns:
    
    Cell type.
  - setType
```
public void setType(NumberType value)
```
    Sets the cell type of the active cell.
    Following are all valid types: 0 Empty 1 Number -1 Formula returning number 2 Text -2 Formula returning text 3 Logical -3 Formula returning logical 4 Error -4 Formula returning error
    
    Specified by:
    
    setType in interface Spreadsheet
    
    Parameters:
    
    value - Cell type.
  - getTypeRC
```
public integer getTypeRC(NumberType row,
                         NumberType col)
```
    Returns the cell type of the specified cell.
    Following are all valid types: 0 Empty 1 Number -1 Formula returning number 2 Text -2 Formula returning text 3 Logical -3 Formula returning logical 4 Error -4 Formula returning error
    
    Specified by:
    
    getTypeRC in interface Spreadsheet
    
    Parameters:
    
    row - Row number of the cell that identifies the specific cell.
    
    col - Column number of the cell that identifies the specific cell.
    
    Returns:
    
    Cell type.
  - setTypeRC
```
public void setTypeRC(NumberType row,
                      NumberType col,
                      NumberType type)
```
    Sets the cell type of the specified cell.
    Following are all valid types: 0 Empty 1 Number -1 Formula returning number 2 Text -2 Formula returning text 3 Logical -3 Formula returning logical 4 Error -4 Formula returning error
    
    Specified by:
    
    setTypeRC in interface Spreadsheet
    
    Parameters:
    
    row - Row number of the cell that identifies the specific cell.
    
    col - Column number of the cell that identifies the specific cell.
    
    type - Cell type.
  - getTypeSRC
```
public integer getTypeSRC(NumberType sheet,
                          NumberType row,
                          NumberType col)
```
    Returns the cell type of the specified cell of the specified sheet.
    Following are all valid types: 0 Empty 1 Number -1 Formula returning number 2 Text -2 Formula returning text 3 Logical -3 Formula returning logical 4 Error -4 Formula returning error
    
    Specified by:
    
    getTypeSRC in interface Spreadsheet
    
    Parameters:
    
    sheet - Sheet number.
    
    row - Row number of the cell that identifies the specific cell.
    
    col - Column number of the cell that identifies the specific cell.
    
    Returns:
    
    Cell type.
  - setTypeSRC
```
public void setTypeSRC(NumberType sheet,
                       NumberType row,
                       NumberType col,
                       NumberType type)
```
    Sets the cell type of the specified cell in the specified sheet.
    Following are all valid types: 0 Empty 1 Number -1 Formula returning number 2 Text -2 Formula returning text 3 Logical -3 Formula returning logical 4 Error -4 Formula returning error
    
    Specified by:
    
    setTypeSRC in interface Spreadsheet
    
    Parameters:
    
    sheet - Sheet number.
    
    row - Row number of the cell that identifies the specific cell.
    
    col - Column number of the cell that identifies the specific cell.
    
    type - Cell type.
  - setFont
```
public void setFont(character font,
                    NumberType size,
                    logical bold,
                    logical italic,
                    logical underline,
                    logical strikeout,
                    NumberType color,
                    logical outline,
                    logical shadow)
```
    Sets font information for all selected cells.
    
    Specified by:
    
    setFont in interface Spreadsheet
    
    Parameters:
    
    font - The font name.
    
    size - You can specify the font size in points or twips. When specifying size in points, use a positive number; use a negative number when specifying twips. When you specify twips, this method uses the absolute value of the number you provide for size.
    
    bold - Bold font attribute.
    
    italic - Italic font attribute.
    
    underline - Underlined font attribute.
    
    strikeout - Striked out font attribute.
    
    color - Font color. Use the value returned by RGB-VALUE.
    
    outline - Not implemented.
    
    shadow - Not implemented.
  - setDefaultFont
```
public void setDefaultFont(character font,
                           NumberType size)
```
    Sets the default font and font size.
    
    Specified by:
    
    setDefaultFont in interface Spreadsheet
    
    Parameters:
    
    font - The font name.
    
    size - You can specify the font size in points or twips. When specifying size in points, use a positive number; use a negative number when specifying twips. When you specify twips, this method uses the absolute value of the number you provide for size.
  - setFontBold
```
public void setFontBold(logical value)
```
    Setter for the FONT-BOLD attribute.
    
    Specified by:
    
    setFontBold in interface CustomFont
    
    Overrides:
    
    setFontBold in class BaseEntity<SpreadsheetConfig>
    
    Parameters:
    
    value - the attribute value
  - setFontSize
```
public void setFontSize(NumberType value)
```
    Setter for the FONT-SIZE attribute.
    
    Specified by:
    
    setFontSize in interface CustomFont
    
    Specified by:
    
    setFontSize in interface Spreadsheet
    
    Overrides:
    
    setFontSize in class BaseEntity<SpreadsheetConfig>
    
    Parameters:
    
    value - the attribute value
  - getBorder
```
public void getBorder(NumberType left,
                      NumberType right,
                      NumberType top,
                      NumberType bottom,
                      NumberType shade,
                      NumberType colorLeft,
                      NumberType colorRight,
                      NumberType colorTop,
                      NumberType colorBottom)
```
    Returns the border styles used to display cells.
    The possible values for the border type parameters: Value Description ----------------------- 0 No Border 1 Thin Line 2 Medium Line 3 Dashed Line 4 Dotted Line 5 Thick Line 6 Double Line 7 Hairline
    The returned color values are in the format of the legacy method RGB-VALUE.
    
    Specified by:
    
    getBorder in interface Spreadsheet
    
    Parameters:
    
    left - Receives the border type for a side of the active cell.
    
    right - Receives the border type for a side of the active cell.
    
    top - Receives the border type for a side of the active cell.
    
    bottom - Receives the border type for a side of the active cell.
    
    shade - Not implemented, the parameter is ignored.
    
    colorLeft - Receives the value that specify the color of the cell border side.
    
    colorRight - Receives the value that specify the color of the cell border side.
    
    colorTop - Receives the value that specify the color of the cell border side.
    
    colorBottom - Receives the value that specify the color of the cell border side.
  - setBorder
```
public void setBorder(NumberType outline,
                      NumberType left,
                      NumberType right,
                      NumberType top,
                      NumberType bottom,
                      NumberType shade,
                      NumberType colorOutline,
                      NumberType colorLeft,
                      NumberType colorRight,
                      NumberType colorTop,
                      NumberType colorBottom)
```
    Sets the border styles used to display cells in all selected sheets.
    
    Specified by:
    
    setBorder in interface Spreadsheet
    
    Parameters:
    
    outline - Indicates the outline border for the selected range. This border type is assigned to the top edge of cells in the top row, the left edge of cells in the left column, the right edge of cells in the right column, and the bottom edge of cells in the bottom row. The valid values are: Value Description -1 No Change 0 No Border 1 Thin Line 2 Medium Line 3 Dashed Line 4 Dotted Line 5 Thick Line 6 Double Line 7 Hairline
    
    left - Indicates the border type for a side of the active cell. See outline above for valid values.
    
    right - Indicates the border type for a side of the active cell. See outline above for valid values.
    
    top - Indicates the border type for a side of the active cell. See outline above for valid values.
    
    bottom - Indicates the border type for a side of the active cell. See outline above for valid values.
    
    shade - Not implemented, the parameter is ignored.
    
    colorOutline - Indicates the color of the cell border outline.
    
    colorLeft - Indicates the color of the cell border sides.
    
    colorRight - Indicates the color of the cell border sides.
    
    colorTop - Indicates the color of the cell border sides.
    
    colorBottom - Indicates the color of the cell border sides.
  - getPattern
```
public void getPattern(NumberType pattern,
                       NumberType fgColor,
                       NumberType bgColor)
```
    Returns the pattern for the active cell.
    
    Specified by:
    
    getPattern in interface Spreadsheet
    
    Parameters:
    
    pattern - Receives the returned pattern number used to display the cells or objects. The pattern number can range from 0 (no pattern) to 18 and represents one of the 18 possible patterns.
    
    fgColor - Receives the pattern foreground color.
    
    bgColor - Receives the pattern background color.
  - getPrintLeftMargin
```
public decimal getPrintLeftMargin()
```
    Returns the left page margin used during printing.
    
    Specified by:
    
    getPrintLeftMargin in interface Spreadsheet
    
    Returns:
    
    indicates the left margin value in inches.
  - setPrintLeftMargin
```
public void setPrintLeftMargin(NumberType value)
```
    Sets the left page margin used during printing.
    
    Specified by:
    
    setPrintLeftMargin in interface Spreadsheet
    
    Parameters:
    
    value - Indicates the left margin value in inches.
  - getPrintRightMargin
```
public decimal getPrintRightMargin()
```
    Returns the right page margin used during printing.
    
    Specified by:
    
    getPrintRightMargin in interface Spreadsheet
    
    Returns:
    
    indicates the left margin value in inches.
  - setPrintRightMargin
```
public void setPrintRightMargin(NumberType value)
```
    Sets the right page margin used during printing.
    
    Specified by:
    
    setPrintRightMargin in interface Spreadsheet
    
    Parameters:
    
    value - Indicates the left margin value in inches.
  - getPrintTopMargin
```
public decimal getPrintTopMargin()
```
    Returns the top page margin used during printing.
    
    Specified by:
    
    getPrintTopMargin in interface Spreadsheet
    
    Returns:
    
    indicates the left margin value in inches.
  - setPrintTopMargin
```
public void setPrintTopMargin(NumberType value)
```
    Sets the top page margin used during printing.
    
    Specified by:
    
    setPrintTopMargin in interface Spreadsheet
    
    Parameters:
    
    value - Indicates the left margin value in inches.
  - getPrintBottomMargin
```
public decimal getPrintBottomMargin()
```
    Returns the bottom page margin used during printing.
    
    Specified by:
    
    getPrintBottomMargin in interface Spreadsheet
    
    Returns:
    
    indicates the left margin value in inches.
  - setPrintBottomMargin
```
public void setPrintBottomMargin(NumberType value)
```
    Sets the bottom page margin used during printing.
    
    Specified by:
    
    setPrintBottomMargin in interface Spreadsheet
    
    Parameters:
    
    value - Indicates the left margin value in inches.
  - setAlignment
```
public void setAlignment(NumberType hAlign,
                         logical wordWrap,
                         NumberType vAlign,
                         NumberType orientation)
```
    Changes the data alignment information for the currently selected cells.
    
    Specified by:
    
    setAlignment in interface Spreadsheet
    
    Parameters:
    
    hAlign - Indicates the horizontal alignment. Following are the valid constants: Value Description ------------------- 1 General 2 Left 3 Center 4 Right 5 Fill 6 Justify 7 Center across cells
    
    wordWrap - Indicates the value of the word wrap flag. If the flag is True, text wraps when it exceeds the cell width.
    
    vAlign - Indicates the vertical alignment. Following are the valid constants: Value Description ------------------- 1 Top 2 Center 3 Bottom
    
    orientation - Indicates the orientation. This feature is not implemented and the parameter is ignored.
  - setPrintHeader
```
public void setPrintHeader(character value)
```
    Sets the current page header.
    
    Specified by:
    
    setPrintHeader in interface Spreadsheet
    
    Parameters:
    
    value - The new value.
  - setPrintFooter
```
public void setPrintFooter(character value)
```
    Sets the current page footer.
    
    Specified by:
    
    setPrintFooter in interface Spreadsheet
    
    Parameters:
    
    value - The new value.
  - getPrintArea
```
public character getPrintArea()
```
    Returns the current print area.
    This name defines the worksheet ranges to be printed. This property returns a string containing a formula for the Print_Area user-defined name.
    The print area formula can contain one or more ranges (e.g. A1:C3,A11:C13). If "Print_Area" is (""), the selected portion of the active worksheet is printed.
    
    Specified by:
    
    getPrintArea in interface Spreadsheet
    
    Returns:
    
    current print area.
  - setPrintArea
```
public void setPrintArea(character formula)
```
    Sets the current print area.
    Set this property to change the Print_Area user-defined name to the formula pointed to by formula. This name defines the worksheet ranges to be printed.
    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.
    
    Specified by:
    
    setPrintArea in interface Spreadsheet
    
    Parameters:
    
    formula - Print area.
  - getPrintLandscape
```
public logical getPrintLandscape()
```
    Returns whether a workbook is printed with a portrait or landscape orientation.
    If this property is True, the workbook is printed with a landscape orientation. If this property is False, the workbook is printed with a portrait orientation.
    
    Specified by:
    
    getPrintLandscape in interface Spreadsheet
    
    Returns:
    
    see above.
  - setPrintLandscape
```
public void setPrintLandscape(logical value)
```
    Sets whether a workbook is printed with a portrait or landscape orientation.
    If this property is True, the workbook is printed with a landscape orientation. If this property is False, the workbook is printed with a portrait orientation.
    
    Specified by:
    
    setPrintLandscape in interface Spreadsheet
    
    Parameters:
    
    value - New landscape value.
  - getAllowTabs
```
public logical getAllowTabs()
```
    Returns whether TAB key moves the active cell to the successive cell in the range of selected cells or in the range of all cells if no cells are selected.
    The default value of the property is true.
    
    Specified by:
    
    getAllowTabs in interface Spreadsheet
    
    Returns:
    
    see above.
  - setAllowTabs
```
public void setAllowTabs(logical value)
```
    Sets whether TAB key moves the active cell to the successive cell in the range of selected cells or in the range of all cells if no cells are selected.
    
    Specified by:
    
    setAllowTabs in interface Spreadsheet
    
    Parameters:
    
    value - New landscape value.
  - setAllowTabEdit
```
public void setAllowTabEdit(logical value)
```
    Sets whether tab editing is allowed (adding, renaming and removing sheets (or tabs) using the UI). By default tab editing is not allowed.
    
    Specified by:
    
    setAllowTabEdit in interface Spreadsheet
    
    Parameters:
    
    value - New landscape value.
  - write
```
public void write(character fileName,
                  NumberType format)
```
    Saves the workbook to the specified file. The output format is Office Open XML (xlsx) regardless of the format value.
    
    Specified by:
    
    write in interface Spreadsheet
    
    Parameters:
    
    fileName - Name of the file to write.
    
    format - The parameter is ignored.
  - startBatch
```
public void startBatch()
```
    Enables batch mode.
    All the changes made through the Spreadsheet legacy API will be queued and committed to the Spreadsheet backend only after Spreadsheet.endBatch() method is called.
    Note that during batch mode no legacy Spreadsheet events are triggered. Also legacy method return values are undefined.
    
    Specified by:
    
    startBatch in interface Spreadsheet
  - endBatch
```
public void endBatch()
```
    Disables batch mode.
    All the queued changes made through the Spreadsheet legacy API are committed to the Spreadsheet backend.
    
    Specified by:
    
    endBatch in interface Spreadsheet
  - _setVisible
```
protected void _setVisible(boolean visible)
```
    Sets the widget's config visibility flag.
    
    Overrides:
    
    _setVisible in class GenericWidget<SpreadsheetConfig>
    
    Parameters:
    
    visible - The widget's visibility state.
  - invokeWidgetCommandImpl
```
private java.lang.Object invokeWidgetCommandImpl(SpreadsheetCommands command,
                                                 java.lang.Object... args)
```
    Invokes a command on the client widget implementation.
    
    Parameters:
    
    command - The command to invoke.
    
    args - Arguments.
    
    Returns:
    
    Return value.
  - invokeWidgetCommand
```
private java.lang.Object invokeWidgetCommand(SpreadsheetCommands command,
                                             java.lang.Object... args)
```
    Invokes a command on the client widget implementation.
    
    Parameters:
    
    command - The command to invoke.
    
    args - Arguments.
    
    Returns:
    
    Return value.
  - emitEvent
```
private void emitEvent(java.lang.String name,
                       BaseDataType... args)
```
    Emits event on the server. The method must be called on the UI thread.
    
    Parameters:
    
    name - Event name.
    
    args - Event arguments.
  - emitEvent
```
private void emitEvent(java.lang.String name,
                       java.lang.Runnable initiation,
                       java.util.function.Consumer<BaseDataType[]> completion,
                       BaseDataType... args)
```

Class SpreadsheetWidget

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.BaseEntity

Field Summary

Fields inherited from class com.goldencode.p2j.ui.BaseEntity

Fields inherited from class com.goldencode.p2j.ui.GenericWidget

Fields inherited from class com.goldencode.p2j.util.HandleChain

Fields inherited from class com.goldencode.p2j.util.HandleResource

Fields inherited from interface com.goldencode.p2j.ui.Spreadsheet

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.ui.BaseEntity

Methods inherited from class com.goldencode.p2j.ui.GenericWidget

Methods inherited from class com.goldencode.p2j.util.HandleChain

Methods inherited from class com.goldencode.p2j.util.HandleResource

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.ui.Spreadsheet

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

Methods inherited from interface com.goldencode.p2j.ui.CommonWidget

Methods inherited from interface com.goldencode.p2j.util.CommonHandleChain

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

Methods inherited from interface com.goldencode.p2j.util.Nameable

Methods inherited from interface com.goldencode.p2j.ui.DisableRedraw

Methods inherited from interface com.goldencode.p2j.ui.WriteProtectable

Methods inherited from interface com.goldencode.util.Printable

Methods inherited from interface com.goldencode.p2j.util.Deletable

Field Detail

LOG

CMD_HIT_COUNTER

CMD_TIME_COUNTER

contextId

obj

isEnterMovesDown

allowTabs

sheetController

lock

cache

initTimeout

inBatch

client

cm

Constructor Detail

SpreadsheetWidget

SpreadsheetWidget

SpreadsheetWidget

SpreadsheetWidget

Method Detail

delete

setSheetController

getCache

emitComEvent

isAllowDelete

setAllowDelete

isAllowEditHeaders

setAllowEditHeaders

isAllowInCellEditing

setAllowInCellEditing

isAllowMoveRange

setAllowMoveRange

isAllowResize

setAllowResize

isAllowSelections

setAllowSelections

isAutoRecalc

setAutoRecalc

setBackColor

setExtraColor

startEdit

cancelEdit

isCanEditPaste

clearBook

clearRange

getClip

setClip

getActiveColumn

setActiveColumn

isColHidden

setColHidden

getColWidth

setColWidth