com.vaadin.flow.component.spreadsheet.Spreadsheet.SheetChangeEvent API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.component.spreadsheet.

java.lang.Object
- java.util.EventObject
- - com.vaadin.flow.component.ComponentEvent<Component>
  - - com.vaadin.flow.component.spreadsheet.Spreadsheet.SheetChangeEvent

All Implemented Interfaces:

Serializable

Enclosing class:

Spreadsheet
```
public static class Spreadsheet.SheetChangeEvent
extends ComponentEvent<Component>
```
An event that is fired to registered listeners when the selected sheet has been changed.

See Also:

Serialized Form

Field Summary
- Fields inherited from class java.util.EventObject
  source

Constructor Summary

Constructors
Constructor	Description
`SheetChangeEvent(Component source, org.apache.poi.ss.usermodel.Sheet newSheet, org.apache.poi.ss.usermodel.Sheet previousSheet, int newSheetVisibleIndex, int newSheetPOIIndex)`	Creates a new SheetChangeEvent.

Method Summary

All Methods
Modifier and Type	Method	Description
`org.apache.poi.ss.usermodel.Sheet`	`getNewSheet()`	Gets the newly selected sheet.
`int`	`getNewSheetPOIIndex()`	Gets the POI index of the newly selected sheet.
`int`	`getNewSheetVisibleIndex()`	Gets the index of the newly selected sheet among all visible sheets.
`org.apache.poi.ss.usermodel.Sheet`	`getPreviousSheet()`	Gets the sheet that was previously selected.

Methods inherited from class com.vaadin.flow.component.ComponentEvent
getSource, isFromClient, unregisterListener

Methods inherited from class java.util.EventObject
toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SheetChangeEvent
```
public SheetChangeEvent(Component source,
                        org.apache.poi.ss.usermodel.Sheet newSheet,
                        org.apache.poi.ss.usermodel.Sheet previousSheet,
                        int newSheetVisibleIndex,
                        int newSheetPOIIndex)
```
    Creates a new SheetChangeEvent.
    
    Parameters:
    
    source - Spreadsheet that triggered the event
    
    newSheet - New selection
    
    previousSheet - Previous selection
    
    newSheetVisibleIndex - New visible index of selection
    
    newSheetPOIIndex - New POI index of selection
- Method Detail
  - getNewSheet
```
public org.apache.poi.ss.usermodel.Sheet getNewSheet()
```
    Gets the newly selected sheet.
    
    Returns:
    
    The new selection
  - getPreviousSheet
```
public org.apache.poi.ss.usermodel.Sheet getPreviousSheet()
```
    Gets the sheet that was previously selected.
    
    Returns:
    
    The previous selection
  - getNewSheetVisibleIndex
```
public int getNewSheetVisibleIndex()
```
    Gets the index of the newly selected sheet among all visible sheets.
    
    Returns:
    
    Index of new selection among visible sheets
  - getNewSheetPOIIndex
```
public int getNewSheetPOIIndex()
```
    Gets the POI index of the newly selected sheet.
    
    Returns:
    
    POI index of new selection