org.ka2ddo.yaac.pluginapi

Interface AddToPopupMapMenuIfc

All Known Implementing Classes:

AbstractPopupMenuAction

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface AddToPopupMapMenuIfc

This interface defines a decision interface identifying AbstractMenuActions that should not go on the main window menu bar, but instead on a popup menu displayed because someone right-clicked on a map or a table. The interface methods allow the menu construction code to decide if any given menu items should be included in the popup menu, based on context of the menu activation.

Author:

Andrew Pavlin, KA2DDO

See Also:

AbstractPopupMenuAction

Method Summary

Modifier and Type	Method and Description
boolean	testIfIncluded(int mouseX, int mouseY, com.bbn.openmap.proj.Projection p) When creating a popup menu for the map window, specify whether this menu item should be included in the menu.

Method Detail

testIfIncluded

boolean testIfIncluded(int mouseX,
                       int mouseY,
                       com.bbn.openmap.proj.Projection p)

When creating a popup menu for the map window, specify whether this menu item should be included in the menu.

Parameters:

mouseX - int screen pixel X coordinate where popup menu was invoked, or -1 for not map-invoked

mouseY - int screen pixel Y coordinate where popup menu was invoked, or -1 for not map-invoked

p - the current Projection that the map is being rendered with (null if the menu is being invoked on a window without a map)

Returns:

boolean true if the menu item should be included in the popup menu, false otherwise

See Also:

AbstractPopupMenuAction.matchList, AbstractPopupMenuAction.proj