Class DebugControls

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.tools.DebugControls

All Implemented Interfaces:

ActionListener, EventListener, Buildable, PropertyNameSource, ValidityChecker, Auditable, ImageSearchTarget

public class DebugControls
extends AbstractBuildable
implements ActionListener

Field Summary

Fields

Modifier and Type	Field	Description
protected JPanel	controlPanel
protected JLabel	cursorCoordsLabel
protected Point	cursorLocation
protected Point	cursorLocationBoard
protected JButton	launch
protected static final long	MEGABYTE
protected JLabel	selectedCoordsBoardLabel
protected JLabel	selectedCoordsLabel
protected FlowLabel	selectedNameLabel
protected SplitPane	splitPane
protected Timer	timer

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Constructor Summary

Constructors

Constructor	Description
DebugControls()

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent evt)
void	addTo(Buildable b)	Adds this component to its parent.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
String	getAttributeValueString(String name)
JPanel	getControls()
Point	getCursorLocation()
boolean	isVisible()
void	setAttribute(String name, Object value)	Sets a buildFile (XML) attribute value for this component.
static void	setCheckBox(CheckBoxMenuItemProxy c)
void	setCursorLocation(Point pt)
void	setCursorLocation(Point pt, Map map)
void	toggleVisible()

Methods inherited from class VASSAL.build.AbstractBuildable

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

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, 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.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.build.Buildable

isMandatory, isMovable, isUnique

Field Details

MEGABYTE

protected static final long MEGABYTE

See Also:

• Constant Field Values

launch

protected JButton launch

controlPanel

protected JPanel controlPanel

splitPane

protected SplitPane splitPane

cursorLocation

protected Point cursorLocation

cursorLocationBoard

protected Point cursorLocationBoard

cursorCoordsLabel

protected JLabel cursorCoordsLabel

selectedNameLabel

protected FlowLabel selectedNameLabel

selectedCoordsLabel

protected JLabel selectedCoordsLabel

selectedCoordsBoardLabel

protected JLabel selectedCoordsBoardLabel

timer

protected Timer timer

Constructor Details

DebugControls

public DebugControls()

Method Details

setCheckBox

public static void setCheckBox(CheckBoxMenuItemProxy c)

getCursorLocation

public Point getCursorLocation()

setCursorLocation

public void setCursorLocation(Point pt,
 Map map)

setCursorLocation

public void setCursorLocation(Point pt)

addTo

public void addTo(Buildable b)

Description copied from interface: Buildable

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

Parameters:

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

actionPerformed

public void actionPerformed(ActionEvent evt)

Specified by:

actionPerformed in interface ActionListener

isVisible

public boolean isVisible()

toggleVisible

public void toggleVisible()

getControls

public JPanel getControls()

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 class AbstractBuildable

Returns:

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

setAttribute

public void setAttribute(String name,
 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 class AbstractBuildable

Parameters:

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

getAttributeValueString

public String getAttributeValueString(String name)

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

name - the name of the attribute. Will be one of those listed in AbstractBuildable.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 AbstractBuildable.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.