Package VASSAL.tools

Class LaunchButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JButton

VASSAL.tools.LaunchButton

All Implemented Interfaces:

ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants, Auditable

public class LaunchButton
extends JButton
implements Auditable

A JButton for placing into a VASSAL component's toolbar. Handles configuration of a hotkey shortcut, maintains appropriate tooltip text, etc.

See Also:

• Serialized Form

Nested Class Summary

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

JButton.AccessibleJButton

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

AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener

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 boolean	allowExpression
protected boolean	alwaysAcceptKeystroke
protected boolean	forceInvisible
protected boolean	forceVisible
protected FormattedString	formatted
protected String	iconAtt
protected IconConfigurer	iconConfig
protected String	keyAtt
protected Configurer	keyConfig
protected NamedKeyStrokeListener	keyListener
protected String	nameAtt
protected Configurer	nameConfig
protected String	tooltipAtt
protected String	toolTipText
static final String	UNTRANSLATED_TEXT
protected boolean	usesExpression

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

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

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor	Description
LaunchButton(String text, String textAttribute, String hotkeyAttribute, ActionListener al)
LaunchButton(String text, String textAttribute, String hotkeyAttribute, String iconAttribute, ActionListener al)
LaunchButton(String text, String textAttribute, String hotkeyAttribute, String iconAttribute, ActionListener al, boolean allowExpression)
LaunchButton(String text, String tooltipAttribute, String textAttribute, String hotkeyAttribute, String iconAttribute, ActionListener al)
LaunchButton(String text, String tooltipAttribute, String textAttribute, String hotkeyAttribute, String iconAttribute, ActionListener al, boolean allowExpression)

Method Summary

Modifier and Type	Method	Description
void	checkVisibility()
String	getAttributeValueString(String key)
int	getBaseline(int width, int height)
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
String	getHotkeyAttribute()
Configurer	getHotkeyConfigurer()
String	getIconAttribute()
Icon	getLaunchIcon()
String	getNameAttribute()
Configurer	getNameConfigurer()
boolean	isAlwaysAcceptKeystroke()
boolean	isForceInvisible()
boolean	isForcevisible()
boolean	isNonBlank()
boolean	isUsesExpression()
void	setAlwaysAcceptKeystroke(boolean always)
void	setAttribute(String key, Object value)
void	setForceInvisible(boolean fiv)
void	setForceVisible(boolean fv)
void	setToolTipText(String text)
void	updateText()

Methods inherited from class javax.swing.JButton

getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, removeNotify, setDefaultCapable, updateUI

Methods inherited from class javax.swing.AbstractButton

actionPropertyChanged, addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

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, 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, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, 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, 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

UNTRANSLATED_TEXT

public static final String UNTRANSLATED_TEXT

See Also:

• Constant Field Values

tooltipAtt

protected String tooltipAtt

nameAtt

protected String nameAtt

keyAtt

protected String keyAtt

iconAtt

protected String iconAtt

iconConfig

protected IconConfigurer iconConfig

toolTipText

protected String toolTipText

keyListener

protected NamedKeyStrokeListener keyListener

nameConfig

protected Configurer nameConfig

keyConfig

protected Configurer keyConfig

alwaysAcceptKeystroke

protected boolean alwaysAcceptKeystroke

forceVisible

protected boolean forceVisible

forceInvisible

protected boolean forceInvisible

allowExpression

protected boolean allowExpression

usesExpression

protected boolean usesExpression

formatted

protected FormattedString formatted

Constructor Details

LaunchButton

public LaunchButton(String text,
 String textAttribute,
 String hotkeyAttribute,
 ActionListener al)

LaunchButton

public LaunchButton(String text,
 String tooltipAttribute,
 String textAttribute,
 String hotkeyAttribute,
 String iconAttribute,
 ActionListener al)

LaunchButton

public LaunchButton(String text,
 String textAttribute,
 String hotkeyAttribute,
 String iconAttribute,
 ActionListener al)

LaunchButton

public LaunchButton(String text,
 String tooltipAttribute,
 String textAttribute,
 String hotkeyAttribute,
 String iconAttribute,
 ActionListener al,
 boolean allowExpression)

LaunchButton

public LaunchButton(String text,
 String textAttribute,
 String hotkeyAttribute,
 String iconAttribute,
 ActionListener al,
 boolean allowExpression)

Method Details

isUsesExpression

public boolean isUsesExpression()

updateText

public void updateText()

getLaunchIcon

public Icon getLaunchIcon()

Returns:

Our current icon (used when we're a ToolbarMenu that's a submenu of another ToolbarMenu so that we keep our icon)

isAlwaysAcceptKeystroke

public boolean isAlwaysAcceptKeystroke()

setAlwaysAcceptKeystroke

public void setAlwaysAcceptKeystroke(boolean always)

isForcevisible

public boolean isForcevisible()

setForceVisible

public void setForceVisible(boolean fv)

isForceInvisible

public boolean isForceInvisible()

setForceInvisible

public void setForceInvisible(boolean fiv)

getBaseline

public int getBaseline(int width,
 int height)

Overrides:

getBaseline in class JComponent

getNameAttribute

public String getNameAttribute()

getHotkeyAttribute

public String getHotkeyAttribute()

getIconAttribute

public String getIconAttribute()

getAttributeValueString

public String getAttributeValueString(String key)

setAttribute

public void setAttribute(String key,
 Object value)

setToolTipText

public void setToolTipText(String text)

Overrides:

setToolTipText in class JComponent

getNameConfigurer

public Configurer getNameConfigurer()

getHotkeyConfigurer

public Configurer getHotkeyConfigurer()

isNonBlank

public boolean isNonBlank()

checkVisibility

public void checkVisibility()

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

getComponentName

public String getComponentName()

Return the name of the trait or Component an Auditable is

Specified by:

getComponentName in interface Auditable

Returns:

Component name