Package VASSAL.build.module

Class MultiActionButton

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.ToolbarMenu

VASSAL.build.module.MultiActionButton

All Implemented Interfaces:

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

public class MultiActionButton
extends ToolbarMenu
implements RecursionLimiter.Loopable

Combines multiple buttons from the toolbar into a single button. Pushing the single button is equivalent to pushing the other buttons in order.

Author:

rkinney

Nested Class Summary

Nested classes/interfaces inherited from class VASSAL.build.AbstractToolbarItem

AbstractToolbarItem.FormattedStringConfig, AbstractToolbarItem.IconConfig

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

Fields inherited from class VASSAL.build.module.ToolbarMenu

BUTTON_HOTKEY, BUTTON_ICON, BUTTON_TEXT, buttonsToMenuMap, DESCRIPTION, HIDDEN_BY_TOOLBAR, launch, menu, MENU_ICON_PROPERTY, MENU_ITEMS, MENU_PROPERTY, menuBuilder, menuItems, toolbar, TOOLTIP

Fields inherited from class VASSAL.build.AbstractToolbarItem

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

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

Method Summary

Modifier and Type	Method	Description
String[]	getAttributeDescriptions()	This getAttributeDescriptions() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String	getComponentName()	Return the name of the trait or Component an Auditable is
String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is
static String	getConfigureTypeName()
HelpFile	getHelpFile()
void	launch()

Methods inherited from class VASSAL.build.module.ToolbarMenu

addTo, buildMenu, componentAdded, componentRemoved, getAllowableConfigureComponents, getAttributeNames, getAttributeTypes, getAttributeValueString, getMenuTextList, getRestoreCommand, propertyChange, removeFrom, scheduleBuildMenu, setAttribute, setup

Methods inherited from class VASSAL.build.AbstractToolbarItem

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

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

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

Methods inherited from class VASSAL.search.AbstractImageFinder

getAllImageNames, getLocalImageNames

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, isMandatory, isMovable, isUnique

Constructor Details

MultiActionButton

public MultiActionButton()

Method Details

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 ToolbarMenu

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

launch

public void launch()

Overrides:

launch in class ToolbarMenu

getConfigureTypeName

public static String getConfigureTypeName()

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Overrides:

getHelpFile in class ToolbarMenu

Returns:

a HelpFile describing how to use and configure * this component

getComponentName

public String getComponentName()

Description copied from interface: Auditable

Return the name of the trait or Component an Auditable is

Specified by:

getComponentName in interface Auditable

Returns:

Component name

getComponentTypeName

public String getComponentTypeName()

Description copied from interface: Auditable

Return a description of the Type of trait or Component an Auditable is

Specified by:

getComponentTypeName in interface Auditable

Returns:

Component Type