com.putable.common.matrix

Class Key

java.lang.Object

com.putable.common.matrix.NetPuzlObject

com.putable.common.matrix.Key

public class Key
extends NetPuzlObject

A representation of a command that can normally be invoked from a keyboard when running a NetPuzl client GUI

Version:

1.0

Author:

Heineken

Field Summary

Fields

Modifier and Type	Field and Description
private SayFunction	sayFunction The function that processes spoken commands for this Key

Constructor Summary

Constructors

Constructor and Description
Key(ObjID objID, Attributes attributes, java.util.Map<ObjID,NetPuzlObject> cache) Constructs a Key with the given parameters

Method Summary

Modifier and Type	Method and Description
TSet	createSetTag() Overrides createSetTag because our Keys do not use background colors, foreground colors, y values, or Images
void	doSpokenCommand(java.lang.String text) Performs the command spoken to this Key
SayFunction	getSayFunction() Gets the function that processes spoken commands for this Key
boolean	hasSpokenCommand() Determines if this Key has a function to process spoken commands
void	setSayFunction(SayFunction sayFunction) Sets the function that processes spoken commands for this Key

Methods inherited from class com.putable.common.matrix.NetPuzlObject

fullToString, getAttributes, getObjID, setAttributes, toString

Methods inherited from class java.lang.Object

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

Field Detail

sayFunction

private SayFunction sayFunction

The function that processes spoken commands for this Key

Constructor Detail

Key

public Key(ObjID objID,
           Attributes attributes,
           java.util.Map<ObjID,NetPuzlObject> cache)

Constructs a Key with the given parameters

Parameters:

objID - The object ID to construct this Key with

attributes - The Attributes to construct this Key with

cache - The Map to cache this Key in

Method Detail

createSetTag

public TSet createSetTag()

Overrides createSetTag because our Keys do not use background colors, foreground colors, y values, or Images

Overrides:

createSetTag in class NetPuzlObject

Returns:

A set tag of this NetPuzlObject to be sent to a client

See Also:

NetPuzlObject.createSetTag()

doSpokenCommand

public void doSpokenCommand(java.lang.String text)

Performs the command spoken to this Key

Parameters:

text - The command spoken to this Key

getSayFunction

public SayFunction getSayFunction()

Gets the function that processes spoken commands for this Key

Returns:

The function that processes spoken commands for this Key

hasSpokenCommand

public boolean hasSpokenCommand()

Determines if this Key has a function to process spoken commands

Returns:

Whether or not this Key has a function to process spoken commands

setSayFunction

public void setSayFunction(SayFunction sayFunction)

Sets the function that processes spoken commands for this Key

Parameters:

sayFunction - The function that processes spoken commands to set this Key to