com.yworks.yfiles.view.input

Class ContextMenuInputMode

java.lang.Object

com.yworks.yfiles.view.input.AbstractContextMenuInputMode<ContextMenu>

com.yworks.yfiles.view.input.ContextMenuInputMode

All Implemented Interfaces:

IInputMode

public class ContextMenuInputMode
extends AbstractContextMenuInputMode<ContextMenu>

The default implementation of AbstractContextMenuInputMode interface that will display a ContextMenu when the user right clicks on the com.yworks.yfiles.canvas.CanvasControl or presses the menu key.

Constructor Summary

Constructors

Constructor and Description
ContextMenuInputMode() Creates a new instance with no initial popup menu.
ContextMenuInputMode(ContextMenu menu) Creates a new instance using the provided menu.

Method Summary

Modifier and Type	Method and Description
protected void	clearMenu(ContextMenu contextMenu) Clears all items of the given popup menu.
protected ContextMenu	createMenu() Creates a new instance of the popup menu.
protected void	hideMenu(ContextMenu contextMenu) Hides the given popup menu.
protected boolean	isMenuEmpty(ContextMenu contextMenu) Indicates whether the given popup menu does not have any items.
protected void	setMenuClosedCallback(ContextMenu contextMenu, Runnable menuClosedCallback) Defines or removes a function to be called when the given popup menu has been closed.
protected void	showMenu(ContextMenu contextMenu, PointD viewLocation) Shows the given popup menu at the given location in view coordinates.

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

addPopulateMenuListener, cancel, createPopulateMenuContext, getController, getInputModeContext, getMenu, getPriority, getValidMenuLocationHitTestable, install, isEnabled, isExclusive, isMenuClearingEnabled, onCanceled, onConcurrencyControllerActivated, onConcurrencyControllerDeactivated, onPopulateMenu, onPopulateMenu, onStopped, removePopulateMenuListener, setEnabled, setExclusive, setMenu, setMenuClearingEnabled, setPriority, setValidMenuLocationHitTestable, stop, uninstall

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextMenuInputMode

public ContextMenuInputMode()

Creates a new instance with no initial popup menu.

See Also:

AbstractContextMenuInputMode.createMenu(), AbstractContextMenuInputMode.getMenu()

ContextMenuInputMode

public ContextMenuInputMode(ContextMenu menu)

Creates a new instance using the provided menu.

Parameters:

menu - The menu to show.

Method Detail

clearMenu

protected void clearMenu(ContextMenu contextMenu)

Description copied from class: AbstractContextMenuInputMode

Clears all items of the given popup menu.

Subclasses have to implement this method for the given framework specific popup menu instance that has been created by AbstractContextMenuInputMode.createMenu(). Whenever yFiles framework needs to clear a popup menu and AbstractContextMenuInputMode.isMenuClearingEnabled() returns true this method for GUI framework specific removal of menu items is called.

Specified by:

clearMenu in class AbstractContextMenuInputMode<ContextMenu>

Parameters:

contextMenu - the framework specific popup menu to remove the items from

createMenu

protected ContextMenu createMenu()

Description copied from class: AbstractContextMenuInputMode

Creates a new instance of the popup menu.

Subclasses have to create the framework specific popup menu instance here. The other abstract methods of this class need to be able to handle popup menu instances created by this method.

Specified by:

createMenu in class AbstractContextMenuInputMode<ContextMenu>

Returns:

a new instance of the popup menu

See Also:

AbstractContextMenuInputMode.showMenu(Object, com.yworks.yfiles.geometry.PointD), AbstractContextMenuInputMode.hideMenu(Object), AbstractContextMenuInputMode.clearMenu(Object), AbstractContextMenuInputMode.isMenuEmpty(Object)

hideMenu

protected void hideMenu(ContextMenu contextMenu)

Description copied from class: AbstractContextMenuInputMode

Hides the given popup menu.

Subclasses have to implement this method for the given framework specific popup menu instance that has been created by AbstractContextMenuInputMode.createMenu(). Whenever yFiles framework needs to hide a popup menu this method for GUI framework specific hiding of popup menus is called.

Specified by:

hideMenu in class AbstractContextMenuInputMode<ContextMenu>

Parameters:

contextMenu - the framework specific popup menu to hide

isMenuEmpty

protected boolean isMenuEmpty(ContextMenu contextMenu)

Description copied from class: AbstractContextMenuInputMode

Indicates whether the given popup menu does not have any items.

Subclasses have to implement this method for the given framework specific popup menu instance that has been created by AbstractContextMenuInputMode.createMenu(). Whenever yFiles input framework needs to know if a popup menu does not have any items this method for GUI framework specific query is called.

Specified by:

isMenuEmpty in class AbstractContextMenuInputMode<ContextMenu>

Parameters:

contextMenu - the framework specific popup menu to to check for items

Returns:

true if the given popup menu does not have any items; false otherwise

setMenuClosedCallback

protected void setMenuClosedCallback(ContextMenu contextMenu,
                                     Runnable menuClosedCallback)

Description copied from class: AbstractContextMenuInputMode

Defines or removes a function to be called when the given popup menu has been closed.

Subclasses have to implement this method for the given framework specific popup menu instance that has been created by AbstractContextMenuInputMode.createMenu(). The yFiles framework calls this method to define a function that should be called when the given popup menu has been closed. If the menuClosedCallback is null, then a former defined function should no longer be called.

Specified by:

setMenuClosedCallback in class AbstractContextMenuInputMode<ContextMenu>

Parameters:

contextMenu - the framework specific popup menu to set the callback for

menuClosedCallback - the function to be called when the popup menu has been closed or null if a former defined function should no longer be called.

showMenu

protected void showMenu(ContextMenu contextMenu,
                        PointD viewLocation)

Description copied from class: AbstractContextMenuInputMode

Shows the given popup menu at the given location in view coordinates.

Subclasses have to implement this method for the given framework specific popup menu instance that has been created by AbstractContextMenuInputMode.createMenu(). Whenever yFiles framework requires a popup menu this method for GUI framework specific display of popup menus is called.

Specified by:

showMenu in class AbstractContextMenuInputMode<ContextMenu>

Parameters:

contextMenu - the framework specific popup menu to show

viewLocation - the location in view coordinates where to show the popup menu