Packages

t

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.

Source
NetLogoListener.scala
Linear Supertypes
EventListener, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NetLogoListener
  2. EventListener
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract 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.

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

  3. abstract def chooserChanged(name: String, value: AnyRef, valueChanged: Boolean): Unit

    Called when the value of a chooser changes.

    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.

  4. abstract def codeTabCompiled(text: String, errorMsg: CompilerException): Unit

    Called when the Code tab is recompiled.

    Called when the Code tab is recompiled.

    text

    the contents of the Code tab

    errorMsg

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

  5. abstract def commandEntered(owner: String, text: String, agentType: Char, errorMsg: CompilerException): Unit

    Called when the user enters text into the command center (and presses return).

    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.

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

  6. abstract def inputBoxChanged(name: String, value: AnyRef, valueChanged: Boolean): Unit

    Called when the value of an input box changes.

    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.

  7. abstract def modelOpened(name: String): Unit

    Called when a model is opened.

    Called when a model is opened.

    name

    name of the model that was opened

  8. abstract def possibleViewUpdate(): Unit

    Called when the engine potentially schedules a view update.

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

  9. abstract 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.

    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.

  10. abstract def switchChanged(name: String, value: Boolean, valueChanged: Boolean): Unit

    Called when the value of a switch changes.

    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.

  11. abstract def tickCounterChanged(ticks: Double): Unit

    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.

    ticks

    new value of the tick counter

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from EventListener

Inherited from AnyRef

Inherited from Any

Ungrouped