com.yworks.yfiles.view.input

Class ItemClickedEventArgs<T>

java.lang.Object

com.yworks.yfiles.utils.ItemEventArgs<T>

com.yworks.yfiles.view.input.ItemClickedEventArgs<T>

Type Parameters:

T - The type of the item this event carries.

All Implemented Interfaces:

IEventArgs

public class ItemClickedEventArgs<T>
extends ItemEventArgs<T>

Provides data for the ItemClicked, ItemDoubleClicked, ItemLeftClicked, ItemLeftDoubleClicked, ItemRightClicked and ItemRightDoubleClicked events.

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
ItemClickedEventArgs(T item, PointD location) Initializes a new instance of the ItemClickedEventArgs class.

Method Summary

Modifier and Type	Method and Description
PointD	getLocation() Gets the location of the click.
boolean	isHandled() Gets a value indicating whether this ItemClickedEventArgs is handled.
void	setHandled(boolean value) Sets a value indicating whether this ItemClickedEventArgs is handled.

Methods inherited from class com.yworks.yfiles.utils.ItemEventArgs

getItem

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemClickedEventArgs

public ItemClickedEventArgs(T item,
                            PointD location)

Initializes a new instance of the ItemClickedEventArgs class.

Parameters:

item - The item which is the subject of the event.

location - The location of the click.

Method Detail

getLocation

public final PointD getLocation()

Gets the location of the click.

Returns:

The Location.

isHandled

public final boolean isHandled()

Gets a value indicating whether this ItemClickedEventArgs is handled.

Setting the event to handled indicates whether the event should be further propagated or whether there has not been any code that actively handled the event to the event source. How this flag is actually being treated depends on the source of the event.

Returns:

The Handled.

See Also:

setHandled(boolean)

setHandled

public final void setHandled(boolean value)

Sets a value indicating whether this ItemClickedEventArgs is handled.

Setting the event to handled indicates whether the event should be further propagated or whether there has not been any code that actively handled the event to the event source. How this flag is actually being treated depends on the source of the event.

Parameters:

value - The Handled to set.

See Also:

isHandled()