Package com.vaadin.flow.component.spreadsheet.command

Class CellShiftValuesCommand

java.lang.Object

com.vaadin.flow.component.spreadsheet.command.SpreadsheetCommand

com.vaadin.flow.component.spreadsheet.command.CellValueCommand

com.vaadin.flow.component.spreadsheet.command.CellShiftValuesCommand

All Implemented Interfaces:

Command, ValueChangeCommand, Serializable

public class CellShiftValuesCommand
extends CellValueCommand

Command for shifting the value(s) of one or more cells.

Since:

1.0

Author:

Vaadin Ltd.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.vaadin.flow.component.spreadsheet.command.CellValueCommand

selectedcellCol, selectedCellRange, selectedCellRow, values

Fields inherited from class com.vaadin.flow.component.spreadsheet.command.SpreadsheetCommand

activeSheetIndex, spreadsheet

Constructor Summary

Constructors

Constructor	Description
CellShiftValuesCommand(Spreadsheet spreadsheet, boolean decrease)	Creates a new CellShiftValuesCommand targeting the given spreadsheet.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes this command.
org.apache.poi.ss.util.CellRangeAddress	getPaintedCellRange()	The painted range that should be set when this command is run.
org.apache.poi.ss.util.CellReference	getSelectedCellReference()	The selected cell that should be set when this command is run.

Methods inherited from class com.vaadin.flow.component.spreadsheet.command.CellValueCommand

captureCellRangeValues, captureCellValues, clearValues, getCell, getCellValue, getCellValue, getCellValue, getChangedCells, updateCellValue

Methods inherited from class com.vaadin.flow.component.spreadsheet.command.SpreadsheetCommand

getActiveSheetIndex, getSheet, setActiveSheetIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.spreadsheet.command.Command

getActiveSheetIndex, setActiveSheetIndex

Constructor Detail

CellShiftValuesCommand

public CellShiftValuesCommand(Spreadsheet spreadsheet,
                              boolean decrease)

Creates a new CellShiftValuesCommand targeting the given spreadsheet.

Parameters:

spreadsheet - Target spreadsheet

decrease -

Method Detail

execute

public void execute()

Description copied from interface: Command

Executes this command.

Specified by:

execute in interface Command

Overrides:

execute in class CellValueCommand

getSelectedCellReference

public org.apache.poi.ss.util.CellReference getSelectedCellReference()

Description copied from interface: Command

The selected cell that should be set when this command is run. In case this command shouldn't change the selected cell, null is returned.

Specified by:

getSelectedCellReference in interface Command

Overrides:

getSelectedCellReference in class CellValueCommand

Returns:

the selection or null

getPaintedCellRange

public org.apache.poi.ss.util.CellRangeAddress getPaintedCellRange()

Description copied from interface: Command

The painted range that should be set when this command is run. In case his command shouldn't set a painted range, null is returned.

Specified by:

getPaintedCellRange in interface Command

Overrides:

getPaintedCellRange in class CellValueCommand

Returns:

the painted range or null