Package com.vaadin.flow.component.spreadsheet.action

Class EditCellCommentAction

java.lang.Object

com.vaadin.flow.component.spreadsheet.framework.Action

com.vaadin.flow.component.spreadsheet.action.SpreadsheetAction

com.vaadin.flow.component.spreadsheet.action.EditCellCommentAction

All Implemented Interfaces:

Serializable

public class EditCellCommentAction
extends SpreadsheetAction

Spreadsheet action for inserting or deleting a comment to a cell.

Since:

1.0

Author:

Vaadin Ltd.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.spreadsheet.framework.Action

Action.Container, Action.Handler, Action.Listener, Action.Notifier, Action.ShortcutNotifier

Constructor Summary

Constructors

Constructor	Description
EditCellCommentAction()

Method Summary

Modifier and Type	Method	Description
void	executeActionOnHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)	Execute this action on the given spreadsheet and row/column header.
void	executeActionOnSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)	Execute this action on the given spreadsheet and selection.
boolean	isApplicableForHeader(Spreadsheet spreadsheet, org.apache.poi.ss.util.CellRangeAddress headerRange)	Returns true if this action is possible for the given row/column header.
boolean	isApplicableForSelection(Spreadsheet spreadsheet, Spreadsheet.SelectionChangeEvent event)	Returns true if this action is possible in the given spreadsheet for the given selection.

Methods inherited from class com.vaadin.flow.component.spreadsheet.action.SpreadsheetAction

getColumnHeader, isCellLocked, isSheetProtected, isSheetProtected

Methods inherited from class com.vaadin.flow.component.spreadsheet.framework.Action

getCaption, getIcon, setCaption

Methods inherited from class java.lang.Object

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

Constructor Details

EditCellCommentAction

public EditCellCommentAction()

Method Details

isApplicableForSelection

public boolean isApplicableForSelection(Spreadsheet spreadsheet,
 Spreadsheet.SelectionChangeEvent event)

Description copied from class: SpreadsheetAction

Returns true if this action is possible in the given spreadsheet for the given selection.

Specified by:

isApplicableForSelection in class SpreadsheetAction

Parameters:

spreadsheet - Target spreadsheet

event - Selection event

Returns:

true if it's possible to execute this action

isApplicableForHeader

public boolean isApplicableForHeader(Spreadsheet spreadsheet,
 org.apache.poi.ss.util.CellRangeAddress headerRange)

Description copied from class: SpreadsheetAction

Returns true if this action is possible for the given row/column header.

Specified by:

isApplicableForHeader in class SpreadsheetAction

Parameters:

spreadsheet - Target spreadsheet

headerRange - Target column/row header range

Returns:

true if it's possible to execute this action

executeActionOnSelection

public void executeActionOnSelection(Spreadsheet spreadsheet,
 Spreadsheet.SelectionChangeEvent event)

Description copied from class: SpreadsheetAction

Execute this action on the given spreadsheet and selection.

Specified by:

executeActionOnSelection in class SpreadsheetAction

Parameters:

spreadsheet - Target spreadsheet

event - Selection event

executeActionOnHeader

public void executeActionOnHeader(Spreadsheet spreadsheet,
 org.apache.poi.ss.util.CellRangeAddress headerRange)

Description copied from class: SpreadsheetAction

Execute this action on the given spreadsheet and row/column header.

Specified by:

executeActionOnHeader in class SpreadsheetAction

Parameters:

spreadsheet - Target spreadsheet

headerRange - Target header range