Package VASSAL.build.module.map

Class HidePiecesButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

VASSAL.build.module.map.HidePiecesButton

All Implemented Interfaces:

MouseListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, AutoConfigurable, Buildable, Configurable, GameComponent, Drawable, Translatable, ImageSearchTarget, SearchTarget

public class HidePiecesButton
extends JPanel
implements MouseListener, AutoConfigurable, GameComponent, Drawable, SearchTarget, ImageSearchTarget

This removes all game pieces from the (@link Map) therefore providing an un-cluttered view.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HidePiecesButton.HiddenIconConfig
static class	HidePiecesButton.ShowingIconConfig

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

JPanel.AccessibleJPanel

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

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUTTON_TEXT
static final String	DEFAULT_HIDDEN_ICON
static final String	DEFAULT_SHOWING_ICON
static final String	HIDDEN_ICON
protected String	hiddenIcon
static final String	HOTKEY
protected LaunchButton	launch
static final String	LAUNCH_ICON
protected Map	map
protected ComponentI18nData	myI18nData
protected boolean	piecesVisible
static final String	SHOWING_ICON
protected String	showingIcon
static final String	TOOLTIP

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 VASSAL.build.Configurable

NAME_PROPERTY

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
HidePiecesButton()

Method Summary

Modifier and Type	Method	Description
void	add(Buildable b)	Adds a child component.
void	addImageNamesRecursively(Collection<String> s)	Adds all images used by this component AND any children (or inner decorators/pieces) to the collection.
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.
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
void	addTo(Buildable b)	Expects to be added to a Map.
void	build(Element e)	Build the object from the XML representation of the Buildable
void	draw(Graphics g, Map m)
boolean	drawAboveCounters()
SortedSet<String>	getAllImageNames()
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
VisibilityCondition	getAttributeVisibility(String name)	Because attributes are not always applicable in all cases, this method returns an interface to determine when the controls for specifying the named attribute should be visible.
Element	getBuildElement(Document doc)
Configurable[]	getConfigureComponents()
String	getConfigureName()	The name of this Configurable Object
Configurer	getConfigurer()
static String	getConfigureTypeName()
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
HelpFile	getHelpFile()
ComponentI18nData	getI18nData()
SortedSet<String>	getLocalImageNames()
List<String>	getMenuTextList()	SearchTarget
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
List<String>	getPropertyList()	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
String	getToolTipText(MouseEvent e)
void	mouseClicked(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	paint(Graphics g)
void	remove(Buildable b)	Remove a child component
void	removeFrom(Buildable b)	Remove this component from its parent
void	setAttribute(String key, Object value)	Called by the Buildable.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute.
protected void	setPiecesVisible(boolean visible)
void	setup(boolean show)	Notify the GameComponent that a game has started/ended

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, 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, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, 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, 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

Methods inherited from interface VASSAL.build.Buildable

isMandatory, isMovable, isUnique

Field Details

piecesVisible

protected boolean piecesVisible

map

protected Map map

launch

protected LaunchButton launch

showingIcon

protected String showingIcon

hiddenIcon

protected String hiddenIcon

myI18nData

protected ComponentI18nData myI18nData

DEFAULT_SHOWING_ICON

public static final String DEFAULT_SHOWING_ICON

See Also:

• Constant Field Values

DEFAULT_HIDDEN_ICON

public static final String DEFAULT_HIDDEN_ICON

See Also:

• Constant Field Values

LAUNCH_ICON

public static final String LAUNCH_ICON

See Also:

• Constant Field Values

TOOLTIP

public static final String TOOLTIP

See Also:

• Constant Field Values

BUTTON_TEXT

public static final String BUTTON_TEXT

See Also:

• Constant Field Values

HOTKEY

public static final String HOTKEY

See Also:

• Constant Field Values

HIDDEN_ICON

public static final String HIDDEN_ICON

See Also:

• Constant Field Values

SHOWING_ICON

public static final String SHOWING_ICON

See Also:

• Constant Field Values

Constructor Details

HidePiecesButton

public HidePiecesButton()

Method Details

addTo

public void addTo(Buildable b)

Expects to be added to a Map. Adds itself as a GameComponent and a Drawable component

Specified by:

addTo in interface Buildable

Parameters:

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

setPiecesVisible

protected void setPiecesVisible(boolean visible)

add

public void add(Buildable b)

Description copied from interface: Buildable

Adds a child component. Both this method and Buildable.addTo(VASSAL.build.Buildable) are invoked when adding a child to a parent

Specified by:

add in interface Buildable

Parameters:

b - Child to attach to this buildable as a subcomponent

remove

public void remove(Buildable b)

Description copied from interface: Configurable

Remove a child component

Specified by:

remove in interface Configurable

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

setAttribute

public void setAttribute(String key,
 Object value)

Description copied from interface: AutoConfigurable

Called by the Buildable.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute. Can also be called with Object value to set the attribute.

Specified by:

setAttribute in interface AutoConfigurable

Specified by:

setAttribute in interface Translatable

Parameters:

key - the name of the attribute. If the implementing class extends AbstractConfigurable, will be one of those listed in AbstractBuildable.getAttributeNames().

value - If the value parameter is a String, it will be the value returned by Translatable.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()

build

public void build(Element e)

Description copied from interface: Buildable

Build the object from the XML representation of the Buildable

Specified by:

build in interface Buildable

Parameters:

e - the XML element containing the object data

getAttributeNames

public String[] getAttributeNames()

Specified by:

getAttributeNames in interface AutoConfigurable

Returns:

an array of Strings giving all attributes of this Buildable component that will be written to/read from an XML element

getAttributeVisibility

public VisibilityCondition getAttributeVisibility(String name)

Description copied from interface: AutoConfigurable

Because attributes are not always applicable in all cases, this method returns an interface to determine when the controls for specifying the named attribute should be visible.

Specified by:

getAttributeVisibility in interface AutoConfigurable

Parameters:

name -

Returns:

null if the attribute controls should always be visible;

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

Parameters:

key - the name of the attribute. If the implementing class extends AbstractConfigurable, 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 Translatable.setAttribute(java.lang.String, java.lang.Object).

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

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

draw

public void draw(Graphics g,
 Map m)

Specified by:

draw in interface Drawable

drawAboveCounters

public boolean drawAboveCounters()

Specified by:

drawAboveCounters in interface Drawable

paint

public void paint(Graphics g)

Overrides:

paint in class JComponent

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

getToolTipText

public String getToolTipText(MouseEvent e)

Overrides:

getToolTipText in class JComponent

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

setup

public void setup(boolean show)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

Specified by:

setup in interface GameComponent

Parameters:

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

getConfigureTypeName

public static String getConfigureTypeName()

getConfigureName

public String getConfigureName()

Description copied from interface: Configurable

The name of this Configurable Object

Specified by:

getConfigureName in interface Configurable

getConfigurer

public Configurer getConfigurer()

Specified by:

getConfigurer in interface Configurable

Returns:

a Configurer object which can be used to set the attributes of this object

getConfigureComponents

public Configurable[] getConfigureComponents()

Specified by:

getConfigureComponents in interface Configurable

Returns:

an array of Configurer objects representing the Configurable children of this Configurable object

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.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Description copied from interface: Configurable

Add a PropertyChangeListener. A PropertyChangeEvent should be fired with property name Configurable.NAME_PROPERTY when the value returned from Configurable.getConfigureName() has changed

Specified by:

addPropertyChangeListener in interface Configurable

Overrides:

addPropertyChangeListener in class Container

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

getBuildElement

public Element getBuildElement(Document doc)

Specified by:

getBuildElement in interface Buildable

Parameters:

doc - XML file

Returns:

an XML element from which this component can be built

getI18nData

public ComponentI18nData getI18nData()

Specified by:

getI18nData in interface Translatable

getMenuTextList

public List<String> getMenuTextList()

SearchTarget

Specified by:

getMenuTextList in interface SearchTarget

Returns:

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

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

SearchTarget

Specified by:

getNamedKeyStrokeList in interface SearchTarget

Returns:

a list of any Named KeyStrokes referenced in the Configurable, if any (for search)

getExpressionList

public List<String> getExpressionList()

SearchTarget

Specified by:

getExpressionList in interface SearchTarget

Returns:

a list of the Configurables string/expression fields if any (for search)

getFormattedStringList

public List<String> getFormattedStringList()

SearchTarget

Specified by:

getFormattedStringList in interface SearchTarget

Returns:

a list of any Message Format strings referenced in the Configurable, if any (for search)

getPropertyList

public List<String> getPropertyList()

SearchTarget

Specified by:

getPropertyList in interface SearchTarget

Returns:

a list of any Property Names referenced in the Configurable, if any (for search)

getAllImageNames

public SortedSet<String> getAllImageNames()

Specified by:

getAllImageNames in interface ImageSearchTarget

Returns:

names of all images used by the component and any subcomponents

addImageNamesRecursively

public void addImageNamesRecursively(Collection<String> s)

Adds all images used by this component AND any children (or inner decorators/pieces) to the collection.

Specified by:

addImageNamesRecursively in interface ImageSearchTarget

Parameters:

s - Collection to add image names to

getLocalImageNames

public SortedSet<String> getLocalImageNames()

Specified by:

getLocalImageNames in interface ImageSearchTarget

Returns:

names of all images used by this component

addLocalImageNames

public 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. For "find unused images" and "search".

Specified by:

addLocalImageNames in interface ImageSearchTarget

Parameters:

s - Collection to add image names to