com.vaadin.flow.component.gridpro.GridPro.CellEditStartedEvent 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.gridpro.

java.lang.Object
- java.util.EventObject
- - com.vaadin.flow.component.ComponentEvent<GridPro<E>>
  - - com.vaadin.flow.component.gridpro.GridPro.CellEditStartedEvent<E>

Type Parameters:

E - the bean type

All Implemented Interfaces:

Serializable

Enclosing class:

GridPro<E>
```
@DomEvent("cell-edit-started")
public static class GridPro.CellEditStartedEvent<E>
extends ComponentEvent<GridPro<E>>
```
Event fired when the user starts to edit an existing item.

See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor	Description
`CellEditStartedEvent(GridPro<E> source, boolean fromClient, elemental.json.JsonObject item, String path)`	Creates a new event using the given source and indicator whether the event originated from the client side or the server side.

Method Summary

All Methods
Modifier and Type Method Description

E getItem()
Gets an instance of edited item.
- 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
  - CellEditStartedEvent
```
public CellEditStartedEvent(GridPro<E> source,
                            boolean fromClient,
                            @EventData("event.detail.item")
                            elemental.json.JsonObject item,
                            @EventData("event.detail.path")
                            String path)
```
    Creates a new event using the given source and indicator whether the event originated from the client side or the server side.
    
    Parameters:
    
    source - the source component
    
    fromClient - true if the event originated from the client
    
    item - the item to be edited, provided in JSON as internally represented in Grid
    
    path - item subproperty that was changed
- Method Detail
  - getItem
```
public E getItem()
```
    Gets an instance of edited item.
    
    Returns:
    
    the instance of edited item