journeymap.api.v2.client.event

Class PopupMenuEvent

java.lang.Object

journeymap.api.v2.common.event.impl.JourneyMapEvent

journeymap.api.v2.client.event.ClientEvent

journeymap.api.v2.client.event.PopupMenuEvent

Direct Known Subclasses:

PopupMenuEvent.FullscreenPopupMenuEvent, PopupMenuEvent.WaypointPopupMenuEvent

public class PopupMenuEvent
extends ClientEvent

This event is used for adding items to the right click menu on the fullscreen map. It is fired when a user right-clicks on the fullscreen map before drawing the popup menu. This event is not cancellable, when cancelled no popup will appear on right click.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PopupMenuEvent.FullscreenPopupMenuEvent This event is fired when a user right clicks anywhere on the fullscreen map that is not an overlay or waypoint.
static class	PopupMenuEvent.Layer
static class	PopupMenuEvent.WaypointPopupMenuEvent This event is fired when a user right-clicks on a waypoint icon.

Field Summary

Fields inherited from class journeymap.api.v2.client.event.ClientEvent

dimension

Fields inherited from class journeymap.api.v2.common.event.impl.JourneyMapEvent

timestamp

Constructor Summary

Constructors

Constructor and Description
PopupMenuEvent(ModPopupMenu popupMenu, PopupMenuEvent.Layer layer, IFullscreen fullscreen) This event is used for adding items to the right click menu on the fullscreen map.

Method Summary

Modifier and Type	Method and Description
IFullscreen	getFullscreen()
PopupMenuEvent.Layer	getLayer()
ModPopupMenu	getPopupMenu()

Methods inherited from class journeymap.api.v2.common.event.impl.JourneyMapEvent

cancel, isCancellable, isCancelled

Methods inherited from class java.lang.Object

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

Constructor Detail

PopupMenuEvent

public PopupMenuEvent(ModPopupMenu popupMenu,
                      PopupMenuEvent.Layer layer,
                      IFullscreen fullscreen)

This event is used for adding items to the right click menu on the fullscreen map. It is fired when a user right-clicks on the fullscreen map before drawing the popup menu. This event is cancellable.

Parameters:

popupMenu - - The menu builder.

layer - - The mapping layer which fired the event.

fullscreen - - The fullscreen hook.

Method Detail

getPopupMenu

public ModPopupMenu getPopupMenu()

getLayer

public PopupMenuEvent.Layer getLayer()

getFullscreen

public IFullscreen getFullscreen()