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 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:

  • 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 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