de.cismet.cismap.commons.gui

Interface MapPopupAction

All Superinterfaces:

Action, ActionListener, Comparable<MapPopupAction>, EventListener

All Known Implementing Classes:

AbstractMapPopupAction

public interface MapPopupAction
extends Action, Comparable<MapPopupAction>

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

martin.scholl@cismet.de

Field Summary

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Method Summary

Modifier and Type	Method and Description
com.vividsolutions.jts.geom.Point	getPoint() Returns the Point where the action was triggered.
int	getPosition() Returns the desired position in the popup menu.
JMenu	getSubmenu() In some cases it's preferred to show a whole menu in the upcoming popup menu and not only one single menu item.
boolean	isActive(boolean featuresSubjacent) The action may decide whether it shall be shown in the upcoming popup menu or not.
void	setPoint(com.vividsolutions.jts.geom.Point point) Setter for the Point where the action will be triggered.

Methods inherited from interface javax.swing.Action

addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getPoint

com.vividsolutions.jts.geom.Point getPoint()

Returns the Point where the action was triggered.

Returns:

the point where the action was triggered

setPoint

void setPoint(com.vividsolutions.jts.geom.Point point)

Setter for the Point where the action will be triggered.

Parameters:

point - the point where the action will be triggered

getPosition

int getPosition()

Returns the desired position in the popup menu.

Returns:

an integer

isActive

boolean isActive(boolean featuresSubjacent)

The action may decide whether it shall be shown in the upcoming popup menu or not.

Parameters:

featuresSubjacent - true, if the action popup menu was triggered over a feature, false otherwise

Returns:

true, if the action shall be displayed, false otherwise

getSubmenu

JMenu getSubmenu()

In some cases it's preferred to show a whole menu in the upcoming popup menu and not only one single menu item. If this method returns a JMenu object, it will be added to the popup menu instead of the MapPopupAction instance.

Returns:

The menu to be shown in the upcoming popup menu.