io.jmix.ui.component

Class DataGrid.DataGridClickEvent

java.lang.Object

java.util.EventObject

io.jmix.ui.component.DataGrid.AbstractDataGridEvent

io.jmix.ui.component.DataGrid.DataGridClickEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DataGrid.ContextClickEvent, DataGrid.ItemClickEvent, DataGrid.RendererClickEvent

Enclosing interface:

DataGrid<E>

public static class DataGrid.DataGridClickEvent
extends DataGrid.AbstractDataGridEvent

Class for holding information about a mouse click event. A DataGrid.DataGridClickEvent is fired when the user clicks on a Component.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected MouseEventDetails	details

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
DataGridClickEvent(DataGrid component, MouseEventDetails details)

Method Summary

Modifier and Type	Method and Description
MouseEventDetails.MouseButton	getButton() Returns an identifier describing which mouse button the user pushed.
int	getClientX() Returns the mouse position (x coordinate) when the click took place.
int	getClientY() Returns the mouse position (y coordinate) when the click took place.
int	getRelativeX() Returns the relative mouse position (x coordinate) when the click took place.
int	getRelativeY() Returns the relative mouse position (y coordinate) when the click took place.
boolean	isAltKey() Checks if the Alt key was down when the mouse event took place.
boolean	isCtrlKey() Checks if the Ctrl key was down when the mouse event took place.
boolean	isDoubleClick() Checks if the event is a double click event.
boolean	isMetaKey() Checks if the Meta key was down when the mouse event took place.
boolean	isShiftKey() Checks if the Shift key was down when the mouse event took place.

Methods inherited from class io.jmix.ui.component.DataGrid.AbstractDataGridEvent

getSource

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

Field Detail

details

protected final MouseEventDetails details

Constructor Detail

DataGridClickEvent

public DataGridClickEvent(DataGrid component,
                          MouseEventDetails details)

Method Detail

getButton

public MouseEventDetails.MouseButton getButton()

Returns an identifier describing which mouse button the user pushed. Compare with MouseEventDetails.MouseButton.LEFT,MouseEventDetails.MouseButton.MIDDLE, MouseEventDetails.MouseButton.RIGHT to find out which button it is.

Returns:

one of MouseEventDetails.MouseButton.LEFT, MouseEventDetails.MouseButton.MIDDLE, MouseEventDetails.MouseButton.RIGHT.

getClientX

public int getClientX()

Returns the mouse position (x coordinate) when the click took place. The position is relative to the browser client area.

Returns:

The mouse cursor x position

getClientY

public int getClientY()

Returns the mouse position (y coordinate) when the click took place. The position is relative to the browser client area.

Returns:

The mouse cursor y position

getRelativeX

public int getRelativeX()

Returns the relative mouse position (x coordinate) when the click took place. The position is relative to the clicked component.

Returns:

The mouse cursor x position relative to the clicked layout component or -1 if no x coordinate available

getRelativeY

public int getRelativeY()

Returns the relative mouse position (y coordinate) when the click took place. The position is relative to the clicked component.

Returns:

The mouse cursor y position relative to the clicked layout component or -1 if no y coordinate available

isDoubleClick

public boolean isDoubleClick()

Checks if the event is a double click event.

Returns:

true if the event is a double click event, false otherwise

isAltKey

public boolean isAltKey()

Checks if the Alt key was down when the mouse event took place.

Returns:

true if Alt was down when the event occurred, false otherwise

isCtrlKey

public boolean isCtrlKey()

Checks if the Ctrl key was down when the mouse event took place.

Returns:

true if Ctrl was pressed when the event occurred, false otherwise

isMetaKey

public boolean isMetaKey()

Checks if the Meta key was down when the mouse event took place.

Returns:

true if Meta was pressed when the event occurred, false otherwise

isShiftKey

public boolean isShiftKey()

Checks if the Shift key was down when the mouse event took place.

Returns:

true if Shift was pressed when the event occurred, false otherwise