Package VASSAL.build.module

Class ToolbarMenu

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.ToolbarMenu

All Implemented Interfaces:

ContainerListener, PropertyChangeListener, EventListener, AutoConfigurable, Buildable, Configurable, GameComponent, PropertyNameSource, ValidityChecker, Translatable

Direct Known Subclasses:

MultiActionButton

public class ToolbarMenu
extends AbstractConfigurable
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 interface VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	BUTTON_HOTKEY
static String	BUTTON_ICON
static String	BUTTON_TEXT
protected Map<AbstractButton,JMenuItem>	buttonsToMenuMap
static String	DESCRIPTION
static String	HIDDEN_BY_TOOLBAR
protected LaunchButton	launch
protected JPopupMenu	menu
static String	MENU_ITEMS
static 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 String	TOOLTIP

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ToolbarMenu()

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
protected void	buildMenu()
void	componentAdded(ContainerEvent e)
void	componentRemoved(ContainerEvent e)
Class<?>[]	getAllowableConfigureComponents()	Return a list of valid sub-component Classes.
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	Return the Class for the buildFile (XML) attributes of this component.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
static String	getConfigureTypeName()
HelpFile	getHelpFile()
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)
void	removeFrom(Buildable parent)	Remove this component from its parent
protected void	scheduleBuildMenu()
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate

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

build, getBuildElement

Field Details

BUTTON_TEXT

public static final String BUTTON_TEXT

See Also:

Constant Field Values

BUTTON_ICON

public static final String BUTTON_ICON

See Also:

Constant Field Values

BUTTON_HOTKEY

public static final String BUTTON_HOTKEY

See Also:

Constant Field Values

TOOLTIP

public static final String TOOLTIP

See Also:

Constant Field Values

MENU_ITEMS

public static final String MENU_ITEMS

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

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

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

protected LaunchButton launch

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 interface: AutoConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Specified by:

getAttributeDescriptions in class AbstractConfigurable

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: AbstractConfigurable

Return 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()

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

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

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from interface: AutoConfigurable

Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

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

Returns:

a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).

setAttribute

public void setAttribute(String key,
Object value)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.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

Specified by:

setAttribute in class AbstractBuildable

Parameters:

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

value - If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.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 interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is reponsible 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

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Description copied from interface: Configurable

Return 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 Configuration Window.

Specified by:

getAllowableConfigureComponents in interface Configurable

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFilte describing how to use and configure this component

getConfigureTypeName

public static String getConfigureTypeName()

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

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)

Specified by:

propertyChange in interface PropertyChangeListener

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

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