org.uberfire.ext.wires.core.grids.client.widget.grid

Interface NodeMouseEventHandler

All Known Implementing Classes:

DefaultGridWidgetCellSelectorMouseEventHandler, DefaultGridWidgetCollapsedCellMouseEventHandler, DefaultGridWidgetEditCellMouseEventHandler, DefaultGridWidgetLinkedColumnMouseEventHandler, DefaultGridWidgetPinnedModeMouseEventHandler

public interface NodeMouseEventHandler

Defines a generic handler for any type of AbstractNodeMouseEvent.

Method Summary

Modifier and Type	Method and Description
default boolean	handleBodyCell(GridWidget gridWidget, com.ait.lienzo.client.core.types.Point2D relativeLocation, int uiRowIndex, int uiColumnIndex, com.ait.lienzo.client.core.event.AbstractNodeMouseEvent event) Handles the event for a Body element.
default boolean	handleHeaderCell(GridWidget gridWidget, com.ait.lienzo.client.core.types.Point2D relativeLocation, int uiHeaderRowIndex, int uiHeaderColumnIndex, com.ait.lienzo.client.core.event.AbstractNodeMouseEvent event) Handles the event for a Header element.
default boolean	isDNDOperationInProgress(GridWidget gridWidget) Returns whether the AbstractNodeMouseEvent occurred during a Drag and Drop operation.
boolean	onNodeMouseEvent(GridWidget gridWidget, com.ait.lienzo.client.core.types.Point2D relativeLocation, Optional<Integer> uiHeaderRowIndex, Optional<Integer> uiHeaderColumnIndex, Optional<Integer> uiRowIndex, Optional<Integer> uiColumnIndex, com.ait.lienzo.client.core.event.AbstractNodeMouseEvent event) Executes when a NodeMouseEventHandler reacts to the AbstractNodeMouseEvent to which the NodeMouseEventHandler has been registered.

Method Detail

onNodeMouseEvent

boolean onNodeMouseEvent(GridWidget gridWidget,
                         com.ait.lienzo.client.core.types.Point2D relativeLocation,
                         Optional<Integer> uiHeaderRowIndex,
                         Optional<Integer> uiHeaderColumnIndex,
                         Optional<Integer> uiRowIndex,
                         Optional<Integer> uiColumnIndex,
                         com.ait.lienzo.client.core.event.AbstractNodeMouseEvent event)

Executes when a NodeMouseEventHandler reacts to the AbstractNodeMouseEvent to which the NodeMouseEventHandler has been registered. Note uiHeaderRowIndex, uiHeaderColumnIndex, uiRowIndex and uiColumnIndex may be Optional.empty() if the event did not occur over the applicable element within the GridWidget.

Parameters:

gridWidget - The GridWidget on which the event occurred.

relativeLocation - Point2D relative to the top-left of the GridWidget

uiHeaderRowIndex - Index of the Header row as seen in the UI. 0-based index. Top row is 0.

uiHeaderColumnIndex - Index of the Header column as seen in the UI. 0-based index. Leftmost column is 0.

uiRowIndex - Index of the Body row as seen in the UI

uiColumnIndex - Index of the Body column as seen in the UI

event - The original event.

Returns:

true if the event was handled.

handleHeaderCell

default boolean handleHeaderCell(GridWidget gridWidget,
                                 com.ait.lienzo.client.core.types.Point2D relativeLocation,
                                 int uiHeaderRowIndex,
                                 int uiHeaderColumnIndex,
                                 com.ait.lienzo.client.core.event.AbstractNodeMouseEvent event)

Handles the event for a Header element.

Parameters:

gridWidget - The GridWidget on which the event occurred.

relativeLocation - Point2D relative to the top-left of the GridWidget

uiHeaderRowIndex - Index of the Header row as seen in the UI. 0-based index. Top row is 0.

uiHeaderColumnIndex - Index of the Header column as seen in the UI. 0-based index. Leftmost column is 0.

event - The original event.

Returns:

true if the event was handled.

handleBodyCell

default boolean handleBodyCell(GridWidget gridWidget,
                               com.ait.lienzo.client.core.types.Point2D relativeLocation,
                               int uiRowIndex,
                               int uiColumnIndex,
                               com.ait.lienzo.client.core.event.AbstractNodeMouseEvent event)

Handles the event for a Body element.

Parameters:

gridWidget - The GridWidget on which the event occurred.

relativeLocation - Point2D relative to the top-left of the GridWidget

uiRowIndex - Index of the Body row as seen in the UI

uiColumnIndex - Index of the Body column as seen in the UI

event - The original event.

Returns:

true if the event was handled.

isDNDOperationInProgress

default boolean isDNDOperationInProgress(GridWidget gridWidget)

Returns whether the AbstractNodeMouseEvent occurred during a Drag and Drop operation.

Parameters:

gridWidget - The GridWidget on which the event occurred.

Returns:

true if the event occurred during a Drag and Drop operation.