Class BeanShellFunctionMenu

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPopupMenu

VASSAL.configure.BeanShellFunctionMenu

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, MenuElement

public class BeanShellFunctionMenu
extends JPopupMenu

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPopupMenu

JPopupMenu.AccessibleJPopupMenu, JPopupMenu.Separator

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String[]	ATTACHMENT_INDEX_HINTS
protected static final String[]	AUDIT_OPTION_HINTS
static final String	COMMENT
protected BeanShellExpressionConfigurer	configurer
protected static final String[]	GENERAL_PME_HINTS
protected static int	maxScrollItems
protected Map	menuMap	Create a menu of Global Properties recorded in this module, based on the module build structure
protected Zone	menuZone
protected static final String[]	NAME_HINTS
protected static final String[]	NAME_PME_HINTS
protected static final String[]	NO_HINTS
protected static final String[]	SUM_COUNT_HINTS
protected static final String[]	SUM_COUNT_MAP_HINTS
protected EditablePiece	target

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
BeanShellFunctionMenu(EditablePiece target, BeanShellExpressionConfigurer configurer)

Method Summary

Modifier and Type	Method	Description
protected void	addFunction(JMenu menu, String op, String desc, String[] parms, String parmInfo)
protected void	addFunction(JMenu menu, String op, String desc, String[] parms, String parmInfo, String[] hints)
protected void	addFunction(JMenu menu, String op, String desc, String[] parms, String parmInfo, String[] hints, BeanShellExpressionConfigurer.Option[] options)
protected void	addGenericPiecePropMenu(JMenu menu)	Create a menu of Generic Piece properties applicable to any piece Include properties for all possible traits.
protected void	addOperator(JMenu menu, String op, String desc)
protected void	addPieceProps(JMenu menu, EditablePiece piece)	Added the property names from an Editable Piece into their own menu
protected void	addProp(JMenu menu, String propName, VASSAL.configure.BeanShellFunctionMenu.PropertyType propertyType)	Add straight property name to a menu
protected void	addSeparator(JMenu menu)
protected void	buildBoolean(boolean b)
protected void	buildFunction(String op, String desc, String[] parmDesc, String[] hints, BeanShellExpressionConfigurer.Option[] options)
protected void	buildGlobalMenu(JMenu parentMenu, AbstractBuildable target, boolean useParentMenu)
protected void	buildInteger()
protected void	buildString()
protected String	getActionName(String propName)
protected String	getActionName(String propName, boolean zoneCurrentMapOverride)
protected int	getMaxScrollItems()
protected void	insertMenuItem(JMenu menu, String name, JMenuItem item)
protected boolean	isPieceContext()	Do we include piece-specific functions in the Function Menu?
protected boolean	requiresGenericPiecePropertyMenu()	Does this builder need a Generic piece property menu added to the drop-down.

Methods inherited from class javax.swing.JPopupMenu

add, add, add, addMenuKeyListener, addPopupMenuListener, addSeparator, createActionChangeListener, createActionComponent, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getComponent, getComponentAtIndex, getComponentIndex, getDefaultLightWeightPopupEnabled, getInvoker, getLabel, getMargin, getMenuKeyListeners, getPopupMenuListeners, getSelectionModel, getSubElements, getUI, getUIClassID, insert, insert, isBorderPainted, isLightWeightPopupEnabled, isPopupTrigger, isVisible, menuSelectionChanged, pack, paintBorder, paramString, processFocusEvent, processKeyEvent, processKeyEvent, processMouseEvent, remove, removeMenuKeyListener, removePopupMenuListener, setBorderPainted, setDefaultLightWeightPopupEnabled, setInvoker, setLabel, setLightWeightPopupEnabled, setLocation, setPopupSize, setPopupSize, setSelected, setSelectionModel, setUI, setVisible, show, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Details

COMMENT

public static final String COMMENT

See Also:

• Constant Field Values

NO_HINTS

protected static final String[] NO_HINTS

GENERAL_PME_HINTS

protected static final String[] GENERAL_PME_HINTS

SUM_COUNT_HINTS

protected static final String[] SUM_COUNT_HINTS

SUM_COUNT_MAP_HINTS

protected static final String[] SUM_COUNT_MAP_HINTS

AUDIT_OPTION_HINTS

protected static final String[] AUDIT_OPTION_HINTS

ATTACHMENT_INDEX_HINTS

protected static final String[] ATTACHMENT_INDEX_HINTS

NAME_HINTS

protected static final String[] NAME_HINTS

NAME_PME_HINTS

protected static final String[] NAME_PME_HINTS

maxScrollItems

protected static int maxScrollItems

configurer

protected BeanShellExpressionConfigurer configurer

target

protected EditablePiece target

menuMap

protected Map menuMap

Create a menu of Global Properties recorded in this module, based on the module build structure

menuZone

protected Zone menuZone

Constructor Details

BeanShellFunctionMenu

public BeanShellFunctionMenu(EditablePiece target,
 BeanShellExpressionConfigurer configurer)

Method Details

addFunction

protected void addFunction(JMenu menu,
 String op,
 String desc,
 String[] parms,
 String parmInfo)

addFunction

protected void addFunction(JMenu menu,
 String op,
 String desc,
 String[] parms,
 String parmInfo,
 String[] hints)

addFunction

protected void addFunction(JMenu menu,
 String op,
 String desc,
 String[] parms,
 String parmInfo,
 String[] hints,
 BeanShellExpressionConfigurer.Option[] options)

addSeparator

protected void addSeparator(JMenu menu)

buildFunction

protected void buildFunction(String op,
 String desc,
 String[] parmDesc,
 String[] hints,
 BeanShellExpressionConfigurer.Option[] options)

buildInteger

protected void buildInteger()

buildString

protected void buildString()

buildBoolean

protected void buildBoolean(boolean b)

addOperator

protected void addOperator(JMenu menu,
 String op,
 String desc)

addProp

protected void addProp(JMenu menu,
 String propName,
 VASSAL.configure.BeanShellFunctionMenu.PropertyType propertyType)

Add straight property name to a menu

Parameters:

menu - parent menu

propName - property name to add

insertMenuItem

protected void insertMenuItem(JMenu menu,
 String name,
 JMenuItem item)

getActionName

protected String getActionName(String propName)

getActionName

protected String getActionName(String propName,
 boolean zoneCurrentMapOverride)

addPieceProps

protected void addPieceProps(JMenu menu,
 EditablePiece piece)

Added the property names from an Editable Piece into their own menu

Parameters:

menu - parent menu

piece - Piece containing property names

addGenericPiecePropMenu

protected void addGenericPiecePropMenu(JMenu menu)

Create a menu of Generic Piece properties applicable to any piece Include properties for all possible traits. provide placeholder names for variably named properties

Parameters:

menu -

buildGlobalMenu

protected void buildGlobalMenu(JMenu parentMenu,
 AbstractBuildable target,
 boolean useParentMenu)

getMaxScrollItems

protected int getMaxScrollItems()

isPieceContext

protected boolean isPieceContext()

Do we include piece-specific functions in the Function Menu? Only if a) An EditablePiece has been supplied as the target OR b) The calling BeanShellExpressionConfigurer is for a Property Match Expression (since PME get executed on Pieces)

Returns:

true if we show piece specific functions

requiresGenericPiecePropertyMenu

protected boolean requiresGenericPiecePropertyMenu()

Does this builder need a Generic piece property menu added to the drop-down. Needed when we are building an expression on a Piece that is not currently being edited - Needed for all PME's - Needed if the context level is PIECE, but we are not currently editing a piece

Returns:

true if a generic piece property Menu is required