Package com.vaadin.flow.component.dashboard

Class DashboardItemMovedEvent

java.lang.Object

java.util.EventObject

com.vaadin.flow.component.ComponentEvent<Dashboard>

com.vaadin.flow.component.dashboard.DashboardItemMovedEvent

All Implemented Interfaces:

Serializable

public class DashboardItemMovedEvent
extends ComponentEvent<Dashboard>

Fired when an item was moved.

Author:

Vaadin Ltd.

See Also:

• Dashboard.addItemMovedListener(ComponentEventListener)
• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
DashboardItemMovedEvent(Dashboard source, boolean fromClient, Component item, List<Component> items, DashboardSection section)	Creates a dashboard item moved event.

Method Summary

Modifier and Type	Method	Description
Component	getItem()	Returns the moved item
List<Component>	getItems()	Returns the root level items of the dashboard
Optional<DashboardSection>	getSection()	Returns the section that contains the moved item, or an empty optional if the item is a direct child of the dashboard

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 Details

DashboardItemMovedEvent

public DashboardItemMovedEvent(Dashboard source,
 boolean fromClient,
 Component item,
 List<Component> items,
 DashboardSection section)

Creates a dashboard item moved event.

Parameters:

source - Dashboard that contains the item that was moved

fromClient - true if the event originated from the client side, false otherwise

item - The moved item

items - The root level items of the dashboard

section - The section that contains the moved item, null if the item is a direct child of the dashboard

Method Details

getItem

public Component getItem()

Returns the moved item

Returns:

the moved item

getItems

public List<Component> getItems()

Returns the root level items of the dashboard

Returns:

the root level items of the dashboard

getSection

public Optional<DashboardSection> getSection()

Returns the section that contains the moved item, or an empty optional if the item is a direct child of the dashboard

Returns:

the section that contains the moved item, or an empty optional if the item is a direct child of the dashboard