org.nlogo.api
Interface NetLogoListener

All Superinterfaces:
EventListener
All Known Implementing Classes:
Logger

public interface NetLogoListener
extends EventListener

A host application (such as a Pedagogica script) should implement this interface in order to be notified of events occurring within NetLogo. Its methods are called by NetLogoListenerManager when these events occur. The events are typically user actions, but may also be triggered programmatically by the model.


Method Summary
 void buttonPressed(String buttonName)
          Called when the user presses a button in the NetLogo model.
 void buttonStopped(String buttonName)
          Called when a button in the NetLogo model has finished running and pops back up.
 void chooserChanged(String name, Object value, boolean valueChanged)
          Called when the value of a chooser changes.
 void commandEntered(String owner, String text, char agentType, CompilerException errorMsg)
          Called when the user enters text into the command center (and presses return).
 void inputBoxChanged(String name, Object value, boolean valueChanged)
          Called when the value of an input box changes.
 void openModel(String name)
           
 void sliderChanged(String name, double value, double min, double increment, double max, boolean valueChanged, boolean buttonReleased)
          Called when the value of a slider changes.
 void switchChanged(String name, boolean value, boolean valueChanged)
          Called when the value of a switch changes.
 

Method Detail

buttonPressed

void buttonPressed(String buttonName)
Called when the user presses a button in the NetLogo model.

Note that the button may take some time to run and therefore may not pop back up until some later. Use buttonStopped() if you need to know when the button's action has completed.


buttonStopped

void buttonStopped(String buttonName)
Called when a button in the NetLogo model has finished running and pops back up.

The button may be a "once" button or a "forever" button. If it is a "once" button, it pops back up automatically when its action is completed. If it is a "forever" button, it will pop back up when clicked for a second time by the user. (Some forever buttons may also pop back up automatically, if the model is written that way.)


sliderChanged

void sliderChanged(String name,
                   double value,
                   double min,
                   double increment,
                   double max,
                   boolean valueChanged,
                   boolean buttonReleased)
Called when the value of a slider changes. Usually if the slider changes it is because the user has changed it using the mouse, but the change may also be the result of code in the model or code typed into the command center.


switchChanged

void switchChanged(String name,
                   boolean value,
                   boolean valueChanged)
Called when the value of a switch changes. Usually if the switch changes it is because the user has changed it using the mouse, but the change may also be the result of code in the model or code typed into the command center.


chooserChanged

void chooserChanged(String name,
                    Object value,
                    boolean valueChanged)
Called when the value of a chooser changes. Usually if the chooser changes it is because the user has changed it using the mouse, but the change may also be the result of code in the model or code typed into the command center.


inputBoxChanged

void inputBoxChanged(String name,
                     Object value,
                     boolean valueChanged)
Called when the value of an input box changes. Usually if the input box changes it is because the user has changed it using the mouse, but the change may also be the result of code in the model or code typed into the command center.


commandEntered

void commandEntered(String owner,
                    String text,
                    char agentType,
                    CompilerException errorMsg)
Called when the user enters text into the command center (and presses return). Note that at the time this method is called, the command may not have finished executing yet.

Parameters:
owner - name of the widget that owns the code
text - the text the user entered
agentType - O, T, or P depending whether the user was addressing the observer, turtles, or patches
errorMsg - message the user receives if there is a compiler error

openModel

void openModel(String name)