Uses of Class
com.vaadin.flow.component.spreadsheet.Spreadsheet

Packages that use Spreadsheet

Package	Description
com.vaadin.flow.component.spreadsheet
com.vaadin.flow.component.spreadsheet.action
com.vaadin.flow.component.spreadsheet.charts.converter
com.vaadin.flow.component.spreadsheet.charts.converter.xssfreader
com.vaadin.flow.component.spreadsheet.command
org.apache.poi.ss.formula

Uses of Spreadsheet in com.vaadin.flow.component.spreadsheet

Fields in com.vaadin.flow.component.spreadsheet declared as Spreadsheet

Modifier and Type	Field	Description
protected final Spreadsheet	CellValueManager.spreadsheet	The Spreadsheet this class is tied to.
protected final Spreadsheet	SpreadsheetHistoryManager.spreadsheet	Target Spreadsheet component

Methods in com.vaadin.flow.component.spreadsheet that return Spreadsheet

Modifier and Type	Method	Description
protected Spreadsheet	DefaultHyperlinkCellClickHandler.getSpreadsheet()	expose for subclasses
Spreadsheet	Spreadsheet.SelectionChangeEvent.getSpreadsheet()	Gets the Spreadsheet where this event happened.
Spreadsheet	SpreadsheetTable.getSpreadsheet()	Gets the Spreadsheet component this table belongs to.

Methods in com.vaadin.flow.component.spreadsheet with parameters of type Spreadsheet

Modifier and Type	Method	Description
com.vaadin.flow.component.Component	ChartCreator.createChart(org.apache.poi.xssf.usermodel.XSSFChart chartXml, Spreadsheet spreadsheet)	Converts the XSSFChart model into a Chart Component
static List<org.apache.poi.ss.util.CellReference>	SpreadsheetUtil.getAllReferencedCells(String formula, Spreadsheet spreadsheet, boolean includeHiddenCells)	This function returns all the cells that the given formula references.
com.vaadin.flow.component.Component	SpreadsheetComponentFactory.getCustomComponentForCell(org.apache.poi.ss.usermodel.Cell cell, int rowIndex, int columnIndex, Spreadsheet spreadsheet, org.apache.poi.ss.usermodel.Sheet sheet)	Should return a unique component that is displayed inside the cell instead of the cell's value.
com.vaadin.flow.component.Component	SpreadsheetComponentFactory.getCustomEditorForCell(org.apache.poi.ss.usermodel.Cell cell, int rowIndex, int columnIndex, Spreadsheet spreadsheet, org.apache.poi.ss.usermodel.Sheet sheet)	Should return the custom component that is displayed in the cell when the sheet is loaded or then the cell is selected when setShowCustomEditorOnFocus(boolean) is enabled. has been selected.
static org.apache.poi.ss.util.CellRangeAddress	SpreadsheetUtil.getRangeForReference(String formula, Spreadsheet spreadsheet, boolean includeHiddenCells)	evaluate the formula (which may just be a single cell or range string) and find the bounding rectangle for the referenced cells.
void	SpreadsheetComponentFactory.onCustomEditorDisplayed(org.apache.poi.ss.usermodel.Cell cell, int rowIndex, int columnIndex, Spreadsheet spreadsheet, org.apache.poi.ss.usermodel.Sheet sheet, com.vaadin.flow.component.Component customEditor)	This method is called when a cell with a custom editor is displayed (the cell is selected).
static org.apache.poi.ss.util.CellReference	SpreadsheetUtil.relativeToAbsolute(Spreadsheet sheet, org.apache.poi.ss.util.CellReference cell)

Constructors in com.vaadin.flow.component.spreadsheet with parameters of type Spreadsheet

Modifier	Constructor	Description
	CellSelectionManager(Spreadsheet spreadsheet)	Creates a new CellSelectionManager and ties it to the given Spreadsheet
	CellSelectionShifter(Spreadsheet spreadsheet)	Creates a new CellShifter and ties it to the given Spreadsheet
	CellValueManager(Spreadsheet spreadsheet)	Creates a new CellValueManager and ties it to the given Spreadsheet.
	ConditionalFormatter(Spreadsheet spreadsheet)	Constructs a new ConditionalFormatter targeting the given Spreadsheet.
	ContextMenuManager(Spreadsheet spreadsheet)	Constructs a new ContextMenuManager and ties it to the given Spreadsheet.
	DefaultHyperlinkCellClickHandler(Spreadsheet spreadsheet)
	DefaultHyperlinkCellClickHandler(Spreadsheet spreadsheet, DefaultHyperlinkCellClickHandler.HyperlinkOpenStyle openStyle)
	ItemFilter(org.apache.poi.ss.util.CellRangeAddress filterRange, Spreadsheet spreadsheet, PopupButton popupButton, SpreadsheetFilterTable filterTable)	Constructs a new item filter for the given spreadsheet, filtering range, pop-up button and filtering table.
	SheetChartWrapper(org.apache.poi.xssf.usermodel.XSSFChart chartXml, Spreadsheet spreadsheet)
	SpreadsheetEvent(Spreadsheet source, boolean fromClient, String type, tools.jackson.databind.JsonNode data)
	SpreadsheetFilterTable(Spreadsheet spreadsheet, org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.util.CellRangeAddress fullTableRegion)	Creates a new filter table for the given spreadsheet component, sheet and region.
	SpreadsheetFilterTable(Spreadsheet spreadsheet, org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.util.CellRangeAddress fullTableRegion, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTAutoFilter ctWorksheetAutoFilter, org.apache.poi.xssf.usermodel.XSSFTable xssfTable)
	SpreadsheetFilterTable(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress fullTableRegion)	Creates a new filter table for the given spreadsheet component, its active sheet (getActiveSheet() and region.
	SpreadsheetHandlerImpl(Spreadsheet spreadsheet)
	SpreadsheetHistoryManager(Spreadsheet spreadsheet)	Creates a new history manager for the given Spreadsheet.
	SpreadsheetStyleFactory(Spreadsheet spreadsheet)	Constructs a new SpreadsheetStyleFactory for the given Spreadsheet
	SpreadsheetTable(Spreadsheet spreadsheet, org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.util.CellRangeAddress fullTableRegion)	Creates a new table for the given spreadsheet component, sheet and region.
	SpreadsheetTable(Spreadsheet spreadsheet, org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.util.CellRangeAddress fullTableRegion, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTAutoFilter ctWorksheetAutoFilter, org.apache.poi.xssf.usermodel.XSSFTable xssfTable)	Creates a new table for the given spreadsheet component, sheet and region while referencing the backing xssfTable or ctWorksheetAutoFilter.
	SpreadsheetTable(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress tableRegion)	Creates a new table for the given spreadsheet component, its active sheet (returned by getActiveSheet()) and the given region.

Uses of Spreadsheet in com.vaadin.flow.component.spreadsheet.action

Methods in com.vaadin.flow.component.spreadsheet.action with parameters of type Spreadsheet

Modifier and Type	Method	Description
void	DeleteRowAction.executeActionOnHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
void	DeleteTableAction.executeActionOnHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
void	EditCellCommentAction.executeActionOnHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
void	HideHeaderAction.executeActionOnHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
void	InsertDeleteCellCommentAction.executeActionOnHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
void	InsertNewRowAction.executeActionOnHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
void	InsertTableAction.executeActionOnHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
void	MergeCellsAction.executeActionOnHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
void	ShowHideCellCommentAction.executeActionOnHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
abstract void	SpreadsheetAction.executeActionOnHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)	Execute this action on the given spreadsheet and row/column header.
void	UnHideHeadersAction.executeActionOnHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
void	UnMergeCellsAction.executeActionOnHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
void	DeleteRowAction.executeActionOnSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
void	DeleteTableAction.executeActionOnSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
void	EditCellCommentAction.executeActionOnSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
void	HideHeaderAction.executeActionOnSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
void	InsertDeleteCellCommentAction.executeActionOnSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
void	InsertNewRowAction.executeActionOnSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
void	InsertTableAction.executeActionOnSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
void	MergeCellsAction.executeActionOnSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
void	ShowHideCellCommentAction.executeActionOnSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
abstract void	SpreadsheetAction.executeActionOnSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)	Execute this action on the given spreadsheet and selection.
void	UnHideHeadersAction.executeActionOnSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
void	UnMergeCellsAction.executeActionOnSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
boolean	DeleteRowAction.isApplicableForHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
boolean	DeleteTableAction.isApplicableForHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
boolean	EditCellCommentAction.isApplicableForHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
boolean	HideHeaderAction.isApplicableForHeader(Spreadsheet spreadhseet, org.apache.poi.ss.util.CellRangeAddress headerRange)
boolean	InsertDeleteCellCommentAction.isApplicableForHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
boolean	InsertNewRowAction.isApplicableForHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
boolean	InsertTableAction.isApplicableForHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
boolean	MergeCellsAction.isApplicableForHeader(Spreadsheet spreasdheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
boolean	ShowHideCellCommentAction.isApplicableForHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
abstract boolean	SpreadsheetAction.isApplicableForHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)	Returns true if this action is possible for the given row/column header.
boolean	UnHideHeadersAction.isApplicableForHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
boolean	UnMergeCellsAction.isApplicableForHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
boolean	DeleteRowAction.isApplicableForSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
boolean	DeleteTableAction.isApplicableForSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
boolean	EditCellCommentAction.isApplicableForSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
boolean	HideHeaderAction.isApplicableForSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
boolean	InsertDeleteCellCommentAction.isApplicableForSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
boolean	InsertNewRowAction.isApplicableForSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
boolean	InsertTableAction.isApplicableForSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
boolean	MergeCellsAction.isApplicableForSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
boolean	ShowHideCellCommentAction.isApplicableForSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
abstract boolean	SpreadsheetAction.isApplicableForSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)	Returns true if this action is possible in the given spreadsheet for the given selection.
boolean	UnHideHeadersAction.isApplicableForSelection(Spreadsheet spreadhseet, Spreadsheet.SelectionChangeEvent event)
boolean	UnMergeCellsAction.isApplicableForSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)
protected boolean	SpreadsheetAction.isSheetProtected(Spreadsheet spreadsheet)	Returns the protection status of the given spreadsheet.

Uses of Spreadsheet in com.vaadin.flow.component.spreadsheet.charts.converter

Methods in com.vaadin.flow.component.spreadsheet.charts.converter with parameters of type Spreadsheet

Modifier and Type	Method	Description
com.vaadin.flow.component.Component	DefaultChartCreator.createChart(org.apache.poi.xssf.usermodel.XSSFChart chartXml, Spreadsheet spreadsheet)
static List<org.apache.poi.ss.util.CellReference>	Utils.getAllReferencedCells(String formula, Spreadsheet spreadsheet, boolean includeHiddenCells)	This function returns all the cells that the given formula references.
static List<org.apache.poi.ss.util.CellReference>	Utils.getAllReferencedVisibleCells(String formula, Spreadsheet spreadsheet)	This function uses the getAllReferencedCells function but filters out all the hidden rows from the list honoring filtering of charts based on spreadsheettable filter settings
static Double	Utils.getNumericValue(org.apache.poi.ss.util.CellReference ref, Spreadsheet spreadsheet)
static String	Utils.getStringValue(org.apache.poi.ss.util.CellReference ref, Spreadsheet spreadsheet)
static String	Utils.getStringValueFromFormula(String formula, Spreadsheet spreadsheet)

Uses of Spreadsheet in com.vaadin.flow.component.spreadsheet.charts.converter.xssfreader

Methods in com.vaadin.flow.component.spreadsheet.charts.converter.xssfreader that return Spreadsheet

Modifier and Type	Method	Description
protected Spreadsheet	AbstractSeriesReader.getSpreadsheet()

Constructors in com.vaadin.flow.component.spreadsheet.charts.converter.xssfreader with parameters of type Spreadsheet

Modifier	Constructor	Description
	AbstractSeriesReader(org.apache.xmlbeans.XmlObject ctChart, Spreadsheet spreadsheet, boolean showDataInHiddenCells)
	AbstractSeriesReader(org.apache.xmlbeans.XmlObject ctChart, Spreadsheet spreadsheet, boolean is3d, boolean showDataInHiddenCells)
	AreaSeriesReader(org.openxmlformats.schemas.drawingml.x2006.chart.CTAreaChart ctChart, Spreadsheet spreadsheet, boolean showDataInHiddenCells)
	BarSeriesReader(org.openxmlformats.schemas.drawingml.x2006.chart.CTBar3DChart ctChart, Spreadsheet spreadsheet, boolean showDataInHiddenCells)
	BarSeriesReader(org.openxmlformats.schemas.drawingml.x2006.chart.CTBarChart ctChart, Spreadsheet spreadsheet, boolean showDataInHiddenCells)
	BubbleSeriesReader(org.apache.xmlbeans.XmlObject ctChart, Spreadsheet spreadsheet, boolean showDataInHiddenCells)
	GenericSeriesReader(org.apache.xmlbeans.XmlObject ctChart, Spreadsheet spreadsheet, boolean showDataInHiddenCells)
	LineSeriesReader(org.openxmlformats.schemas.drawingml.x2006.chart.CTLineChart ctChart, Spreadsheet spreadsheet, boolean showDataInHiddenCells)
	PieSeriesReader(org.openxmlformats.schemas.drawingml.x2006.chart.CTDoughnutChart ctChart, Spreadsheet spreadsheet, boolean showDataInHiddenCells)
	PieSeriesReader(org.openxmlformats.schemas.drawingml.x2006.chart.CTPie3DChart ctChart, Spreadsheet spreadsheet, boolean showDataInHiddenCells)
	PieSeriesReader(org.openxmlformats.schemas.drawingml.x2006.chart.CTPieChart ctChart, Spreadsheet spreadsheet, boolean showDataInHiddenCells)
	RadarSeriesReader(org.openxmlformats.schemas.drawingml.x2006.chart.CTRadarChart ctChart, Spreadsheet spreadsheet, boolean showDataInHiddenCells)
	ScatterSeriesReader(org.openxmlformats.schemas.drawingml.x2006.chart.CTScatterChart ctChart, Spreadsheet spreadsheet, boolean showDataInHiddenCells)
	XSSFChartReader(Spreadsheet spreadsheet, org.apache.poi.xssf.usermodel.XSSFChart xssfChart)

Uses of Spreadsheet in com.vaadin.flow.component.spreadsheet.command

Fields in com.vaadin.flow.component.spreadsheet.command declared as Spreadsheet

Modifier and Type	Field	Description
protected final Spreadsheet	SpreadsheetCommand.spreadsheet

Constructors in com.vaadin.flow.component.spreadsheet.command with parameters of type Spreadsheet

Modifier	Constructor	Description
	CellShiftValuesCommand(Spreadsheet spreadsheet, boolean decrease)	Creates a new CellShiftValuesCommand targeting the given spreadsheet.
	CellValueCommand(Spreadsheet spreadsheet)	Sets the currently selected cell of the spreadsheet as the selected cell and possible painted range for this command.
	RowInsertOrDeleteCommand(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)
	SizeChangeCommand(Spreadsheet spreadsheet, SizeChangeCommand.Type type)
	SpreadsheetCommand(Spreadsheet spreadsheet)	Creates a new command targeting the given spreadsheet.

Uses of Spreadsheet in org.apache.poi.ss.formula

Methods in org.apache.poi.ss.formula with parameters of type Spreadsheet

Modifier and Type	Method	Description
static org.apache.poi.ss.formula.eval.ValueEval	WorkbookEvaluatorUtil.evaluate(Spreadsheet spreadsheet, org.apache.poi.ss.formula.ptg.Ptg[] ptgs, org.apache.poi.ss.usermodel.Cell cell)	Evaluate formula Ptg[] tokens
static org.apache.poi.xssf.usermodel.BaseXSSFEvaluationWorkbook	WorkbookEvaluatorUtil.getEvaluationWorkbook(Spreadsheet spreadsheet)