com.yworks.yfiles.view.input

Class ClickEventArgs

java.lang.Object

com.yworks.yfiles.view.input.InputModeEventArgs

com.yworks.yfiles.view.input.ClickEventArgs

All Implemented Interfaces:

IEventArgs

public class ClickEventArgs
extends InputModeEventArgs

Event arguments used by Clicked.

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.IEventArgs

EMPTY

Constructor Summary

Constructors

Constructor and Description
ClickEventArgs(IInputModeContext context, PointD location, ModifierKeys modifiers, MouseButtons mouseButtons, int clickCount) Initializes a new instance of the ClickEventArgs class.

Method Summary

Modifier and Type	Method and Description
int	getClickCount() Gets the number of clicks associated with this event.
PointD	getLocation() Gets the location of the click.
ModifierKeys	getModifiers() Gets the state of the modifiers at the time of the click.
MouseButtons	getMouseButtons() Gets the MouseButtons that have changed for this event.
boolean	isHandled() Gets a value indicating whether this ClickEventArgs have been handled.
void	setHandled(boolean value) Sets a value indicating whether this ClickEventArgs have been handled.

Methods inherited from class com.yworks.yfiles.view.input.InputModeEventArgs

getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ClickEventArgs

public ClickEventArgs(IInputModeContext context,
                      PointD location,
                      ModifierKeys modifiers,
                      MouseButtons mouseButtons,
                      int clickCount)

Initializes a new instance of the ClickEventArgs class.

Parameters:

context - The context in which the click occurred.

location - The location.

modifiers - State of the modifiers.

mouseButtons - The mouse button(s) that have changed

Method Detail

getClickCount

public final int getClickCount()

Gets the number of clicks associated with this event.

This can be used to distinguish between single and multiple clicks. Note that for compatibility reasons, a negative value means that no click count has been provided at event creation time.

Returns:

The ClickCount.

getLocation

public final PointD getLocation()

Gets the location of the click.

Returns:

The location.

getModifiers

public final ModifierKeys getModifiers()

Gets the state of the modifiers at the time of the click.

Returns:

The state of the modifiers.

getMouseButtons

public final MouseButtons getMouseButtons()

Gets the MouseButtons that have changed for this event.

Returns:

The MouseButtons.

isHandled

public final boolean isHandled()

Gets a value indicating whether this ClickEventArgs have been handled.

Client code that is triggered by the event and does not want the event to become handled by other handles should set this property to true to stop propagation of the event.

Returns:

true if handled; false otherwise.

See Also:

setHandled(boolean)

setHandled

public final void setHandled(boolean value)

Sets a value indicating whether this ClickEventArgs have been handled.

Client code that is triggered by the event and does not want the event to become handled by other handles should set this property to true to stop propagation of the event.

Parameters:

value - true if handled; false otherwise.

See Also:

isHandled()