com.yworks.yfiles.view.input

Class PopulateMenuEventArgs

java.lang.Object

com.yworks.yfiles.view.input.InputModeEventArgs

com.yworks.yfiles.view.input.PopulateMenuEventArgs

All Implemented Interfaces:

IEventArgs

Direct Known Subclasses:

PopulateItemContextMenuEventArgs

public class PopulateMenuEventArgs
extends InputModeEventArgs

Event arguments for the PopulateMenu event.

Event handlers can modify the Menu accordingly and set ShowingMenuRequested to true. Setting ShowingMenuRequested to false will cause the event to be marked as Handled and no menu will be shown.

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
PopulateMenuEventArgs(IInputModeContext context, PointD queryLocation, Object menu, EventSource eventSource) Initializes a new instance of the PopulateMenuEventArgs class.

Method Summary

Modifier and Type	Method and Description
EventSource	getEventSource() Gets the source that triggered this event.
Object	getMenu() Gets the popup menu to populate.
PointD	getQueryLocation() Gets the queried location in world coordinates.
boolean	isHandled() Gets a value indicating whether this PopulateMenuEventArgs has been handled.
boolean	isShowingMenuRequested() Gets a value indicating whether to actually display the context menu.
void	setHandled(boolean value) Sets a value indicating whether this PopulateMenuEventArgs has been handled.
void	setShowingMenuRequested(boolean value) Sets a value indicating whether to actually display the context menu.

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

PopulateMenuEventArgs

public PopulateMenuEventArgs(IInputModeContext context,
                             PointD queryLocation,
                             Object menu,
                             EventSource eventSource)

Initializes a new instance of the PopulateMenuEventArgs class.

Parameters:

context - The context.

queryLocation - The query location.

menu - The context menu.

keyboardTriggered - Whether or not the request to display the context menu was caused by the keyboard.

Method Detail

getEventSource

public final EventSource getEventSource()

Gets the source that triggered this event.

Returns:

The EventSource.

getMenu

public final Object getMenu()

Gets the popup menu to populate. The implementation of com.yworks.yfiles.input.AbstractContextMenuInputMode used by com.yworks.yfiles.canvas.CanvasControl#getInputMode() specifies the type of the return value. By default an instance of ContextMenu is returned.

Returns:

The popup menu to populate.

getQueryLocation

public final PointD getQueryLocation()

Gets the queried location in world coordinates.

Returns:

The queried location.

isHandled

public final boolean isHandled()

Gets a value indicating whether this PopulateMenuEventArgs has been handled.

This property is automatically set to true if ShowingMenuRequested has been assigned a value. Marking this event as handled tells the issuer of the query whether the ShowingMenuRequested property should be used or whether additional logic should be used to determine whether to show the menu.

Returns:

true if handled; false otherwise.

See Also:

setHandled(boolean)

isShowingMenuRequested

public final boolean isShowingMenuRequested()

Gets a value indicating whether to actually display the context menu.

This will set the Handled property to true.

Returns:

true if the menu should be shown; false otherwise.

See Also:

setShowingMenuRequested(boolean)

setHandled

public final void setHandled(boolean value)

Sets a value indicating whether this PopulateMenuEventArgs has been handled.

This property is automatically set to true if ShowingMenuRequested has been assigned a value. Marking this event as handled tells the issuer of the query whether the ShowingMenuRequested property should be used or whether additional logic should be used to determine whether to show the menu.

Parameters:

value - true if handled; false otherwise.

See Also:

isHandled()

setShowingMenuRequested

public final void setShowingMenuRequested(boolean value)

Sets a value indicating whether to actually display the context menu.

This will set the Handled property to true.

Parameters:

value - true if the menu should be shown; false otherwise.

See Also:

isShowingMenuRequested()