edu.cmu.hcii.calo.view.training.TrainingMenu Class Reference

List of all members.

Detailed Description

A simple customizable menu containing (non-functional) commands for training CALO.

Author:
Brian Ellis


Public Member Functions

 TrainingMenu (JMenuItem...menuItems)
 Constructs a TrainingMenu with the given menu items above the CALO training items.
void setCorrectTerminology (String correctWord, String incorrectWord)
 Sets the words this menu should use in the titles of its menu items when referring to correctness for the purposes of training CALO.
boolean showIfRightClick (MouseEvent e)
 Shows this menu in response to a given mouse event, if and only if the mouse event is the result of a right-click.

Private Member Functions

 TrainingMenu (String arg0)
 Superclass constructor.
void setup (JMenuItem...menuItems)
 Sets up the visual appearance of this menu.

Static Private Attributes

static final long serialVersionUID = -156832116648667567L
 Prevent serialization collisions.


Constructor & Destructor Documentation

edu.cmu.hcii.calo.view.training.TrainingMenu.TrainingMenu ( JMenuItem...  menuItems  ) 

Constructs a TrainingMenu with the given menu items above the CALO training items.

edu.cmu.hcii.calo.view.training.TrainingMenu.TrainingMenu ( String  arg0  )  [private]

Superclass constructor.

Do not use.

Parameters:
arg0 the title of this menu


Member Function Documentation

void edu.cmu.hcii.calo.view.training.TrainingMenu.setup ( JMenuItem...  menuItems  )  [private]

Sets up the visual appearance of this menu.

Parameters:
menuItems the menu items to prepend to the training items.

void edu.cmu.hcii.calo.view.training.TrainingMenu.setCorrectTerminology ( String  correctWord,
String  incorrectWord 
)

Sets the words this menu should use in the titles of its menu items when referring to correctness for the purposes of training CALO.

The defaults are, unsurprisingly, "correct" and "incorrect", but in certain circumstances it may be desirable to use different terms: "relevant" and "irrelevant", "important" and "not important", etc.

Parameters:
correctWord the word or phrase the menu should use to indicate correctness
incorrectWord the word or phrase the menu should use to indicate incorrectness

boolean edu.cmu.hcii.calo.view.training.TrainingMenu.showIfRightClick ( MouseEvent  e  ) 

Shows this menu in response to a given mouse event, if and only if the mouse event is the result of a right-click.

Parameters:
e the mouse event to use to determine whether this was a right-click
Returns:
true if the menu was shown, false otherwise


Member Data Documentation

final long edu.cmu.hcii.calo.view.training.TrainingMenu.serialVersionUID = -156832116648667567L [static, private]

Prevent serialization collisions.


The documentation for this class was generated from the following file:
Generated on Mon Aug 13 15:06:29 2007 for CALO by  doxygen 1.5.2