com.vaadin.flow.component.gridpro.GridPro.ItemPropertyChangedEvent API 13.0.13 | 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.ItemPropertyChangedEvent<E>

Type Parameters:

E - the bean type

All Implemented Interfaces:

Serializable

Enclosing class:

GridPro<E>
```
@DomEvent(value="item-property-changed")
public static class GridPro.ItemPropertyChangedEvent<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 and Description
`ItemPropertyChangedEvent(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 and Description
`E`	`getItem()` Gets an instance of edited item.
`String`	`getPath()` Gets the key of the column where item was edited.
`elemental.json.JsonObject`	`getSourceItem()` Gets an instance of edited item with the relations to the columns.

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
  - ItemPropertyChangedEvent
```
public ItemPropertyChangedEvent(GridPro<E> source,
                                boolean fromClient,
                                @EventData(value="event.detail.item")
                                elemental.json.JsonObject item,
                                @EventData(value="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
  - getSourceItem
```
public elemental.json.JsonObject getSourceItem()
```
    Gets an instance of edited item with the relations to the columns.
    
    Returns:
    
    the instance of edited item
  - getPath
```
public String getPath()
```
    Gets the key of the column where item was edited.
    
    Returns:
    
    the key of the column