Traced

final class Traced[TraceData] extends ViewFrame[Model] with TraceGeneratingDefaults[Model, TraceData]

A view that wraps around another, collecting a log or trace of events while delegating its actual event-handling to the wrapped view. Provides additional methods for accessing such traces: trace, simulateAndGet, and startAndGet. A few examples of using these methods are given below.

simulate 500 clock ticks on the trace-collecing view and print the trace of clock ticks accompanied by descriptions of the view’äs model.

for((traceItem, traceEvent) <- myTracedView.simulateAndGet(500)) {
  println(traceEvent + ": " + traceItem)
}

Or, equivalently:

myTracedView.simulate(500)
for((traceItem, traceEvent) <- myTracedView.trace) {
  println(traceEvent + ": " + traceItem)
}

Alternatively, start the trace-collecting view and run it interactively until it is done or a tick limit is reached. Then print the trace of ticks and GUI events accompanied with descriptions of the view’s model.

val futureTrace = myTracedView.startAndGet(tickLimit=100) recover {
  case Aborted(message, partialTrace) => partialTrace
}
for(trace <- futureTrace; (traceItem, traceEvent) <- trace) {
  println(traceEvent + ": " + traceItem)
}

TraceData: the type of the model-state descriptions in the trace

Linear Supertypes

TraceGeneratingDefaults[Model, TraceData], GeneratesTrace[Model, TraceData], ViewFrame[Model], ControlDefaults[Model], HasModelField[Model], TooltipDefaults, ViewImpl.ViewFrame[Model], View.Controls[Model], AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Traced
TraceGeneratingDefaults
GeneratesTrace
ViewFrame
ControlDefaults
HasModelField
TooltipDefaults
ViewFrame
Controls
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new Traced(extractTrace: (Model) => TraceData)
extractTrace
a function that determines how to describe a model state in the generated trace

Type Members

final class Traced[TraceData] extends ViewFrame[Model] with TraceGeneratingDefaults[Model, TraceData]
A view that wraps around another, collecting a log or trace of events while delegating its actual event-handling to the wrapped view.
A view that wraps around another, collecting a log or trace of events while delegating its actual event-handling to the wrapped view. Provides additional methods for accessing such traces: trace, simulateAndGet, and startAndGet. A few examples of using these methods are given below.
simulate 500 clock ticks on the trace-collecing view and print the trace of clock ticks accompanied by descriptions of the view’äs model.
```
for((traceItem, traceEvent) <- myTracedView.simulateAndGet(500)) {
  println(traceEvent + ": " + traceItem)
}
```
Or, equivalently:
```
myTracedView.simulate(500)
for((traceItem, traceEvent) <- myTracedView.trace) {
  println(traceEvent + ": " + traceItem)
}
```
Alternatively, start the trace-collecting view and run it interactively until it is done or a tick limit is reached. Then print the trace of ticks and GUI events accompanied with descriptions of the view’s model.
```
val futureTrace = myTracedView.startAndGet(tickLimit=100) recover {
  case Aborted(message, partialTrace) => partialTrace
}
for(trace <- futureTrace; (traceItem, traceEvent) <- trace) {
  println(traceEvent + ": " + traceItem)
}
```
TraceData
the type of the model-state descriptions in the trace
Definition Classes
ViewFrame

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def adjustSpeed(newTickRate: Double): Unit
Sets a new tick rate for the view, replacing any previously set by the constructor or this method.
Sets a new tick rate for the view, replacing any previously set by the constructor or this method.
Definition Classes
ViewFrame
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
final def close(): Unit
Closes the view: stops it (as per stop), does any onClose effects, hides the GUI window, and possibly terminates the entire application (as per the constructor parameter).
Closes the view: stops it (as per stop), does any onClose effects, hides the GUI window, and possibly terminates the entire application (as per the constructor parameter).
Definition Classes
ViewFrame
val closeWhenDone: Boolean
Definition Classes
ViewFrame
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
def icon: Option[Pic]
The icon to be displayed in the title bar of this view’s GUI frame.
The icon to be displayed in the title bar of this view’s GUI frame.
Definition Classes
ViewFrame
final def icon_=(icon: Pic): Unit
Sets the icon to be displayed in the title bar of this view’s GUI frame.
Sets the icon to be displayed in the title bar of this view’s GUI frame.
icon
a picture to be used as the icon
Definition Classes
ViewFrame
final def icon_=(icon: Option[Pic]): Unit
Sets the icon to be displayed in the title bar of this view’s GUI frame.
Sets the icon to be displayed in the title bar of this view’s GUI frame.
icon
a picture to be used as the icon; if None, en empty icon image will be displayed
Definition Classes
ViewFrame
def isDone: Boolean
Determines if the given state is a “done state” for the view.
Determines if the given state is a “done state” for the view. By default, this is never the case, but that behavior can be overridden.
Once done, the view stops reacting to events and updating its graphics and may close its GUI window, depending on the constructor parameters of the view.
Definition Classes
TraceGeneratingDefaults → ControlDefaults
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def isPaused: Boolean
Indicates whether the view is paused.
Indicates whether the view is paused. This implementation delegates to the underlying View that is being traced.
Definition Classes
GeneratesTrace → Controls
def makePic: Pic
Returns a Pic that graphically represents the current state of the view’s model object.
Returns a Pic that graphically represents the current state of the view’s model object. This method is automatically invoked by the view after GUI events and clock ticks. Left abstract by this class so any concrete view needs to add a custom implementation.
For best results, all invocations of this method on a single view object should return Pics of equal dimensions.
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def model: Model
the model object represented in the view.
the model object represented in the view.
Definition Classes
HasModelField
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
def onClick(event: event.MouseClicked): Unit
Causes an effect whenever a mouse button is clicked (pressed+released, possibly multiple times in sequence) above the view.
Causes an effect whenever a mouse button is clicked (pressed+released, possibly multiple times in sequence) above the view. Does nothing by default but can be overridden.
If you don’t need much information about the GUI event, you may find it simpler to implement the other method of the same name instead of this one.
event
the GUI event that caused this handler to be called
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onClick(position: Pos): Unit
Causes an effect whenever a mouse button is clicked (pressed+released, possibly multiple times in sequence) above the view.
Causes an effect whenever a mouse button is clicked (pressed+released, possibly multiple times in sequence) above the view. Does nothing by default but can be overridden.
If the desired behavior depends on detailed information about the GUI event, you may want to implement the other method of the same name instead of this one.
position
the position of the mouse cursor relative to the view’s top left-hand corner
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onClose(): Unit
Causes an effect when the view’s GUI window is closed for any reason.
Causes an effect when the view’s GUI window is closed for any reason. By default, this method does nothing.
Definition Classes
ViewFrame
def onKeyDown(event: event.KeyPressed): Unit
Causes an effect whenever a key on the keyboard is pressed down while the view has the keyboard focus.
Causes an effect whenever a key on the keyboard is pressed down while the view has the keyboard focus. Does nothing by default but can be overridden.
If you don’t need much information about the GUI event, you may find it simpler to implement the other method of the same name instead of this one.
event
the GUI event that caused this handler to be called
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onKeyDown(key: Key): Unit
Causes an effect whenever a key on the keyboard is pressed down while the view has the keyboard focus.
Causes an effect whenever a key on the keyboard is pressed down while the view has the keyboard focus. Does nothing by default but can be overridden.
If the desired behavior depends on detailed information about the GUI event, you may want to implement the other method of the same name instead of this one.
key
the key that was pressed down
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onKeyUp(event: event.KeyReleased): Unit
Causes an effect whenever a key on the keyboard is released while the view has the keyboard focus.
Causes an effect whenever a key on the keyboard is released while the view has the keyboard focus. Does nothing by default but can be overridden.
If you don’t need much information about the GUI event, you may find it simpler to implement the other method of the same name instead of this one.
event
the GUI event that caused this handler to be called
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onKeyUp(key: Key): Unit
Causes an effect whenever a key on the keyboard is released while the view has the keyboard focus.
Causes an effect whenever a key on the keyboard is released while the view has the keyboard focus. Does nothing by default but can be overridden.
If the desired behavior depends on detailed information about the GUI event, you may want to implement the other method of the same name instead of this one.
key
the key that was released
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onMouseDown(event: event.MousePressed): Unit
Causes an effect whenever a mouse button is pressed down above the view.
Causes an effect whenever a mouse button is pressed down above the view. Does nothing by default but can be overridden.
If you don’t need much information about the GUI event, you may find it simpler to implement the other method of the same name instead of this one.
event
the GUI event that caused this handler to be called
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onMouseDown(position: Pos): Unit
Causes an effect whenever a mouse button is pressed down above the view.
Causes an effect whenever a mouse button is pressed down above the view. Does nothing by default but can be overridden.
If the desired behavior depends on detailed information about the GUI event, you may want to implement the other method of the same name instead of this one.
position
the position of the mouse cursor relative to the view’s top left-hand corner
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onMouseDrag(event: event.MouseDragged): Unit
Causes an effect whenever the mouse cursor is dragged above the view.
Causes an effect whenever the mouse cursor is dragged above the view. Does nothing by default but can be overridden.
If you don’t need much information about the GUI event, you may find it simpler to implement the other method of the same name instead of this one.
event
the GUI event that caused this handler to be called
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onMouseDrag(position: Pos): Unit
Causes an effect whenever the mouse cursor is dragged above the view.
Causes an effect whenever the mouse cursor is dragged above the view. Does nothing by default but can be overridden.
If the desired behavior depends on detailed information about the GUI event, you may want to implement the other method of the same name instead of this one.
position
the position of the mouse cursor relative to the view’s top left-hand corner
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onMouseEnter(event: event.MouseEntered): Unit
Causes an effect whenever the mouse cursor enters the view.
Causes an effect whenever the mouse cursor enters the view. Does nothing by default but can be overridden.
event
the GUI event that caused this handler to be called
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onMouseExit(event: event.MouseExited): Unit
Causes an effect whenever the mouse cursor exits the view.
Causes an effect whenever the mouse cursor exits the view. Does nothing by default but can be overridden.
event
the GUI event that caused this handler to be called
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onMouseMove(event: event.MouseMoved): Unit
Causes an effect whenever the mouse cursor moves above the view.
Causes an effect whenever the mouse cursor moves above the view. Does nothing by default but can be overridden.
If you don’t need much information about the GUI event, you may find it simpler to implement the other method of the same name instead of this one.
event
the GUI event that caused this handler to be called
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onMouseMove(position: Pos): Unit
Causes an effect whenever the mouse cursor moves above the view.
Causes an effect whenever the mouse cursor moves above the view. Does nothing by default but can be overridden.
If the desired behavior depends on detailed information about the GUI event, you may want to implement the other method of the same name instead of this one.
position
the position of the mouse cursor relative to the view’s top left-hand corner
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onMouseUp(event: event.MouseReleased): Unit
Causes an effect whenever a mouse button is released above the view.
Causes an effect whenever a mouse button is released above the view. Does nothing by default but can be overridden.
If you don’t need much information about the GUI event, you may find it simpler to implement the other method of the same name instead of this one.
event
the GUI event that caused this handler to be called
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onMouseUp(position: Pos): Unit
Causes an effect whenever a mouse button is released above the view.
Causes an effect whenever a mouse button is released above the view. Does nothing by default but can be overridden.
If the desired behavior depends on detailed information about the GUI event, you may want to implement the other method of the same name instead of this one.
position
the position of the mouse cursor relative to the view’s top left-hand corner
Definition Classes
TraceGeneratingDefaults → ControlDefaults
final def onStop(): Unit
Causes an additional effect when the view is stopped (with stop()).
Causes an additional effect when the view is stopped (with stop()). This implementation delegates to the underlying View that is being traced. In addition, if the traced view had been started with startAndGet and reaches its tick limit before being done, this method causes the returned future to complete with a failure.
Definition Classes
GeneratesTrace → Controls
def onTick(time: Long): Unit
Causes an effect whenever the view’s internal clock ticks.
Causes an effect whenever the view’s internal clock ticks. Does nothing by default but can be overridden.
If you don’t need the number of the clock tick, you may find it simpler to implement the other method of the same name instead of this one.
time
the running number of the clock tick (the first tick being number 1, the second 2, etc.)
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onTick(): Unit
Causes an effect whenever the view’s internal clock ticks.
Causes an effect whenever the view’s internal clock ticks. Does nothing by default but can be overridden.
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onType(event: event.KeyTyped): Unit
Causes an effect whenever a key on the keyboard is typed (pressed+released) while the view has the keyboard focus.
Causes an effect whenever a key on the keyboard is typed (pressed+released) while the view has the keyboard focus. Does nothing by default but can be overridden.
If you don’t need much information about the GUI event, you may find it simpler to implement the other method of the same name instead of this one.
event
the GUI event that caused this handler to be called
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onType(character: Char): Unit
Causes an effect whenever a key on the keyboard is typed (pressed+released) while the view has the keyboard focus.
Causes an effect whenever a key on the keyboard is typed (pressed+released) while the view has the keyboard focus. Does nothing by default but can be overridden.
If the desired behavior depends on detailed information about the GUI event, you may want to implement the other method of the same name instead of this one.
character
the key that was typed
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onWheel(event: event.MouseWheelMoved): Unit
Causes an effect whenever the mouse wheel is rotated above the view.
Causes an effect whenever the mouse wheel is rotated above the view. Does nothing by default but can be overridden.
If you don’t need much information about the GUI event, you may find it simpler to implement the other method of the same name instead of this one.
event
the GUI event that caused this handler to be called
Definition Classes
TraceGeneratingDefaults → ControlDefaults
def onWheel(rotation: Int): Unit
Causes an effect whenever the mouse wheel is rotated above the view.
Causes an effect whenever the mouse wheel is rotated above the view. Does nothing by default but can be overridden.
If the desired behavior depends on detailed information about the GUI event, you may want to implement the other method of the same name instead of this one.
rotation
the number of steps the wheel rotated (negative means up, positive down)
Definition Classes
TraceGeneratingDefaults → ControlDefaults
final def refresh(): Unit
Programmatically requests an update to the graphics of the view (even though no clock tick or triggering GUI event occurred).
Programmatically requests an update to the graphics of the view (even though no clock tick or triggering GUI event occurred).
Definition Classes
ViewFrame
val refreshPolicy: RefreshPolicy
Definition Classes
ViewFrame
final def simulate(tickLimit: Int = Int.MaxValue): Unit
Runs the view as if by calling start except that it runs “headless”, with no actual GUI window visible and independently of a real-time clock.
Runs the view as if by calling start except that it runs “headless”, with no actual GUI window visible and independently of a real-time clock. A number of simulated clock ticks are immediately sent to the view; this continues until either the view determines it is done or a predetermined maximum number of ticks has been reached.
tickLimit
the maximum number of ticks to simulate; Int.MaxValue (which is the default) means there is no such limit
Definition Classes
ViewFrame → Controls
final def simulateAndGet(tickLimit: Int = Int.MaxValue): Seq[(TraceData, TraceEvent)]
Simulates this trace-generating view with simulate and returns the resulting trace.
Simulates this trace-generating view with simulate and returns the resulting trace. This is equivalent to calling first simulate, then trace. See also startAndGet.
tickLimit
the maximum number of ticks to simulate; Int.MaxValue (which is the default) means there is no such limit
Definition Classes
GeneratesTrace
def sound: Option[sound.sampled.Sound]
Determines whether the view should play a sound, given the current state of its model.
Determines whether the view should play a sound, given the current state of its model. By default, no sounds are played.
returns
a Sound that the view should play; None if no sound is appropriate for the current state
Definition Classes
TraceGeneratingDefaults → ControlDefaults
final def start(): Unit
Starts the view: loads the model in the GUI window, makes the window visible oncreen, and starts the clock.
Starts the view: loads the model in the GUI window, makes the window visible oncreen, and starts the clock. Cf. simulate.
Definition Classes
ViewFrame → Controls
final def startAndGet(tickLimit: Long = Long.MaxValue): Future[Seq[(TraceData, TraceEvent)]]
Starts this trace-generating view with start and returns a Future that evaluates to the resulting trace.
Starts this trace-generating view with start and returns a Future that evaluates to the resulting trace. The Future succeeds when the view is done; if the view isn’t done after a given number of clock ticks, the Future fails with Aborted, producing a partial trace. See also simulateAndGet.
tickLimit
the maximum number of ticks to process before the future completes with a failure
Definition Classes
GeneratesTrace
final def stop(): Unit
Stops the view: stops the clock, stops listening to events, and disposes of the GUI window.
Stops the view: stops the clock, stops listening to events, and disposes of the GUI window. A stopped view cannot be restarted.
Definition Classes
ViewFrame
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
val terminateOnClose: Boolean
Definition Classes
ViewFrame
val title: String
Attributes
protected
Definition Classes
ViewFrame
final def toString: String
Returns a brief textual description of the view.
Returns a brief textual description of the view.
Definition Classes
GeneratesTrace → AnyRef → Any
final def tooltip: String
the tooltip text to be displayed while the mouse overs on the view
the tooltip text to be displayed while the mouse overs on the view
Definition Classes
ViewFrame
final def tooltip_=(newText: String): Unit
Sets the tooltip text to be displayed while the mouse overs on the view.
Sets the tooltip text to be displayed while the mouse overs on the view.
Definition Classes
ViewFrame
final def trace: Seq[(TraceData, TraceEvent)]
Returns a trace of the events processed by this view.
Returns a trace of the events processed by this view. The trace comes in a collection of pairs, each of which is composed of a TraceData value that describes at the time of the event and a TraceEvent value that describes the event itself.
Definition Classes
GeneratesTrace
final def traced: Traced[String]
Returns a View that stores a trace of the ticks and GUI events that its event handlers process.
Returns a View that stores a trace of the ticks and GUI events that its event handlers process. This parameterless method stores, at each event, the toString description of the View’s (mutable) model. This is equivalent to calling tracedWith and passing in that toString method.
Definition Classes
ControlDefaults
final def tracedPics: Traced[Pic]
Returns a View that stores a pictorial trace of the ticks and GUI events that the View’s event handlers process.
Returns a View that stores a pictorial trace of the ticks and GUI events that the View’s event handlers process. This is equivalent to calling tracedWith and passing in the View’s makePic method.
Definition Classes
ControlDefaults
final def tracedWith[TraceData](extractTrace: (Model) => TraceData): Traced[TraceData]
Returns a view that collects of the ticks and GUI events that the View’s event handlers process, using the given function to generate that trace.
Returns a view that collects of the ticks and GUI events that the View’s event handlers process, using the given function to generate that trace. That trace-collecting view, which an instance of the Traced subclass, delegates the actual event handling to this original view but provides an additional interface for tracing.
TraceData
the type of the model-state descriptions in the trace
extractTrace
a function that determines how to describe a model state in the generated trace
Definition Classes
ViewFrame → ControlDefaults
See also
traced, tracedPics
final def visible: Boolean
whether this view’s GUI frame is visible onscreen
whether this view’s GUI frame is visible onscreen
Definition Classes
ViewFrame
final def visible_=(desiredVisibility: Boolean): Unit
Sets whether this view’s GUI frame is visible onscreen.
Sets whether this view’s GUI frame is visible onscreen.
Definition Classes
ViewFrame
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
Deprecated
(Since version ) see corresponding Javadoc for more information.

Packages

Traced

final class Traced[TraceData] extends ViewFrame[Model] with TraceGeneratingDefaults[Model, TraceData]

Instance Constructors

Type Members

Value Members

Deprecated Value Members

Inherited from TraceGeneratingDefaults[Model, TraceData]

Inherited from GeneratesTrace[Model, TraceData]

Inherited from ViewFrame[Model]

Inherited from ControlDefaults[Model]

Inherited from HasModelField[Model]

Inherited from TooltipDefaults

Inherited from ViewImpl.ViewFrame[Model]

Inherited from View.Controls[Model]

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Traced

final class Traced[TraceData] extends ViewFrame[Model] with TraceGeneratingDefaults[Model, TraceData]

Instance Constructors

Type Members

Value Members

Deprecated Value Members

Inherited from TraceGeneratingDefaults[Model, TraceData]

Inherited from GeneratesTrace[Model, TraceData]

Inherited from ViewFrame[Model]

Inherited from ControlDefaults[Model]

Inherited from HasModelField[Model]

Inherited from TooltipDefaults

Inherited from ViewImpl.ViewFrame[Model]

Inherited from View.Controls[Model]

Inherited from AnyRef

Inherited from Any

Ungrouped

Traced