com.vaadin.addon.spreadsheet.client

Interface SheetHandler

All Superinterfaces:

GroupingWidget.GroupingHandler

All Known Implementing Classes:

SpreadsheetWidget

public interface SheetHandler
extends GroupingWidget.GroupingHandler

Method Summary

Modifier and Type	Method and Description
boolean	canResizeColumn()
boolean	canResizeRow()
void	clearSelectedCellsOnCut() Called after successful cut operation; currently selected cells should be cleared
Map<Integer,String>	getCellStyleToCSSStyle()
String	getColHeader(int col) Get header of a column as HTML.
int	getColumnBufferSize()
Map<Integer,Integer>	getColumnIndexToStyleIndex()
int	getColWidth(int col) Width of a column in pixels including right border.
int	getColWidthActual(int col) Returns 0 for hidden columns, otherwise same as getColWidth(int).
int[]	getColWidths() Returns the widths of the columns.
Map<Integer,String>	getConditionalFormattingStyles()
float	getDefaultRowHeight() Returns the default row height in points (pt).
int	getDefinedRows() Returns the number of defined rows in the spreadsheet.
FormulaBarWidget	getFormulaBarWidget()
int	getMaxColumns() The maximum amount of columns that are visible.
int	getMaxRows() The maximum amount of rows that are visible.
MergedRegion	getMergedRegion(int col, int row) Returns the merged region that this cell belongs to.
MergedRegion	getMergedRegionStartingFrom(int col, int row) Returns the merged region starting at the given coordinates.
int	getRowBufferSize()
String	getRowHeader(int row) Get header of a row as HTML.
float	getRowHeight(int row) Height of a row in points (pt) including bottom border.
int[]	getRowHeightsPX()
Map<Integer,Integer>	getRowIndexToStyleIndex()
boolean	hasCustomContextMenu()
boolean	isColProtected(int col)
boolean	isColumnHidden(int col) Returns whether the given column is hidden.
boolean	isRowHidden(int row) Returns whether the given row is hidden.
boolean	isRowProtected(int row)
boolean	isSheetProtected()
void	onCellClick(int column, int row, String value, boolean shiftPressed, boolean metaOrCtrlPressed, boolean updateToActionHandler)
void	onCellDoubleClick(int column, int row, String value)
void	onCellInputBlur(String value)
void	onCellInputCancel()
void	onCellInputEnter(String value, boolean shift)
void	onCellInputFocus()
void	onCellInputTab(String value, boolean shift)
void	onCellInputValueChange(String value)
void	onCellRightClick(com.google.gwt.dom.client.NativeEvent nativeEvent, int column, int row) Called on right mouse button click on top of some cell.
void	onColumnHeaderClick(int row, boolean shiftPressed, boolean metaOrCrtlPressed)
void	onColumnHeaderResizeDoubleClick(int columnIndex) Triggered when a column header receives a double-click.
void	onColumnHeaderRightClick(com.google.gwt.dom.client.NativeEvent nativeEvent, int columnIndex) Called on right mouse button click on top of a column header.
void	onColumnsResized(Map<Integer,Integer> newSizes) Triggered after column resize.
void	onFinishedSelectingCellsWithDrag(int col1, int col2, int row1, int row2)
void	onLinkCellClick(int column, int row)
void	onRedoPress()
void	onRowHeaderClick(int row, boolean shiftPressed, boolean metaOrCrtlPressed)
void	onRowHeaderDoubleClick(int rowIndex) Triggered when a row header receives a double-click.
void	onRowHeaderRightClick(com.google.gwt.dom.client.NativeEvent nativeEvent, int rowIndex) Called on right mouse button click on top of a row header.
void	onRowsResized(Map<Integer,Float> newSizes) Triggered after row resize.
void	onScrollViewChanged(int firstRow, int lastRow, int firstColumn, int lastColumn)
void	onSelectingCellsWithDrag(int parsedCol, int parsedRow)
void	onSelectionDecreasePainted(int colEdgeIndex, int rowEdgeIndex)
void	onSelectionIncreasePainted(int c1, int c2, int r1, int r2)
void	onSheetKeyPress(com.google.gwt.dom.client.NativeEvent nativeEvent, String enteredCharacter)
void	onSheetPaste(String text) Called when user pastes something inside the sheet.
void	onUndoPress()
void	selectAll()
void	setCellStyleWidthRatios(HashMap<Integer,Float> cellStyleWidthRatioMap)
void	updateCellComment(String text, int col, int row)

Methods inherited from interface com.vaadin.addon.spreadsheet.client.GroupingWidget.GroupingHandler

levelHeaderClicked, setGroupingCollapsed

Method Detail

onCellClick

void onCellClick(int column,
                 int row,
                 String value,
                 boolean shiftPressed,
                 boolean metaOrCtrlPressed,
                 boolean updateToActionHandler)

onLinkCellClick

void onLinkCellClick(int column,
                     int row)

onCellDoubleClick

void onCellDoubleClick(int column,
                       int row,
                       String value)

onRowHeaderClick

void onRowHeaderClick(int row,
                      boolean shiftPressed,
                      boolean metaOrCrtlPressed)

onColumnHeaderClick

void onColumnHeaderClick(int row,
                         boolean shiftPressed,
                         boolean metaOrCrtlPressed)

onScrollViewChanged

void onScrollViewChanged(int firstRow,
                         int lastRow,
                         int firstColumn,
                         int lastColumn)

onSelectionIncreasePainted

void onSelectionIncreasePainted(int c1,
                                int c2,
                                int r1,
                                int r2)

onSelectionDecreasePainted

void onSelectionDecreasePainted(int colEdgeIndex,
                                int rowEdgeIndex)

onFinishedSelectingCellsWithDrag

void onFinishedSelectingCellsWithDrag(int col1,
                                      int col2,
                                      int row1,
                                      int row2)

onSelectingCellsWithDrag

void onSelectingCellsWithDrag(int parsedCol,
                              int parsedRow)

onCellInputBlur

void onCellInputBlur(String value)

onCellInputFocus

void onCellInputFocus()

onCellInputCancel

void onCellInputCancel()

onCellInputEnter

void onCellInputEnter(String value,
                      boolean shift)

onCellInputTab

void onCellInputTab(String value,
                    boolean shift)

onCellInputValueChange

void onCellInputValueChange(String value)

onSheetKeyPress

void onSheetKeyPress(com.google.gwt.dom.client.NativeEvent nativeEvent,
                     String enteredCharacter)

getRowBufferSize

int getRowBufferSize()

getColumnBufferSize

int getColumnBufferSize()

getDefaultRowHeight

float getDefaultRowHeight()

Returns the default row height in points (pt).

Returns:

height

getDefinedRows

int getDefinedRows()

Returns the number of defined rows in the spreadsheet.

Returns:

row count

getColWidths

int[] getColWidths()

Returns the widths of the columns.

Returns:

width array

getRowHeight

float getRowHeight(int row)

Height of a row in points (pt) including bottom border. Rows are indexed from 1 to getRows(). Returns 0 for hidden rows.

Parameters:

row - row index, 1-based

Returns:

height

getColWidth

int getColWidth(int col)

Width of a column in pixels including right border. Columns are indexed from 1 to getColumns(). Returns 0 for hidden columns.

Parameters:

col - column index, 1-based

Returns:

width

getColWidthActual

int getColWidthActual(int col)

Returns 0 for hidden columns, otherwise same as getColWidth(int).

Parameters:

col - column index, 1-based

Returns:

width (px)

getColHeader

String getColHeader(int col)

Get header of a column as HTML. Columns are indexed from 1 to getColumns().

Parameters:

col - column index, 1-based

Returns:

header HTML

getRowHeader

String getRowHeader(int row)

Get header of a row as HTML. Rows are indexed from 1 to getRows().

Parameters:

row - row index, 1-based

Returns:

header HTML

getMaxColumns

int getMaxColumns()

The maximum amount of columns that are visible.

Returns:

count

getMaxRows

int getMaxRows()

The maximum amount of rows that are visible.

Returns:

count

getRowHeightsPX

int[] getRowHeightsPX()

getCellStyleToCSSStyle

Map<Integer,String> getCellStyleToCSSStyle()

getRowIndexToStyleIndex

Map<Integer,Integer> getRowIndexToStyleIndex()

getColumnIndexToStyleIndex

Map<Integer,Integer> getColumnIndexToStyleIndex()

getConditionalFormattingStyles

Map<Integer,String> getConditionalFormattingStyles()

isColumnHidden

boolean isColumnHidden(int col)

Returns whether the given column is hidden.

Parameters:

col - column index, 1-based

Returns:

true if the column is hidden, false otherwise

isRowHidden

boolean isRowHidden(int row)

Returns whether the given row is hidden.

Parameters:

row - row index, 1-based

Returns:

true if the row is hidden, false otherwise

onCellRightClick

void onCellRightClick(com.google.gwt.dom.client.NativeEvent nativeEvent,
                      int column,
                      int row)

Called on right mouse button click on top of some cell.

Parameters:

nativeEvent - triggered event

column - index, 1-based

row - index, 1-based

onRowHeaderRightClick

void onRowHeaderRightClick(com.google.gwt.dom.client.NativeEvent nativeEvent,
                           int rowIndex)

Called on right mouse button click on top of a row header.

Parameters:

nativeEvent - triggered event

rowIndex - 1-based

onColumnHeaderRightClick

void onColumnHeaderRightClick(com.google.gwt.dom.client.NativeEvent nativeEvent,
                              int columnIndex)

Called on right mouse button click on top of a column header.

Parameters:

nativeEvent - triggered event

columnIndex - 1-based

hasCustomContextMenu

boolean hasCustomContextMenu()

canResizeColumn

boolean canResizeColumn()

canResizeRow

boolean canResizeRow()

onRowsResized

void onRowsResized(Map<Integer,Float> newSizes)

Triggered after row resize.

Parameters:

newSizes - map containing 1-based row indexes and new sizes as pt

onColumnsResized

void onColumnsResized(Map<Integer,Integer> newSizes)

Triggered after column resize.

Parameters:

newSizes - map containing 1-based column indexes and new sizes as pt

onRowHeaderDoubleClick

void onRowHeaderDoubleClick(int rowIndex)

Triggered when a row header receives a double-click.

Parameters:

rowIndex - 1-based

onColumnHeaderResizeDoubleClick

void onColumnHeaderResizeDoubleClick(int columnIndex)

Triggered when a column header receives a double-click.

Parameters:

columnIndex - 1-based

getMergedRegion

MergedRegion getMergedRegion(int col,
                             int row)

Returns the merged region that this cell belongs to.

Parameters:

col - column index, 1-based

row - row index, 1-based

Returns:

merged region or null if not found

getMergedRegionStartingFrom

MergedRegion getMergedRegionStartingFrom(int col,
                                         int row)

Returns the merged region starting at the given coordinates.

Parameters:

col - starting column index of merged cell, 1-based

row - starting row index of merged cell, 1-based

Returns:

merged region or null if not found

onRedoPress

void onRedoPress()

onUndoPress

void onUndoPress()

setCellStyleWidthRatios

void setCellStyleWidthRatios(HashMap<Integer,Float> cellStyleWidthRatioMap)

onSheetPaste

void onSheetPaste(String text)

Called when user pastes something inside the sheet.

Parameters:

text - the pasted content

clearSelectedCellsOnCut

void clearSelectedCellsOnCut()

Called after successful cut operation; currently selected cells should be cleared

getFormulaBarWidget

FormulaBarWidget getFormulaBarWidget()

updateCellComment

void updateCellComment(String text,
                       int col,
                       int row)

selectAll

void selectAll()

isSheetProtected

boolean isSheetProtected()

isColProtected

boolean isColProtected(int col)

isRowProtected

boolean isRowProtected(int row)