Class SizeChangeCommand
- java.lang.Object
-
- com.vaadin.flow.component.spreadsheet.command.SpreadsheetCommand
-
- com.vaadin.flow.component.spreadsheet.command.SizeChangeCommand
-
- All Implemented Interfaces:
Command,Serializable
public class SizeChangeCommand extends SpreadsheetCommand
Command for changing the height of row(s) or the width of column(s).- Since:
- 1.0
- Author:
- Vaadin Ltd.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSizeChangeCommand.TypeDetermines whether this command applies to a row or to a column.
-
Field Summary
-
Fields inherited from class com.vaadin.flow.component.spreadsheet.command.SpreadsheetCommand
activeSheetIndex, spreadsheet
-
-
Constructor Summary
Constructors Constructor Description SizeChangeCommand(Spreadsheet spreadsheet, SizeChangeCommand.Type type)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcaptureValues(Integer[] indexes)Captures the current row heights or column widths (depending on the type set to this command) for the row/column indexes given.voidexecute()Executes this command.org.apache.poi.ss.util.CellRangeAddressgetPaintedCellRange()The painted range that should be set when this command is run.org.apache.poi.ss.util.CellReferencegetSelectedCellReference()The selected cell that should be set when this command is run.SizeChangeCommand.TypegetType()Returns the type of size change this represents.-
Methods inherited from class com.vaadin.flow.component.spreadsheet.command.SpreadsheetCommand
getActiveSheetIndex, getSheet, setActiveSheetIndex
-
-
-
-
Constructor Detail
-
SizeChangeCommand
public SizeChangeCommand(Spreadsheet spreadsheet, SizeChangeCommand.Type type)
-
-
Method Detail
-
getType
public SizeChangeCommand.Type getType()
Returns the type of size change this represents.- Returns:
- size change type
-
captureValues
public void captureValues(Integer[] indexes)
Captures the current row heights or column widths (depending on the type set to this command) for the row/column indexes given.- Parameters:
indexes- Row /column indexes, 1-based
-
execute
public void execute()
Description copied from interface:CommandExecutes this command.
-
getSelectedCellReference
public org.apache.poi.ss.util.CellReference getSelectedCellReference()
Description copied from interface:CommandThe selected cell that should be set when this command is run. In case this command shouldn't change the selected cell,nullis returned.- Returns:
- the selection or
null
-
getPaintedCellRange
public org.apache.poi.ss.util.CellRangeAddress getPaintedCellRange()
Description copied from interface:CommandThe painted range that should be set when this command is run. In case his command shouldn't set a painted range,nullis returned.- Returns:
- the painted range or
null
-
-