Package com.vaadin.flow.component.dashboard

Class DashboardItemMoveModeChangedEvent

java.lang.Object

java.util.EventObject

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

com.vaadin.flow.component.dashboard.DashboardItemMoveModeChangedEvent

All Implemented Interfaces:

Serializable

@DomEvent("dashboard-item-move-mode-changed")
public class DashboardItemMoveModeChangedEvent
extends com.vaadin.flow.component.ComponentEvent<Dashboard>

Fired when an item enters or exits move mode. Move mode enables using move buttons or keyboard to move items.

Author:

Vaadin Ltd.

See Also:

• Dashboard.addItemMoveModeChangedListener(ComponentEventListener)
• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
DashboardItemMoveModeChangedEvent(Dashboard source, boolean fromClient, int itemId, boolean moveMode)	Creates a dashboard item move mode changed event.

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.component.Component	getItem()	Returns the item of which the move mode state has changed
boolean	isMoveMode()	Returns whether the item is in move mode

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

DashboardItemMoveModeChangedEvent

public DashboardItemMoveModeChangedEvent(Dashboard source,
 boolean fromClient,
 @EventData("event.detail.item.id")
 int itemId,
 @EventData("event.detail.value")
 boolean moveMode)

Creates a dashboard item move mode changed event.

Parameters:

source - Dashboard that contains the item of which the move mode state has changed

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

itemId - The ID of the item of which the move mode state has changed

moveMode - Whether the item is in move mode

Method Details

getItem

public com.vaadin.flow.component.Component getItem()

Returns the item of which the move mode state has changed

Returns:

the item of which the move mode state has changed

isMoveMode

public boolean isMoveMode()

Returns whether the item is in move mode

Returns:

whether the item is in move mode