com.vaadin.event

Class MouseEvents.ClickEvent

java.lang.Object

java.util.EventObject

com.vaadin.event.ConnectorEvent

com.vaadin.ui.Component.Event

com.vaadin.event.MouseEvents.ClickEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractSplitPanel.SplitterClickEvent, ClickableRenderer.RendererClickEvent, ContextClickEvent, ItemClickEvent, LayoutEvents.LayoutClickEvent, Table.FooterClickEvent, Table.HeaderClickEvent

Enclosing interface:

MouseEvents

public static class MouseEvents.ClickEvent
extends Component.Event

Class for holding information about a mouse click event. A MouseEvents.ClickEvent is fired when the user clicks on a Component. The information available for click events are terminal dependent. Correct values for all event details cannot be guaranteed.

Since:

6.2

Author:

Vaadin Ltd.

See Also:

MouseEvents.ClickListener, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static MouseEventDetails.MouseButton	BUTTON_LEFT Deprecated. As of 7.0, use Button#LEFT instead.
static MouseEventDetails.MouseButton	BUTTON_MIDDLE Deprecated. As of 7.0, use Button#MIDDLE instead.
static MouseEventDetails.MouseButton	BUTTON_RIGHT Deprecated. As of 7.0, use Button#RIGHT instead.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ClickEvent(Component source, MouseEventDetails mouseEventDetails)

Method Summary

Modifier and Type	Method and Description
MouseEventDetails.MouseButton	getButton() Returns an identifier describing which mouse button the user pushed.
String	getButtonName() Returns a human readable string representing which button has been 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 com.vaadin.ui.Component.Event

getComponent

Methods inherited from class com.vaadin.event.ConnectorEvent

getConnector

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

BUTTON_LEFT

@Deprecated
public static final MouseEventDetails.MouseButton BUTTON_LEFT

Deprecated. As of 7.0, use Button#LEFT instead.

BUTTON_MIDDLE

@Deprecated
public static final MouseEventDetails.MouseButton BUTTON_MIDDLE

Deprecated. As of 7.0, use Button#MIDDLE instead.

BUTTON_RIGHT

@Deprecated
public static final MouseEventDetails.MouseButton BUTTON_RIGHT

Deprecated. As of 7.0, use Button#RIGHT instead.

Constructor Detail

ClickEvent

public ClickEvent(Component source,
                  MouseEventDetails mouseEventDetails)

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, Button#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 occured, 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 occured, 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 occured, 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 occured, false otherwise

getButtonName

public String getButtonName()

Returns a human readable string representing which button has been pushed. This is meant for debug purposes only and the string returned could change. Use getButton() to check which button was pressed.

Returns:

A string representation of which button was pushed.

Since:

6.3