VASSAL.counters
Class Hideable

java.lang.Object
  |
  +--VASSAL.counters.Decorator
        |
        +--VASSAL.counters.Hideable

All Implemented Interfaces:

EditablePiece, GamePiece

public class Hideable

extends Decorator

implements EditablePiece

Field Summary

static java.lang.String	HIDDEN_BY
static java.lang.String	ID

Constructor Summary

Hideable()

Hideable(java.lang.String type, GamePiece p)

Method Summary

java.awt.Rectangle	boundingBox() The area which this GamePiece occupies when drawn at the point given by getPosition().
void	draw(java.awt.Graphics g, int x, int y, java.awt.Component obs, double zoom)
java.lang.String	getDescription() A plain-English description of this type of piece
PieceEditor	getEditor() Get the configurer for this trait
HelpFile	getHelpFile()
java.lang.String	getName() The plain English name for this piece
java.lang.Object	getProperty(java.lang.Object key)
KeyCommand[]	myGetKeyCommands()
java.lang.String	myGetState()
java.lang.String	myGetType()
Command	myKeyEvent(javax.swing.KeyStroke stroke) The response of this trait alone to the given KeyStroke
void	mySetState(java.lang.String in) Set just the state of this trait
void	mySetType(java.lang.String type) Set the type information for this piece.
java.awt.Rectangle	selectionBounds() The area which is considered part of this GamePiece for purposes of selecting it with the mouse
void	setInner(GamePiece p) Set the inner GamePiece
void	setProperty(java.lang.Object key, java.lang.Object val) The GamePiece should store properties for retrieval (e.g in a Hashtable) It is not necessary that properties stored with this method be retained in the piece's Decorator.getState() method.

Methods inherited from class VASSAL.counters.Decorator

getDecorator, getId, getInner, getInnermost, getKeyCommands, getMap, getOutermost, getParent, getPosition, getState, getType, keyEvent, mergeState, setId, setMap, setParent, setPosition, setState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface VASSAL.counters.GamePiece

getId, getMap, getParent, getPosition, getState, getType, keyEvent, setId, setMap, setParent, setPosition, setState

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

HIDDEN_BY

public static final java.lang.String HIDDEN_BY

See Also:

Constant Field Values

Constructor Detail

Hideable

public Hideable()

Hideable

public Hideable(java.lang.String type,
                GamePiece p)

Method Detail

setProperty

public void setProperty(java.lang.Object key,
                        java.lang.Object val)

Description copied from interface: GamePiece

The GamePiece should store properties for retrieval (e.g in a Hashtable) It is not necessary that properties stored with this method be retained in the piece's GamePiece.getState() method.

Specified by:

setProperty in interface GamePiece

Overrides:

setProperty in class Decorator

getProperty

public java.lang.Object getProperty(java.lang.Object key)

Specified by:

getProperty in interface GamePiece

Overrides:

getProperty in class Decorator

mySetType

public void mySetType(java.lang.String type)

Description copied from interface: EditablePiece

Set the type information for this piece. See Decorator.myGetType()

Specified by:

mySetType in interface EditablePiece

setInner

public void setInner(GamePiece p)

Description copied from class: Decorator

Set the inner GamePiece

Overrides:

setInner in class Decorator

mySetState

public void mySetState(java.lang.String in)

Description copied from class: Decorator

Set just the state of this trait

Specified by:

mySetState in class Decorator

See Also:

Decorator.myGetState()

myGetType

public java.lang.String myGetType()

Specified by:

myGetType in class Decorator

Returns:

the type of this trait alone

See Also:

Decorator.getType()

myGetState

public java.lang.String myGetState()

Specified by:

myGetState in class Decorator

Returns:

the state of this trait alone

See Also:

Decorator.getState()

selectionBounds

public java.awt.Rectangle selectionBounds()

Description copied from interface: GamePiece

The area which is considered part of this GamePiece for purposes of selecting it with the mouse

Specified by:

selectionBounds in interface GamePiece

boundingBox

public java.awt.Rectangle boundingBox()

Description copied from interface: GamePiece

The area which this GamePiece occupies when drawn at the point given by getPosition().

Specified by:

boundingBox in interface GamePiece

draw

public void draw(java.awt.Graphics g,
                 int x,
                 int y,
                 java.awt.Component obs,
                 double zoom)

Specified by:

draw in interface GamePiece

getName

public java.lang.String getName()

Description copied from interface: GamePiece

The plain English name for this piece

Specified by:

getName in interface GamePiece

myGetKeyCommands

public KeyCommand[] myGetKeyCommands()

Specified by:

myGetKeyCommands in class Decorator

Returns:

the commands for this trait alone

See Also:

Decorator.getKeyCommands()

myKeyEvent

public Command myKeyEvent(javax.swing.KeyStroke stroke)

Description copied from class: Decorator

The response of this trait alone to the given KeyStroke

Specified by:

myKeyEvent in class Decorator

Parameters:

stroke -

Returns:

null if no effect

See Also:

Decorator.keyEvent(javax.swing.KeyStroke)

getDescription

public java.lang.String getDescription()

Description copied from interface: EditablePiece

A plain-English description of this type of piece

Specified by:

getDescription in interface EditablePiece

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface EditablePiece

getEditor

public PieceEditor getEditor()

Description copied from interface: EditablePiece

Get the configurer for this trait

Specified by:

getEditor in interface EditablePiece

Overrides:

getEditor in class Decorator