NetLogoListener

org.nlogo.api.NetLogoListener
trait NetLogoListener extends EventListener

A host application 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.

Attributes

Source
NetLogoListener.scala
Graph
Supertypes
trait EventListener
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

def buttonPressed(buttonName: String): Unit

Called when the user presses a button in the NetLogo model.

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.

Attributes

Source
NetLogoListener.scala
def buttonStopped(buttonName: String): Unit

Called when a button in the NetLogo model has finished running and pops back up.

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.)

Attributes

Source
NetLogoListener.scala
def chooserChanged(name: String, value: AnyRef, valueChanged: Boolean): Unit

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.

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.

Attributes

Source
NetLogoListener.scala
def codeTabCompiled(text: String, errorMsg: CompilerException): Unit

Called when the Code tab is recompiled.

Called when the Code tab is recompiled.

Value parameters

errorMsg

message the user receives if there is a compiler error, or null

text

the contents of the Code tab

Attributes

Source
NetLogoListener.scala
def commandEntered(owner: String, text: String, agentType: Char, errorMsg: CompilerException): Unit

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.

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.

Value parameters

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, or null

owner

name of the widget that owns the code

text

the text the user entered

Attributes

Source
NetLogoListener.scala
def inputBoxChanged(name: String, value: AnyRef, valueChanged: Boolean): Unit

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.

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.

Attributes

Source
NetLogoListener.scala
def modelOpened(name: String): Unit

Called when a model is opened.

Called when a model is opened.

Value parameters

name

name of the model that was opened

Attributes

Source
NetLogoListener.scala

Called when the engine potentially schedules a view update. "Potentially" because an actual update might not take place for any number of reasons (view updates are off, the speed slider is sped up, etc.).

Called when the engine potentially schedules a view update. "Potentially" because an actual update might not take place for any number of reasons (view updates are off, the speed slider is sped up, etc.).

Attributes

Source
NetLogoListener.scala
def sliderChanged(name: String, value: Double, min: Double, increment: Double, max: Double, valueChanged: Boolean, buttonReleased: Boolean): Unit

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.

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.

Attributes

Source
NetLogoListener.scala
def switchChanged(name: String, value: Boolean, valueChanged: Boolean): Unit

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.

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.

Attributes

Source
NetLogoListener.scala

Called when the tick counter changes, either by being advanced, or by being reset to 0.

Called when the tick counter changes, either by being advanced, or by being reset to 0.

Value parameters

ticks

new value of the tick counter

Attributes

Source
NetLogoListener.scala