de.cismet.cismap.commons.gui

Class AbstractMapPopupAction

java.lang.Object

javax.swing.AbstractAction

de.cismet.cismap.commons.gui.AbstractMapPopupAction

All Implemented Interfaces:

MapPopupAction, ActionListener, Serializable, Cloneable, Comparable<MapPopupAction>, EventListener, Action

public abstract class AbstractMapPopupAction
extends AbstractAction
implements MapPopupAction

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

martin.scholl@cismet.de

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

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

Constructor Summary

Constructors

Constructor and Description
AbstractMapPopupAction() Creates a new AbstractMapPopupAction object.
AbstractMapPopupAction(String name) Creates a new AbstractMapPopupAction object.

Method Summary

Modifier and Type	Method and Description
int	compareTo(MapPopupAction other) Comparison based on the MapPopupAction.getPosition() operation.
com.vividsolutions.jts.geom.Point	getPoint() Returns the Point where the action was triggered.
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 class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.cismet.cismap.commons.gui.MapPopupAction

getPosition

Methods inherited from interface javax.swing.Action

addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Constructor Detail

AbstractMapPopupAction

public AbstractMapPopupAction()

Creates a new AbstractMapPopupAction object.

AbstractMapPopupAction

public AbstractMapPopupAction(String name)

Creates a new AbstractMapPopupAction object.

Parameters:

name - DOCUMENT ME!

Method Detail

getPoint

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

Description copied from interface: MapPopupAction

Returns the Point where the action was triggered.

Specified by:

getPoint in interface MapPopupAction

Returns:

the point where the action was triggered

setPoint

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

Description copied from interface: MapPopupAction

Setter for the Point where the action will be triggered.

Specified by:

setPoint in interface MapPopupAction

Parameters:

point - the point where the action will be triggered

isActive

public boolean isActive(boolean featuresSubjacent)

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

NOTE:By default this implementation returns true if there is no subjacent feature, false otherwise.

Specified by:

isActive in interface MapPopupAction

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

compareTo

public int compareTo(MapPopupAction other)

Comparison based on the MapPopupAction.getPosition() operation.

Specified by:

compareTo in interface Comparable<MapPopupAction>

Parameters:

other - the other object

Returns:

a negative integer if this object shall be above the given object, a positive integer if this object shall be below the given object or 0 if the relative position to each other cannot be determined/does not matter.

getSubmenu

public JMenu getSubmenu()

Description copied from interface: MapPopupAction

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.

Specified by:

getSubmenu in interface MapPopupAction

Returns:

The menu to be shown in the upcoming popup menu.