com.hdcookbook.grin.io.builders
Class VisualRCHandlerHelper

java.lang.Object
  com.hdcookbook.grin.io.builders.VisualRCHandlerHelper

public class VisualRCHandlerHelper
extends java.lang.Object

A helper class for creating a VisualRCHandler object.

To use this, create an instance, populate it, then call getFinishedHandler().

Author:

Bill Foote (http://jovial.com)

Constructor Summary

VisualRCHandlerHelper()

Method Summary

java.lang.String	addGrid(java.util.ArrayList<java.util.ArrayList<VisualRCHandlerCell>> grid) Adds an RC grid.
void	addGridAlternateName(java.lang.String name)
void	addRCOverrides(java.util.Map<java.lang.String,java.lang.String> rcOverrides) Sets the RC override list.
SEVisualRCHandler	getFinishedHandler()
java.util.ArrayList<java.util.ArrayList<VisualRCHandlerCell>>	getGrid(int i)
java.util.Map<java.lang.String,java.lang.String>	getRCOverrides(int i)
int	getState(int alternate, int column, int row)
java.util.Map<java.lang.String,java.lang.Integer>	getStates()
void	setActivateCommands(Command[][] commands)
void	setHandlerName(java.lang.String name) Sets the handler's name
void	setMouseRects(java.awt.Rectangle[] rects)
void	setMouseRectStates(int[] states)
void	setSelectCommands(Command[][] commands)
void	setStartSelected(boolean b) Sets the startSelected flag
void	setTimeout(int timeout)
void	setTimeoutCommands(Command[] commands)

Methods inherited from class java.lang.Object

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

Constructor Detail

VisualRCHandlerHelper

public VisualRCHandlerHelper()

Method Detail

setHandlerName

public void setHandlerName(java.lang.String name)

Sets the handler's name

setStartSelected

public void setStartSelected(boolean b)

Sets the startSelected flag

addGrid

public java.lang.String addGrid(java.util.ArrayList<java.util.ArrayList<VisualRCHandlerCell>> grid)

Adds an RC grid.

Returns:

null if all goes well, or an error message if there's a problem.

addGridAlternateName

public void addGridAlternateName(java.lang.String name)

getGrid

public java.util.ArrayList<java.util.ArrayList<VisualRCHandlerCell>> getGrid(int i)

addRCOverrides

public void addRCOverrides(java.util.Map<java.lang.String,java.lang.String> rcOverrides)

Sets the RC override list. The maps Maps a key of the form "direction:from state name" to a state name. direction is "up", "down", "right" or "left". When in the state is "from state name", the given direction will move to the second state.

The value of the map is the state to go to, or the special string "<activate>".

getRCOverrides

public java.util.Map<java.lang.String,java.lang.String> getRCOverrides(int i)

setSelectCommands

public void setSelectCommands(Command[][] commands)

setActivateCommands

public void setActivateCommands(Command[][] commands)

setMouseRects

public void setMouseRects(java.awt.Rectangle[] rects)

setMouseRectStates

public void setMouseRectStates(int[] states)

setTimeout

public void setTimeout(int timeout)

setTimeoutCommands

public void setTimeoutCommands(Command[] commands)

getStates

public java.util.Map<java.lang.String,java.lang.Integer> getStates()

Returns:

The map from state name to index in array of states

getState

public int getState(int alternate,
                    int column,
                    int row)

Returns:

The state number referred to by the given cell, or -1 if that cell isn't a state or doesn't refer to one.

getFinishedHandler

public SEVisualRCHandler getFinishedHandler()
                                     throws java.io.IOException

Throws:

java.io.IOException - if there's an inconsistency in the handler