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

Class DefaultGridWidgetPinnedModeMouseEventHandler

java.lang.Object

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

All Implemented Interfaces:

NodeMouseEventHandler

public class DefaultGridWidgetPinnedModeMouseEventHandler
extends Object
implements NodeMouseEventHandler

A NodeMouseEventHandler to handle entering or exiting of a GridWidget "pinned" state. If a AbstractNodeMouseEvent is found to have happened within the GridWidget Header the "pinned" mode is toggled. See GridPinnedModeManager for more information.

Field Summary

Fields

Modifier and Type	Field and Description
protected GridPinnedModeManager	pinnedModeManager
protected GridRenderer	renderer

Constructor Summary

Constructors

Constructor and Description
DefaultGridWidgetPinnedModeMouseEventHandler(GridPinnedModeManager pinnedModeManager, GridRenderer renderer)

Method Summary

Modifier and Type	Method and Description
boolean	handleHeaderCell(GridWidget gridWidget, com.ait.lienzo.client.core.types.Point2D relativeLocation, int uiHeaderRowIndex, int uiHeaderColumnIndex, com.ait.lienzo.client.core.event.AbstractNodeMouseEvent event) Checks if a AbstractNodeMouseEvent is found to have happened within the GridWidget Header.
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

handleBodyCell, isDNDOperationInProgress

Field Detail

pinnedModeManager

protected GridPinnedModeManager pinnedModeManager

renderer

protected GridRenderer renderer

Constructor Detail

DefaultGridWidgetPinnedModeMouseEventHandler

public DefaultGridWidgetPinnedModeMouseEventHandler(GridPinnedModeManager pinnedModeManager,
                                                    GridRenderer renderer)

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.

handleHeaderCell

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

Checks if a AbstractNodeMouseEvent is found to have happened within the GridWidget Header. If the AbstractNodeMouseEvent was found to have happened in the GridWidget Header the "pinned" mode is toggled. See GridPinnedModeManager for more information.

Specified by:

handleHeaderCell 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.

event - The original event.

Returns:

true if the event was handled.