Package VASSAL.build.module.map

Class MenuDisplayer

java.lang.Object

java.awt.event.MouseAdapter

VASSAL.build.module.map.MenuDisplayer

All Implemented Interfaces:

MouseListener, MouseMotionListener, MouseWheelListener, EventListener, Buildable

public class MenuDisplayer
extends MouseAdapter
implements Buildable

Field Summary

Fields

Modifier and Type	Field	Description
protected Map	map
static final Font	POPUP_MENU_FONT	Deprecated, for removal: This API element is subject to removal in a future version.
protected PieceFinder	targetSelector

Constructor Summary

Constructors

Constructor	Description
MenuDisplayer()

Method Summary

Modifier and Type	Method	Description
void	add(Buildable b)	Adds a child component.
void	addTo(Buildable b)	Adds this component to its parent.
void	build(Element e)	Build the object from the XML representation of the Buildable
static JPopupMenu	createPopup(GamePiece target)
static JPopupMenu	createPopup(GamePiece target, boolean global)
protected PieceFinder	createTargetSelector()	Return a PieceFinder instance that will select a GamePiece whose menu will be displayed when the user clicks on the map
Element	getBuildElement(Document doc)
protected static String	getMenuText(KeyCommand keyCommand)
boolean	isMandatory()	Is this component a reqired component within its parent?
boolean	isUnique()	Does this component need to be unique within it's parent?
protected static JMenuItem	makeMenuItem(KeyCommand keyCommand)
protected void	maybePopup(MouseEvent e)
protected void	maybePopup(MouseEvent e, boolean specialLaunchAllowed)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)

Methods inherited from class java.awt.event.MouseAdapter

mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mouseWheelMoved

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.build.Buildable

isMovable

Field Details

POPUP_MENU_FONT

@Deprecated(since="2022-08-08",
            forRemoval=true)
public static final Font POPUP_MENU_FONT

Deprecated, for removal: This API element is subject to removal in a future version.

map

protected Map map

targetSelector

protected PieceFinder targetSelector

Constructor Details

MenuDisplayer

public MenuDisplayer()

Method Details

addTo

public void addTo(Buildable b)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is responsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Specified by:

addTo in interface Buildable

Parameters:

b - parent Buildable to add this component to as a subcomponent.

createTargetSelector

protected PieceFinder createTargetSelector()

Return a PieceFinder instance that will select a GamePiece whose menu will be displayed when the user clicks on the map

Returns:

add

public void add(Buildable b)

Description copied from interface: Buildable

Adds a child component. Both this method and Buildable.addTo(VASSAL.build.Buildable) are invoked when adding a child to a parent

Specified by:

add in interface Buildable

Parameters:

b - Child to attach to this buildable as a subcomponent

getBuildElement

public Element getBuildElement(Document doc)

Specified by:

getBuildElement in interface Buildable

Parameters:

doc - XML file

Returns:

an XML element from which this component can be built

build

public void build(Element e)

Description copied from interface: Buildable

Build the object from the XML representation of the Buildable

Specified by:

build in interface Buildable

Parameters:

e - the XML element containing the object data

getMenuText

protected static String getMenuText(KeyCommand keyCommand)

makeMenuItem

protected static JMenuItem makeMenuItem(KeyCommand keyCommand)

createPopup

public static JPopupMenu createPopup(GamePiece target)

createPopup

public static JPopupMenu createPopup(GamePiece target,
 boolean global)

Parameters:

target -

global - If true, then apply the KeyCommands globally, i.e. to all selected pieces

Returns:

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class MouseAdapter

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class MouseAdapter

maybePopup

protected void maybePopup(MouseEvent e)

maybePopup

protected void maybePopup(MouseEvent e,
 boolean specialLaunchAllowed)

isMandatory

public boolean isMandatory()

Description copied from interface: Buildable

Is this component a reqired component within its parent?

Specified by:

isMandatory in interface Buildable

Returns:

true if component is mandatory

isUnique

public boolean isUnique()

Description copied from interface: Buildable

Does this component need to be unique within it's parent?

Specified by:

isUnique in interface Buildable

Returns: