com.vaadin.addon.spreadsheet

Interface Spreadsheet.CellDeletionHandler

All Superinterfaces:

Serializable

Enclosing class:

Spreadsheet

public static interface Spreadsheet.CellDeletionHandler
extends Serializable

An interface for handling cell deletion from user input.

Method Summary

Modifier and Type	Method and Description
boolean	cellDeleted(org.apache.poi.ss.usermodel.Cell cell, org.apache.poi.ss.usermodel.Sheet sheet, int colIndex, int rowIndex, org.apache.poi.ss.usermodel.FormulaEvaluator formulaEvaluator, org.apache.poi.ss.usermodel.DataFormatter formatter, org.apache.poi.ss.formula.ConditionalFormattingEvaluator conditionalFormattingEvaluator) Called if a cell value has been deleted by the user.
boolean	cellRangeDeleted(List<org.apache.poi.ss.util.CellRangeAddress> cellRangeAddresses, org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.usermodel.FormulaEvaluator formulaEvaluator, org.apache.poi.ss.usermodel.DataFormatter formatter, org.apache.poi.ss.formula.ConditionalFormattingEvaluator conditionalFormattingEvaluator) Called if a cell range has been deleted by the user.
boolean	individualSelectedCellsDeleted(List<org.apache.poi.ss.util.CellReference> individualSelectedCells, org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.usermodel.FormulaEvaluator formulaEvaluator, org.apache.poi.ss.usermodel.DataFormatter formatter, org.apache.poi.ss.formula.ConditionalFormattingEvaluator conditionalFormattingEvaluator) Called if individually selected cell values have been deleted by the user.

Method Detail

cellDeleted

boolean cellDeleted(org.apache.poi.ss.usermodel.Cell cell,
                    org.apache.poi.ss.usermodel.Sheet sheet,
                    int colIndex,
                    int rowIndex,
                    org.apache.poi.ss.usermodel.FormulaEvaluator formulaEvaluator,
                    org.apache.poi.ss.usermodel.DataFormatter formatter,
                    org.apache.poi.ss.formula.ConditionalFormattingEvaluator conditionalFormattingEvaluator)

Called if a cell value has been deleted by the user. Use Spreadsheet.setCellDeletionHandler(CellDeletionHandler) to enable it for the spreadsheet.

Parameters:

cell - The cell that has been deleted

sheet - The sheet the cell belongs to, the currently active sheet

colIndex - Cell column index, 0-based

rowIndex - Cell row index, 0-based

formulaEvaluator - The FormulaEvaluator for this sheet

formatter - The DataFormatter for this workbook

conditionalFormattingEvaluator - The ConditionalFormattingEvaluator for this workbook

Returns:

true if component default deletion should still be done, false if not

individualSelectedCellsDeleted

boolean individualSelectedCellsDeleted(List<org.apache.poi.ss.util.CellReference> individualSelectedCells,
                                       org.apache.poi.ss.usermodel.Sheet sheet,
                                       org.apache.poi.ss.usermodel.FormulaEvaluator formulaEvaluator,
                                       org.apache.poi.ss.usermodel.DataFormatter formatter,
                                       org.apache.poi.ss.formula.ConditionalFormattingEvaluator conditionalFormattingEvaluator)

Called if individually selected cell values have been deleted by the user. Use Spreadsheet.setCellDeletionHandler(CellDeletionHandler) to enable it for the spreadsheet.

Parameters:

individualSelectedCells - The cells that have been deleted

sheet - The sheet the cells belong to, the currently active sheet

formulaEvaluator - The FormulaEvaluator for this sheet

formatter - The DataFormatter for this workbook

conditionalFormattingEvaluator - The ConditionalFormattingEvaluator for this workbook

Returns:

true if component default deletion should still be done, false if not

cellRangeDeleted

boolean cellRangeDeleted(List<org.apache.poi.ss.util.CellRangeAddress> cellRangeAddresses,
                         org.apache.poi.ss.usermodel.Sheet sheet,
                         org.apache.poi.ss.usermodel.FormulaEvaluator formulaEvaluator,
                         org.apache.poi.ss.usermodel.DataFormatter formatter,
                         org.apache.poi.ss.formula.ConditionalFormattingEvaluator conditionalFormattingEvaluator)

Called if a cell range has been deleted by the user. Use Spreadsheet.setCellDeletionHandler(CellDeletionHandler) to enable it for the spreadsheet.

Parameters:

cellRangeAddresses - The range of cells that has been deleted

sheet - The sheet the cells belongs to, the currently active sheet

formulaEvaluator - The FormulaEvaluator for this sheet

formatter - The DataFormatter for this workbook

conditionalFormattingEvaluator - The ConditionalFormattingEvaluator for this workbook

Returns:

true if component default deletion should still be done, false if not