Package com.vaadin.component.spreadsheet.client.js

Class SpreadsheetJsApi

java.lang.Object
com.vaadin.component.spreadsheet.client.js.SpreadsheetJsApi
@JsType(namespace="Vaadin.Spreadsheet", name="Api") public class SpreadsheetJsApi extends Object
this is the public api which we will export to js

  • Field Details

  • Constructor Details

    • SpreadsheetJsApi

      public SpreadsheetJsApi(com.google.gwt.dom.client.Element host, com.google.gwt.dom.client.Node renderRoot)
      receives the host element and the render root where the widget must be embedded into, and publishes the methods which can be used from JS
      Parameters:
      host - the host element
      renderRoot - render root of the host

  • Method Details

    • disconnected

      public void disconnected()

    • layout

      public void layout()

    • resize

      public void resize()

    • relayout

      public void relayout()

    • getState

      protected SpreadsheetState getState()

    • setRowBufferSize

      public void setRowBufferSize(int rowBufferSize)

    • setColumnBufferSize

      public void setColumnBufferSize(int columnBufferSize)

    • setRows

      public void setRows(int rows)

    • setCols

      public void setCols(int cols)

    • setColGroupingData

      public void setColGroupingData(String colGroupingData)

    • setRowGroupingData

      public void setRowGroupingData(String rowGroupingData)

    • setColGroupingMax

      public void setColGroupingMax(int colGroupingMax)

    • setRowGroupingMax

      public void setRowGroupingMax(int rowGroupingMax)

    • setColGroupingInversed

      public void setColGroupingInversed(boolean colGroupingInversed)

    • setRowGroupingInversed

      public void setRowGroupingInversed(boolean rowGroupingInversed)

    • setDefRowH

      public void setDefRowH(float defRowH)

    • setDefColW

      public void setDefColW(int defColW)

    • setRowH

      public void setRowH(String rowH)

    • setColW

      public void setColW(String colW)

    • setReload

      public void setReload(boolean reload)

    • setSheetIndex

      public void setSheetIndex(int sheetIndex)

    • setSheetNames

      public void setSheetNames(String sheetNames)

    • setCellStyleToCSSStyle

      public void setCellStyleToCSSStyle(String cellStyleToCSSStyle)

    • setRowIndexToStyleIndex

      public void setRowIndexToStyleIndex(String rowIndexToStyleIndex)

    • setColumnIndexToStyleIndex

      public void setColumnIndexToStyleIndex(String columnIndexToStyleIndex)

    • setLockedColumnIndexes

      public void setLockedColumnIndexes(String lockedColumnIndexes)

    • setLockedRowIndexes

      public void setLockedRowIndexes(String lockedRowIndexes)

    • setShiftedCellBorderStyles

      public void setShiftedCellBorderStyles(String shiftedCellBorderStyles)

    • setConditionalFormattingStyles

      public void setConditionalFormattingStyles(String conditionalFormattingStyles)

    • setHiddenColumnIndexes

      public void setHiddenColumnIndexes(String hiddenColumnIndexes)

    • setHiddenRowIndexes

      public void setHiddenRowIndexes(String hiddenRowIndexes)

    • setVerticalScrollPositions

      public void setVerticalScrollPositions(String verticalScrollPositions)

    • setHorizontalScrollPositions

      public void setHorizontalScrollPositions(String horizontalScrollPositions)

    • setSheetProtected

      public void setSheetProtected(boolean sheetProtected)

    • setWorkbookProtected

      public void setWorkbookProtected(boolean workbookProtected)

    • setCellKeysToEditorIdMap

      public void setCellKeysToEditorIdMap(String cellKeysToEditorIdMap)

    • setComponentIDtoCellKeysMap

      public void setComponentIDtoCellKeysMap(String componentIDtoCellKeysMap)

    • setHyperlinksTooltips

      public void setHyperlinksTooltips(String hyperlinksTooltips)

    • setCellComments

      public void setCellComments(String cellCommentsJson)

    • setCellCommentAuthors

      public void setCellCommentAuthors(String cellCommentAuthors)

    • setVisibleCellComments

      public void setVisibleCellComments(String visibleCellComments)

    • setInvalidFormulaCells

      public void setInvalidFormulaCells(String invalidFormulaCells)

    • setHasActions

      public void setHasActions(boolean hasActions)

    • setOverlays

      public void setOverlays(String overlays)

    • setMergedRegions

      public void setMergedRegions(String mergedRegions)

    • setDisplayGridlines

      public void setDisplayGridlines(boolean displayGridlines)

    • setDisplayRowColHeadings

      public void setDisplayRowColHeadings(boolean displayRowColHeadings)

    • setVerticalSplitPosition

      public void setVerticalSplitPosition(int verticalSplitPosition)

    • setHorizontalSplitPosition

      public void setHorizontalSplitPosition(int horizontalSplitPosition)

    • setInfoLabelValue

      public void setInfoLabelValue(String infoLabelValue)

    • setWorkbookChangeToggle

      public void setWorkbookChangeToggle(boolean workbookChangeToggle)

    • setInvalidFormulaErrorMessage

      public void setInvalidFormulaErrorMessage(String invalidFormulaErrorMessage)

    • setLockFormatColumns

      public void setLockFormatColumns(boolean lockFormatColumns)

    • setLockFormatRows

      public void setLockFormatRows(boolean lockFormatRows)

    • setNamedRanges

      public void setNamedRanges(String namedRanges)

    • setShowCustomEditorOnFocus

      public void setShowCustomEditorOnFocus(boolean showCustomEditorOnFocus)

    • setHeight

      public void setHeight(String height)

    • setWidth

      public void setWidth(String width)

    • setId

      public void setId(String id)

    • setClass

      public void setClass(String classNames)

    • addPopupButton

      public void addPopupButton(String rawState)

    • removePopupButton

      public void removePopupButton(String rawState)

    • onPopupButtonOpened

      public void onPopupButtonOpened(int row, int column, String contentParentId, String appId)

    • closePopup

      public void closePopup(int row, int column)

    • setResources

      public void setResources(com.google.gwt.dom.client.Element element, String[] resources)

    • notifyStateChanges

      public void notifyStateChanges(String[] propNames, boolean initial)

    • updateBottomRightCellValues

      public void updateBottomRightCellValues(String cellData)

    • updateTopLeftCellValues

      public void updateTopLeftCellValues(String cellData)

    • updateTopRightCellValues

      public void updateTopRightCellValues(String cellData)

    • updateBottomLeftCellValues

      public void updateBottomLeftCellValues(String cellData)

    • updateFormulaBar

      public void updateFormulaBar(String possibleName, int col, int row)

    • invalidCellAddress

      public void invalidCellAddress()

    • showSelectedCell

      public void showSelectedCell(String name, int col, int row, String cellValue, boolean formula, boolean locked, boolean initialSelection)

    • showActions

      public void showActions(String actionDetails)

    • setSelectedCellAndRange

      public void setSelectedCellAndRange(String name, int col, int row, int c1, int c2, int r1, int r2, boolean scroll)

    • cellsUpdated

      public void cellsUpdated(String cellData)

    • refreshCellStyles

      public void refreshCellStyles()

    • editCellComment

      public void editCellComment(int col, int row)

    • setGroupingCollapsedCallback

      public void setGroupingCollapsedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setLevelHeaderClickedCallback

      public void setLevelHeaderClickedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setOnSheetScrollCallback

      public void setOnSheetScrollCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setSheetAddressChangedCallback

      public void setSheetAddressChangedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setCellSelectedCallback

      public void setCellSelectedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setCellRangeSelectedCallback

      public void setCellRangeSelectedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setCellAddedToSelectionAndSelectedCallback

      public void setCellAddedToSelectionAndSelectedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setCellsAddedToRangeSelectionCallback

      public void setCellsAddedToRangeSelectionCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setContextMenuClosedCallback

      public void setContextMenuClosedCallback(SpreadsheetServerRpcImpl.JsConsumer<Void> callback)

    • setRowSelectedCallback

      public void setRowSelectedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setRowAddedToRangeSelectionCallback

      public void setRowAddedToRangeSelectionCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setColumnSelectedCallback

      public void setColumnSelectedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setColumnAddedToSelectionCallback

      public void setColumnAddedToSelectionCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setSelectionIncreasePaintedCallback

      public void setSelectionIncreasePaintedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setSelectionDecreasePaintedCallback

      public void setSelectionDecreasePaintedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setCellValueEditedCallback

      public void setCellValueEditedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setSheetSelectedCallback

      public void setSheetSelectedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setSheetRenamedCallback

      public void setSheetRenamedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setSheetCreatedCallback

      public void setSheetCreatedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setCellRangePaintedCallback

      public void setCellRangePaintedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setDeleteSelectedCellsCallback

      public void setDeleteSelectedCellsCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setLinkCellClickedCallback

      public void setLinkCellClickedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setRowsResizedCallback

      public void setRowsResizedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setColumnResizedCallback

      public void setColumnResizedCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setOnRowAutofitCallback

      public void setOnRowAutofitCallback(SpreadsheetServerRpcImpl.JsConsumer<Integer> callback)

    • setOnColumnAutofitCallback

      public void setOnColumnAutofitCallback(SpreadsheetServerRpcImpl.JsConsumer<Integer> callback)

    • setOnUndoCallback

      public void setOnUndoCallback(SpreadsheetServerRpcImpl.JsConsumer<Void> callback)

    • setOnRedoCallback

      public void setOnRedoCallback(SpreadsheetServerRpcImpl.JsConsumer<Void> callback)

    • setSetCellStyleWidthRatiosCallback

      public void setSetCellStyleWidthRatiosCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setProtectedCellWriteAttemptedCallback

      public void setProtectedCellWriteAttemptedCallback(SpreadsheetServerRpcImpl.JsConsumer<Void> callback)

    • setOnPasteCallback

      public void setOnPasteCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setClearSelectedCellsOnCutCallback

      public void setClearSelectedCellsOnCutCallback(SpreadsheetServerRpcImpl.JsConsumer<Void> callback)

    • setUpdateCellCommentCallback

      public void setUpdateCellCommentCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setOnConnectorInitCallback

      public void setOnConnectorInitCallback(SpreadsheetServerRpcImpl.JsConsumer<Void> callback)

    • setContextMenuOpenOnSelectionCallback

      public void setContextMenuOpenOnSelectionCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setActionOnCurrentSelectionCallback

      public void setActionOnCurrentSelectionCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setRowHeaderContextMenuOpenCallback

      public void setRowHeaderContextMenuOpenCallback(SpreadsheetServerRpcImpl.JsConsumer<Integer> callback)

    • setActionOnRowHeaderCallback

      public void setActionOnRowHeaderCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setColumnHeaderContextMenuOpenCallback

      public void setColumnHeaderContextMenuOpenCallback(SpreadsheetServerRpcImpl.JsConsumer<Integer> callback)

    • setActionOnColumnHeaderCallback

      public void setActionOnColumnHeaderCallback(SpreadsheetServerRpcImpl.JsConsumer<String> callback)

    • setPopupButtonClickCallback

      public void setPopupButtonClickCallback(SpreadsheetServerRpcImpl.JsConsumer<Void> callback)

    • setPopupCloseCallback

      public void setPopupCloseCallback(SpreadsheetServerRpcImpl.JsConsumer<Void> callback)

    • load

      public void load()

    • relayoutSheet

      public void relayoutSheet()

    • updateCellsAndRefreshCellStyles

      public void updateCellsAndRefreshCellStyles()