frodo2.gui.VisualizerControls Class Reference

A GUI to control how long messages are displayed. More...

Inheritance diagram for frodo2.gui.VisualizerControls:

Classes
class	MsgTypeSetting
	A message type and its slider. More...
class	MsgTypeRenderer
	Renders each node in the tree as a message type name and a slider. More...

Public Member Functions
	VisualizerControls ()
	Constructor.
void	actionPerformed (ActionEvent e)
void	treeExpanded (TreeExpansionEvent event)
void	treeCollapsed (TreeExpansionEvent event)
void	enableStepButton (final boolean enabled)
	Enables or disables the STEP button.

Package Functions
void	addControlPanel (MessageType msgType)
	Adds a new control panel for a message type.

Private Member Functions
synchronized MsgTypeSetting	getTreeNode (MessageType type)
	Retrieves the node for the input message type.

Private Attributes
JTree	tree
	The tree containing the settings.
MsgTypeSetting	root
	The root of the message type hierarchy.
HashMap< MessageType, MsgTypeSetting >	nodes = new HashMap< MessageType, MsgTypeSetting > ()
	The tree nodes, indexed by message type.
DefaultTreeModel	model
	The tree model used to dynamically add nodes in a thread-safe way.
JButton	stepBtn
	The STEP button.

Static Private Attributes
static final long	serialVersionUID = 3541530360724833030L
	Serial version UID.
static final String	STEP_BUTTON_NAME = "Step"
	The name of the STEP button.

Detailed Description

A GUI to control how long messages are displayed.

Author

Thomas Leaute

Constructor & Destructor Documentation

VisualizerControls()

frodo2.gui.VisualizerControls.VisualizerControls

(

)

Constructor.

References model, frodo2.communication.MessageType.ROOT, STEP_BUTTON_NAME, stepBtn, and tree.

Member Function Documentation

actionPerformed()

void frodo2.gui.VisualizerControls.actionPerformed

(

ActionEvent

e

)

See also

java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)

addControlPanel()

void frodo2.gui.VisualizerControls.addControlPanel ( MessageType msgType )

package

Adds a new control panel for a message type.

Parameters

msgType

the message type

Todo

Auto-expand

References getTreeNode().

Here is the call graph for this function:

enableStepButton()

void frodo2.gui.VisualizerControls.enableStepButton

(

final boolean

enabled

)

Enables or disables the STEP button.

Parameters

enabled

whether the STEP button should be enabled

getTreeNode()

synchronized MsgTypeSetting frodo2.gui.VisualizerControls.getTreeNode ( MessageType type )

private

Retrieves the node for the input message type.

Parameters

type	the message type

Returns

the node in the tree for this message type (newly created if not yet existent)

References frodo2.communication.MessageType.equals(), frodo2.communication.MessageType.getParent(), getTreeNode(), and frodo2.communication.MessageType.ROOT.

Referenced by addControlPanel(), and getTreeNode().

Here is the call graph for this function:

treeCollapsed()

void frodo2.gui.VisualizerControls.treeCollapsed

(

TreeExpansionEvent

event

)

See also

javax.swing.event.TreeExpansionListener#treeCollapsed(javax.swing.event.TreeExpansionEvent)

treeExpanded()

void frodo2.gui.VisualizerControls.treeExpanded

(

TreeExpansionEvent

event

)

See also

javax.swing.event.TreeExpansionListener#treeExpanded(javax.swing.event.TreeExpansionEvent)

Member Data Documentation

model

DefaultTreeModel frodo2.gui.VisualizerControls.model

private

The tree model used to dynamically add nodes in a thread-safe way.

Referenced by VisualizerControls().

nodes

HashMap< MessageType, MsgTypeSetting> frodo2.gui.VisualizerControls.nodes = new HashMap< MessageType, MsgTypeSetting > ()

private

The tree nodes, indexed by message type.

root

MsgTypeSetting frodo2.gui.VisualizerControls.root

private

The root of the message type hierarchy.

serialVersionUID

final long frodo2.gui.VisualizerControls.serialVersionUID = 3541530360724833030L

staticprivate

Serial version UID.

STEP_BUTTON_NAME

final String frodo2.gui.VisualizerControls.STEP_BUTTON_NAME = "Step"

staticprivate

The name of the STEP button.

Referenced by VisualizerControls().

stepBtn

JButton frodo2.gui.VisualizerControls.stepBtn

private

The STEP button.

Referenced by VisualizerControls().

tree

JTree frodo2.gui.VisualizerControls.tree

private

The tree containing the settings.

Referenced by frodo2.gui.VisualizerControls.MsgTypeRenderer.getTreeCellEditorComponent(), frodo2.gui.VisualizerControls.MsgTypeRenderer.getTreeCellRendererComponent(), frodo2.gui.VisualizerControls.MsgTypeSetting.stateChanged(), and VisualizerControls().

---

The documentation for this class was generated from the following file:

• src/frodo2/gui/VisualizerControls.java