VASSAL.build.widget
Class PieceSlot

java.lang.Object
  |
  +--VASSAL.build.AbstractBuildable
        |
        +--VASSAL.build.AbstractConfigurable
              |
              +--VASSAL.build.Widget
                    |
                    +--VASSAL.build.widget.PieceSlot

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, java.util.EventListener, java.awt.event.KeyListener, java.awt.event.MouseListener

Direct Known Subclasses:

CardSlot

public class PieceSlot

extends Widget

implements java.awt.event.MouseListener, java.awt.event.KeyListener

A Component that displays a GamePiece. Can be added to any Widget but cannot contain any children Keyboard input on a PieceSlot is forwarded to the GamePiece.keyEvent(javax.swing.KeyStroke) method for the PieceSlot's GamePiece. Clicking on a PieceSlot initiates a drag

Nested Class Summary

Nested classes inherited from class VASSAL.build.Widget

Widget.MyCellRenderer

Nested classes inherited from class VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

protected static java.awt.Font

FONT

Fields inherited from class VASSAL.build.Widget

buildElement, NAME, parent

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

PieceSlot()

PieceSlot(GamePiece p)

Method Summary

void	addTo(Buildable parent) Adds this component to its parent.
void	build(org.w3c.dom.Element e) When building a PieceSlot, the text contents of the XML element are parsed into a String.
java.lang.Class[]	getAllowableConfigureComponents() The allowable Configurable components of a Widget are the same as its parent
Configurer[]	getAttributeConfigurers()
java.lang.String[]	getAttributeDescriptions() Return an array of Strings describing the attributes of this object.
java.lang.String[]	getAttributeNames()
java.lang.Class[]	getAttributeTypes() Return the Class for the attributes of this object.
java.lang.String	getAttributeValueString(java.lang.String name) Called by the getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
org.w3c.dom.Element	getBuildElement(org.w3c.dom.Document doc)
java.awt.Component	getComponent()
Configurable[]	getConfigureComponents()
java.lang.String	getConfigureName() The name of this Configurable Object
Configurer	getConfigurer() The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static java.lang.String	getConfigureTypeName()
HelpFile	getHelpFile()
GamePiece	getPiece()
java.awt.Dimension	getPreferredSize()
void	keyPressed(java.awt.event.KeyEvent e)
void	keyReleased(java.awt.event.KeyEvent e)
void	keyTyped(java.awt.event.KeyEvent e)
void	mouseClicked(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
void	mouseExited(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
void	paint(java.awt.Graphics g)
void	removeFrom(Buildable parent) Remove this component from its parent
void	setAttribute(java.lang.String name, java.lang.Object value) Called by the build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute.
void	setPiece(GamePiece p)

Methods inherited from class VASSAL.build.Widget

getParent, rebuild

Methods inherited from class VASSAL.build.AbstractConfigurable

addPropertyChangeListener, getAttributeVisibility, remove, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

add, getBuildComponents, getComponents

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

add

Field Detail

FONT

protected static java.awt.Font FONT

Constructor Detail

PieceSlot

public PieceSlot()

PieceSlot

public PieceSlot(GamePiece p)

Method Detail

setPiece

public void setPiece(GamePiece p)

getPiece

public GamePiece getPiece()

paint

public void paint(java.awt.Graphics g)

getPreferredSize

public java.awt.Dimension getPreferredSize()

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Specified by:

mouseExited in interface java.awt.event.MouseListener

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Specified by:

keyTyped in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Specified by:

keyReleased in interface java.awt.event.KeyListener

getConfigureTypeName

public static java.lang.String getConfigureTypeName()

getComponent

public java.awt.Component getComponent()

Specified by:

getComponent in class Widget

Returns:

the Component for this widget. For efficiency, the Component may be initialized lazily instead of being created in the Buildable.build(org.w3c.dom.Element) method

build

public void build(org.w3c.dom.Element e)

When building a PieceSlot, the text contents of the XML element are parsed into a String. The String is decoded using GameModule.decode(java.lang.String). The resulting Command should be an instance of AddPiece. The piece referred to in the Command becomes the piece contained in the PieceSlot

Specified by:

build in interface Buildable

Overrides:

build in class Widget

Parameters:

e - the XML element containing the object data

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

Overrides:

addTo in class Widget

getBuildElement

public org.w3c.dom.Element getBuildElement(org.w3c.dom.Document doc)

Specified by:

getBuildElement in interface Buildable

Overrides:

getBuildElement in class Widget

Returns:

an XML element from which this component can be built

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

Overrides:

removeFrom in class Widget

getConfigureName

public java.lang.String getConfigureName()

Description copied from interface: Configurable

The name of this Configurable Object

Specified by:

getConfigureName in interface Configurable

Overrides:

getConfigureName in class AbstractConfigurable

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Overrides:

getHelpFile in class Widget

Returns:

a HelpFilte describing how to use and configure this component

getAttributeNames

public java.lang.String[] getAttributeNames()

Specified by:

getAttributeNames in interface AutoConfigurable

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

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

getAttributeDescriptions

public java.lang.String[] getAttributeDescriptions()

Description copied from class: AbstractConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Specified by:

getAttributeDescriptions in class AbstractConfigurable

getAttributeTypes

public java.lang.Class[] getAttributeTypes()

Description copied from class: AbstractConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, Color, and KeyStroke 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

setAttribute

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

Parameters:

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

getAttributeValueString

public java.lang.String getAttributeValueString(java.lang.String name)

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

Parameters:

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

getAttributeConfigurers

public Configurer[] getAttributeConfigurers()

Returns:

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

getConfigureComponents

public Configurable[] getConfigureComponents()

Specified by:

getConfigureComponents in interface Configurable

Overrides:

getConfigureComponents in class Widget

Returns:

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

getAllowableConfigureComponents

public java.lang.Class[] getAllowableConfigureComponents()

Description copied from class: Widget

The allowable Configurable components of a Widget are the same as its parent

Specified by:

getAllowableConfigureComponents in interface Configurable

Overrides:

getAllowableConfigureComponents in class Widget

Returns:

an array of Configurer objects representing all possible classes of Buildable children of this Configurable object

getConfigurer

public Configurer getConfigurer()

Description copied from class: AbstractConfigurable

The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer

Specified by:

getConfigurer in interface Configurable

Overrides:

getConfigurer in class AbstractConfigurable