Class ToolbarMenu

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.ToolbarMenu

All Implemented Interfaces:

ContainerListener, PropertyChangeListener, EventListener, AutoConfigurable, Buildable, Configurable, GameComponent, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

Direct Known Subclasses:

MultiActionButton

public class ToolbarMenu
extends AbstractToolbarItem
implements ContainerListener, PropertyChangeListener, GameComponent

Takes buttons from the toolbar of a Map or the main module and places them into a popup menu

Author:

rkinney

Nested Class Summary

Nested classes/interfaces inherited from class AbstractToolbarItem

AbstractToolbarItem.FormattedStringConfig, AbstractToolbarItem.IconConfig

Modifier and Type	Class	Description
static class	AbstractToolbarItem.FormattedStringConfig
static class	AbstractToolbarItem.IconConfig	Configures the toolbar's button icon.

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Modifier and Type	Interface	Description
static class	AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUTTON_HOTKEY	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	BUTTON_ICON	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	BUTTON_TEXT	Deprecated, for removal: This API element is subject to removal in a future version.
protected Map<AbstractButton, JMenuItem>	buttonsToMenuMap
static final String	DESCRIPTION
static final String	HIDDEN_BY_TOOLBAR
protected LaunchButton	launch	Deprecated, for removal: This API element is subject to removal in a future version. use launch from the superclass
protected JPopupMenu	menu
static final String	MENU_ICON_PROPERTY
static final String	MENU_ITEMS
static final String	MENU_PROPERTY	Buttons where this property contains a JPopupMenu will turn into sub-menus
protected Runnable	menuBuilder
protected List<String>	menuItems
protected JToolBar	toolbar
static final String	TOOLTIP	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from class AbstractToolbarItem

CAN_DISABLE, canDisable, DISABLED_ICON, disabledIconConfig, HIDE_WHEN_DISABLED, hideWhenDisabled, HOTKEY, ICON, NAME, property, PROPERTY_GATE, propertyGate, showDisabledOptions

Modifier and Type	Field	Description
static final String	CAN_DISABLE
protected boolean	canDisable
static final String	DISABLED_ICON
protected IconConfigurer	disabledIconConfig
static final String	HIDE_WHEN_DISABLED
protected boolean	hideWhenDisabled
static final String	HOTKEY
static final String	ICON
static final String	NAME
protected MutableProperty.Impl	property
static final String	PROPERTY_GATE
protected String	propertyGate
protected boolean	showDisabledOptions

Fields inherited from class AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected Configurer	config
protected String	localizedName
protected ComponentI18nData	myI18nData
protected String	name

Fields inherited from class AbstractBuildable

buildComponents, validator

Modifier and Type	Field	Description
protected List<Buildable>	buildComponents
protected ValidityChecker	validator

Fields inherited from interface Configurable

NAME_PROPERTY

Modifier and Type	Field	Description
static final String	NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ToolbarMenu()

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Default behavior adds the button to the parent component
protected void	buildMenu()
void	componentAdded(ContainerEvent e)
void	componentRemoved(ContainerEvent e)
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	This getAttributeDescriptions() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String[]	getAttributeNames()	This getAttributeNames() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
Class<?>[]	getAttributeTypes()	This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String	getAttributeValueString(String key)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
static String	getConfigureTypeName()
HelpFile	getHelpFile()
List<String>	getMenuTextList()	SearchTarget
Command	getRestoreCommand()	When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
void	launch()
void	propertyChange(PropertyChangeEvent evt)	Listens to our disable-this-button property; enables/disables our button as appropriate when it changes
void	removeFrom(Buildable parent)	Remove from our parent
protected void	scheduleBuildMenu()
void	setAttribute(String key, Object value)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended

Methods inherited from class AbstractToolbarItem

addLocalImageNames, addPropertyGateListener, addPropertyGateListener, checkDisabled, disableIfTrue, getAttributeVisibility, getComponent, getLaunchButton, getNamedKeyStrokeList, getNameKey, getPropertyList, isShowDisabledOptions, makeLaunchButton, removePropertyGateListener, setButtonTextKey, setHotKeyKey, setIconKey, setLaunchButton, setNameKey, setNamePrompt, setShowDisabledOptions, setTooltipKey

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractBuildable should override this method in order to add the names of any image files they use to the collection.
protected void	addPropertyGateListener()
protected void	addPropertyGateListener(boolean dontCheck)	If we have a disable-this-button property, set a listener on it
void	checkDisabled()	Check our disable-this-button property and enable/disable our button as appropriate based on its value
void	disableIfTrue(boolean disable)
VisibilityCondition	getAttributeVisibility(String key)	By default, all attributes are visible
protected Component	getComponent()	The component to be added to the control window toolbar
LaunchButton	getLaunchButton()
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
protected String	getNameKey()
List<String>	getPropertyList()	SearchTarget
boolean	isShowDisabledOptions()
protected LaunchButton	makeLaunchButton(String tooltip, String button_text, String iconFile, ActionListener action)	Create a standard toolbar launcher button for this item
protected void	removePropertyGateListener()	Remove any existing disable-this-button property
protected void	setButtonTextKey(String buttonTextKey)
protected void	setHotKeyKey(String hotKeyKey)
protected void	setIconKey(String iconKey)
protected void	setLaunchButton(LaunchButton launch)	Sets launch button for this toolbar item
protected void	setNameKey(String nameKey)
protected void	setNamePrompt(String namePrompt)
protected void	setShowDisabledOptions(boolean show)
protected void	setTooltipKey(String tooltipKey)

Methods inherited from class AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Modifier and Type	Method	Description
void	add(Buildable b)	Set the owning translatable of this component
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
Configurable[]	getConfigureComponents()
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
ComponentI18nData	getI18nData()
protected String	getI18nPrefix()
String	getLocalizedConfigureName()
String	getTypeName()	Returns the name of the configurable type for display purposes.
void	remove(Buildable b)	Remove a Buildable object from this object
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	setAllAttributesUntranslatable()	Sets all attributes untranslatable.
protected void	setAttributeTranslatable(String attr, boolean b)	Over-ride the default attribute translatability.
void	setConfigureName(String s)	Sets the name and fires a PropertyChangeEvent

Methods inherited from class AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, validate

Modifier and Type	Method	Description
void	addImageNamesRecursively(Collection<String> s)	Adds all images used by this component AND any subcomponents to the collection
void	build(Element e)	Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(String, Object) with the String value of the attribute
String	buildString()
<T> List<T>	getAllDescendantComponentsOf(Class<T> target)	Recursively descend the build tree and return a List of all components that are instances of the given class
Buildable	getAncestor()
List<Buildable>	getBuildables()
Enumeration<Buildable>	getBuildComponents()	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getBuildables() instead.
Element	getBuildElement(Document doc)
<T> Enumeration<T>	getComponents(Class<T> target)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getComponentsOf(Class) instead.
<T> List<T>	getComponentsOf(Class<T> target)
Buildable	getNonFolderAncestor()
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
void	setAncestor(Buildable ancestor)
void	validate(Buildable target, ValidationReport report)

Methods inherited from class AbstractImageFinder

getAllImageNames, getLocalImageNames

Modifier and Type	Method	Description
SortedSet<String>	getAllImageNames()
SortedSet<String>	getLocalImageNames()

Methods inherited from class Object

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

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Modifier and Type	Method	Description
default String	getComponentName()	Return the name of the trait or Component an Auditable is
default String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

Methods inherited from interface Buildable

isMandatory, isMovable, isUnique

Modifier and Type	Method	Description
default boolean	isMandatory()	Is this component a reqired component within its parent?
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?
default boolean	isUnique()	Does this component need to be unique within it's parent?

Field Details

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

BUTTON_TEXT

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String BUTTON_TEXT

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

See Also:

• Constant Field Values

BUTTON_ICON

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String BUTTON_ICON

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

See Also:

• Constant Field Values

BUTTON_HOTKEY

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String BUTTON_HOTKEY

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

See Also:

• Constant Field Values

TOOLTIP

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String TOOLTIP

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

See Also:

• Constant Field Values

MENU_ITEMS

public static final String MENU_ITEMS

See Also:

• Constant Field Values

MENU_PROPERTY

public static final String MENU_PROPERTY

Buttons where this property contains a JPopupMenu will turn into sub-menus

See Also:

• Constant Field Values

MENU_ICON_PROPERTY

public static final String MENU_ICON_PROPERTY

See Also:

• Constant Field Values

HIDDEN_BY_TOOLBAR

public static final String HIDDEN_BY_TOOLBAR

See Also:

• Constant Field Values

menuItems

protected List<String> menuItems

buttonsToMenuMap

protected Map<AbstractButton, JMenuItem> buttonsToMenuMap

launch

@Deprecated(since="2021-04-03",
            forRemoval=true)
protected LaunchButton launch

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

use launch from the superclass

toolbar

protected JToolBar toolbar

menu

protected JPopupMenu menu

menuBuilder

protected Runnable menuBuilder

Constructor Details

ToolbarMenu

public ToolbarMenu()

Method Details

launch

public void launch()

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from class: AbstractToolbarItem

This getAttributeDescriptions() will return the items specific to the Toolbar Button - classes extending this should add their own items as well. If the "nameKey" is blank, then no "name" configure entry will be generated. Extending classes can use ArrayUtils.addAll(super.getAttributeDescriptions(), key1, ..., keyN), or supply their own order from scratch.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Overrides:

getAttributeDescriptions in class AbstractToolbarItem

Returns:

an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from class: AbstractToolbarItem

This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well. If the "nameKey" is blank, then no "name" configure entry will be generated. Extending classes can use ArrayUtils.addAll(super.getAttributeTypes(), key1, ..., keyN), or supply their own order from scratch.

Specified by:

getAttributeTypes in interface AutoConfigurable

Overrides:

getAttributeTypes in class AbstractToolbarItem

Returns:

the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor.

The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractToolbarItem

This getAttributeNames() will return the items specific to the Toolbar Button - classes extending this should add their own items as well. If the "nameKey" is blank, then no "name" configure entry will be generated. Extending classes can use ArrayUtils.addAll(super.getAttributeNames(), key1, ..., keyN), or supply their own order from scratch.

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in interface AutoConfigurable

Overrides:

getAttributeNames in class AbstractToolbarItem

Returns:

an array of all buildFile (XML) attribute names for this component

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from class: AbstractToolbarItem

Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Overrides:

getAttributeValueString in class AbstractToolbarItem

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractToolbarItem.getAttributeNames()

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractToolbarItem.setAttribute(String, Object). It is also frequently used for checking the current value of an attribute.

setAttribute

public void setAttribute(String key,
 Object value)

Description copied from class: AbstractToolbarItem

Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.

Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractToolbarItem.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractToolbarItem.getAttributeValueString(String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

Specified by:

setAttribute in interface AutoConfigurable

Specified by:

setAttribute in interface Translatable

Overrides:

setAttribute in class AbstractToolbarItem

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractToolbarItem.getAttributeNames()

value - If the value parameter is a String, it will be the value returned by AbstractToolbarItem.getAttributeValueString(String) for the same key. If the implementing class extends AbstractConfigurable, then value can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

addTo

public void addTo(Buildable parent)

Description copied from class: AbstractToolbarItem

Default behavior adds the button to the parent component

Specified by:

addTo in interface Buildable

Overrides:

addTo in class AbstractToolbarItem

Parameters:

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

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

Returns:

a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

getConfigureTypeName

public static String getConfigureTypeName()

removeFrom

public void removeFrom(Buildable parent)

Description copied from class: AbstractToolbarItem

Remove from our parent

Specified by:

removeFrom in interface Configurable

Overrides:

removeFrom in class AbstractToolbarItem

Parameters:

parent - parent

buildMenu

protected void buildMenu()

scheduleBuildMenu

protected void scheduleBuildMenu()

componentAdded

public void componentAdded(ContainerEvent e)

Specified by:

componentAdded in interface ContainerListener

componentRemoved

public void componentRemoved(ContainerEvent e)

Specified by:

componentRemoved in interface ContainerListener

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Description copied from class: AbstractToolbarItem

Listens to our disable-this-button property; enables/disables our button as appropriate when it changes

Specified by:

propertyChange in interface PropertyChangeListener

Overrides:

propertyChange in class AbstractToolbarItem

Parameters:

evt - property change event

setup

public void setup(boolean gameStarting)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

Specified by:

setup in interface GameComponent

Overrides:

setup in class AbstractToolbarItem

Parameters:

gameStarting - if true, a game is starting. If false, then a game is ending

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null

Specified by:

getRestoreCommand in interface GameComponent

Overrides:

getRestoreCommand in class AbstractToolbarItem

getMenuTextList

public List<String> getMenuTextList()

SearchTarget

Specified by:

getMenuTextList in interface SearchTarget

Overrides:

getMenuTextList in class AbstractToolbarItem

Returns:

a list of any Menu/Button/Tooltip Text strings referenced in the Configurable, if any (for search)