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

Class DefaultGridWidgetEditCellMouseEventHandler

java.lang.Object

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

All Implemented Interfaces:

NodeMouseEventHandler

public class DefaultGridWidgetEditCellMouseEventHandler
extends Object
implements NodeMouseEventHandler

A NodeMouseEventHandler to handle editing of cells.

Constructor Summary

Constructors

Constructor and Description
DefaultGridWidgetEditCellMouseEventHandler()

Method Summary

Modifier and Type	Method and Description
boolean	handleBodyCell(GridWidget gridWidget, com.ait.lienzo.client.core.types.Point2D relativeLocation, int uiRowIndex, int uiColumnIndex, com.ait.lienzo.client.core.event.AbstractNodeMouseEvent event) Checks if a AbstractNodeMouseEvent happened within a GridCell.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.uberfire.ext.wires.core.grids.client.widget.grid.NodeMouseEventHandler

handleHeaderCell, isDNDOperationInProgress

Constructor Detail

DefaultGridWidgetEditCellMouseEventHandler

public DefaultGridWidgetEditCellMouseEventHandler()

Method Detail

onNodeMouseEvent

public 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)

Description copied from interface: NodeMouseEventHandler

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.

Specified by:

onNodeMouseEvent in interface NodeMouseEventHandler

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.

handleBodyCell

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

Checks if a AbstractNodeMouseEvent happened within a GridCell. If the AbstractNodeMouseEvent is found to have happened within a cell, the GridCell.getSupportedEditAction() is checked to Object.equals(Object) that for the AbstractNodeMouseEvent. If they equal then the GridCell is put into "edit" mode via CellSelectionManager.startEditingCell(Point2D).

Specified by:

handleBodyCell in interface NodeMouseEventHandler

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.