Traced

final class Traced[TraceData] extends ViewComponent[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], ViewComponent[Model], ControlDefaults[Model], HasModelField[Model], TooltipDefaults, ViewImpl.ViewComponent[Model], View.Controls[Model], Component, UIElement, LazyPublisher, Publisher, Reactor, Proxy, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Traced
TraceGeneratingDefaults
GeneratesTrace
ViewComponent
ControlDefaults
HasModelField
TooltipDefaults
ViewComponent
Controls
Component
UIElement
LazyPublisher
Publisher
Reactor
Proxy
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 ViewComponent[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
ViewComponent
trait SuperMixin extends JComponent
Attributes
protected
Definition Classes
Component

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
ViewComponent
final def asInstanceOf[T0]: T0
Definition Classes
Any
def background: scala.swing.Color
Definition Classes
UIElement
def background_=(c: scala.swing.Color): Unit
Definition Classes
UIElement
def border: Border
Definition Classes
Component
def border_=(b: Border): Unit
Definition Classes
Component
def bounds: Rectangle
Definition Classes
UIElement
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
def componentOrientation: ComponentOrientation
Definition Classes
UIElement
def componentOrientation_=(x: ComponentOrientation): Unit
Definition Classes
UIElement
def cursor: Cursor
Definition Classes
UIElement
def cursor_=(c: Cursor): Unit
Definition Classes
UIElement
def deafTo(ps: Publisher*): Unit
Definition Classes
Reactor
def displayable: Boolean
Definition Classes
UIElement
def enabled: Boolean
Definition Classes
Component
def enabled_=(b: Boolean): Unit
Definition Classes
Component
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(that: Any): Boolean
Definition Classes
Proxy → Any
def focusable: Boolean
Definition Classes
Component
def focusable_=(b: Boolean): Unit
Definition Classes
Component
def font: Font
Definition Classes
UIElement
def font_=(f: Font): Unit
Definition Classes
UIElement
def foreground: scala.swing.Color
Definition Classes
UIElement
def foreground_=(c: scala.swing.Color): Unit
Definition Classes
UIElement
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
def hasFocus: Boolean
Definition Classes
Component
def hashCode(): Int
Definition Classes
Proxy → Any
def ignoreRepaint: Boolean
Definition Classes
UIElement
def ignoreRepaint_=(b: Boolean): Unit
Definition Classes
UIElement
def inputVerifier: (Component) => Boolean
Definition Classes
Component
def inputVerifier_=(v: (Component) => Boolean): Unit
Definition Classes
Component
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 listenTo(ps: Publisher*): Unit
Definition Classes
Reactor
val listeners: RefSet[Reaction]
Attributes
protected
Definition Classes
Publisher
def locale: Locale
Definition Classes
UIElement
def location: Point
Definition Classes
UIElement
def locationOnScreen: Point
Definition Classes
UIElement
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 maximumSize: Dimension
Definition Classes
UIElement
def maximumSize_=(x: Dimension): Unit
Definition Classes
UIElement
def minimumSize: Dimension
Definition Classes
UIElement
def minimumSize_=(x: Dimension): Unit
Definition Classes
UIElement
def model: Model
the model object represented in the view.
the model object represented in the view.
Definition Classes
HasModelField
def name: String
Definition Classes
Component
def name_=(s: String): Unit
Definition Classes
Component
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 onFirstSubscribe(): Unit
Attributes
protected
Definition Classes
Component → UIElement → LazyPublisher
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 onLastUnsubscribe(): Unit
Attributes
protected
Definition Classes
UIElement → LazyPublisher
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
def opaque: Boolean
Definition Classes
Component
def opaque_=(b: Boolean): Unit
Definition Classes
Component
def paint(g: Graphics2D): Unit
Definition Classes
Component
def paintBorder(g: Graphics2D): Unit
Attributes
protected
Definition Classes
Component
def paintChildren(g: Graphics2D): Unit
Attributes
protected
Definition Classes
Component
final def paintComponent(myGraphics: Graphics2D): Unit
Renders the view as a Java AWT BufferedImage onto the component.
Renders the view as a Java AWT BufferedImage onto the component.
Definition Classes
ViewComponent → Component
lazy val peer: JComponent
Definition Classes
Component → UIElement
def preferredSize: Dimension
Definition Classes
UIElement
def preferredSize_=(x: Dimension): Unit
Definition Classes
UIElement
def publish(e: Event): Unit
Definition Classes
Publisher
val reactions: Reactions
Definition Classes
Reactor
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
ViewComponent
val refreshPolicy: RefreshPolicy
Definition Classes
ViewComponent
def repaint(rect: Rectangle): Unit
Definition Classes
UIElement
def repaint(): Unit
Definition Classes
UIElement
def requestFocus(): Unit
Definition Classes
Component
def requestFocusInWindow(): Boolean
Definition Classes
Component
def revalidate(): Unit
Definition Classes
Component
def self: Any
Definition Classes
UIElement → Proxy
def showing: Boolean
Definition Classes
UIElement
final def simulate(tickLimit: Int = Int.MaxValue): Unit
Runs the view as if by calling start except that it runs “headless”, without expectation of being visible in a GUI and independently of a real-time clock.
Runs the view as if by calling start except that it runs “headless”, without expectation of being visible in a GUI 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
ViewComponent → 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 size: Dimension
Definition Classes
UIElement
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 into the component and starts the clock.
Starts the view: loads the model into the component and starts the clock. Cf. simulate.
Definition Classes
ViewComponent → 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 and stops listening to events.
Stops the view: stops the clock and stops listening to events. A stopped view cannot be restarted.
Definition Classes
ViewComponent
def subscribe(listener: Reaction): Unit
Definition Classes
LazyPublisher → Publisher
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
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
def toolkit: Toolkit
Definition Classes
UIElement
def tooltip: String
Definition Classes
Component
def tooltip_=(t: String): Unit
Definition Classes
Component
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
ViewComponent → ControlDefaults
See also
traced, tracedPics
def unsubscribe(listener: Reaction): Unit
Definition Classes
LazyPublisher → Publisher
def validate(): Unit
Definition Classes
UIElement
def visible: Boolean
Definition Classes
UIElement
def visible_=(b: Boolean): Unit
Definition Classes
UIElement
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])
def xLayoutAlignment: Double
Definition Classes
Component
def xLayoutAlignment_=(x: Double): Unit
Definition Classes
Component
def yLayoutAlignment: Double
Definition Classes
Component
def yLayoutAlignment_=(y: Double): Unit
Definition Classes
Component
object keys extends Publisher
Definition Classes
Component
object mouse
Definition Classes
Component

Inherited from TraceGeneratingDefaults[Model, TraceData]

Value Members

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

Inherited from GeneratesTrace[Model, TraceData]

Value Members

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

Inherited from ViewComponent[Model]

Value Members

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
ViewComponent → ControlDefaults
See also
traced, tracedPics

Inherited from ControlDefaults[Model]

Value Members

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

Inherited from HasModelField[Model]

Value Members

def model: Model
the model object represented in the view.
the model object represented in the view.
Definition Classes
HasModelField

Inherited from ViewImpl.ViewComponent[Model]

Value Members

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
ViewComponent
final def paintComponent(myGraphics: Graphics2D): Unit
Renders the view as a Java AWT BufferedImage onto the component.
Renders the view as a Java AWT BufferedImage onto the component.
Definition Classes
ViewComponent → Component
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
ViewComponent
val refreshPolicy: RefreshPolicy
Definition Classes
ViewComponent
final def simulate(tickLimit: Int = Int.MaxValue): Unit
Runs the view as if by calling start except that it runs “headless”, without expectation of being visible in a GUI and independently of a real-time clock.
Runs the view as if by calling start except that it runs “headless”, without expectation of being visible in a GUI 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
ViewComponent → Controls
final def start(): Unit
Starts the view: loads the model into the component and starts the clock.
Starts the view: loads the model into the component and starts the clock. Cf. simulate.
Definition Classes
ViewComponent → Controls
final def stop(): Unit
Stops the view: stops the clock and stops listening to events.
Stops the view: stops the clock and stops listening to events. A stopped view cannot be restarted.
Definition Classes
ViewComponent

Inherited from Component

Value Members

def border: Border
Definition Classes
Component
def border_=(b: Border): Unit
Definition Classes
Component
def enabled: Boolean
Definition Classes
Component
def enabled_=(b: Boolean): Unit
Definition Classes
Component
def focusable: Boolean
Definition Classes
Component
def focusable_=(b: Boolean): Unit
Definition Classes
Component
def hasFocus: Boolean
Definition Classes
Component
def inputVerifier: (Component) => Boolean
Definition Classes
Component
def inputVerifier_=(v: (Component) => Boolean): Unit
Definition Classes
Component
def name: String
Definition Classes
Component
def name_=(s: String): Unit
Definition Classes
Component
def onFirstSubscribe(): Unit
Attributes
protected
Definition Classes
Component → UIElement → LazyPublisher
def opaque: Boolean
Definition Classes
Component
def opaque_=(b: Boolean): Unit
Definition Classes
Component
def paint(g: Graphics2D): Unit
Definition Classes
Component
def paintBorder(g: Graphics2D): Unit
Attributes
protected
Definition Classes
Component
def paintChildren(g: Graphics2D): Unit
Attributes
protected
Definition Classes
Component
lazy val peer: JComponent
Definition Classes
Component → UIElement
def requestFocus(): Unit
Definition Classes
Component
def requestFocusInWindow(): Boolean
Definition Classes
Component
def revalidate(): Unit
Definition Classes
Component
def tooltip: String
Definition Classes
Component
def tooltip_=(t: String): Unit
Definition Classes
Component
def xLayoutAlignment: Double
Definition Classes
Component
def xLayoutAlignment_=(x: Double): Unit
Definition Classes
Component
def yLayoutAlignment: Double
Definition Classes
Component
def yLayoutAlignment_=(y: Double): Unit
Definition Classes
Component

Inherited from UIElement

Value Members

def background: scala.swing.Color
Definition Classes
UIElement
def background_=(c: scala.swing.Color): Unit
Definition Classes
UIElement
def bounds: Rectangle
Definition Classes
UIElement
def componentOrientation: ComponentOrientation
Definition Classes
UIElement
def componentOrientation_=(x: ComponentOrientation): Unit
Definition Classes
UIElement
def cursor: Cursor
Definition Classes
UIElement
def cursor_=(c: Cursor): Unit
Definition Classes
UIElement
def displayable: Boolean
Definition Classes
UIElement
def font: Font
Definition Classes
UIElement
def font_=(f: Font): Unit
Definition Classes
UIElement
def foreground: scala.swing.Color
Definition Classes
UIElement
def foreground_=(c: scala.swing.Color): Unit
Definition Classes
UIElement
def ignoreRepaint: Boolean
Definition Classes
UIElement
def ignoreRepaint_=(b: Boolean): Unit
Definition Classes
UIElement
def locale: Locale
Definition Classes
UIElement
def location: Point
Definition Classes
UIElement
def locationOnScreen: Point
Definition Classes
UIElement
def maximumSize: Dimension
Definition Classes
UIElement
def maximumSize_=(x: Dimension): Unit
Definition Classes
UIElement
def minimumSize: Dimension
Definition Classes
UIElement
def minimumSize_=(x: Dimension): Unit
Definition Classes
UIElement
def onLastUnsubscribe(): Unit
Attributes
protected
Definition Classes
UIElement → LazyPublisher
def preferredSize: Dimension
Definition Classes
UIElement
def preferredSize_=(x: Dimension): Unit
Definition Classes
UIElement
def repaint(rect: Rectangle): Unit
Definition Classes
UIElement
def repaint(): Unit
Definition Classes
UIElement
def self: Any
Definition Classes
UIElement → Proxy
def showing: Boolean
Definition Classes
UIElement
def size: Dimension
Definition Classes
UIElement
def toolkit: Toolkit
Definition Classes
UIElement
def validate(): Unit
Definition Classes
UIElement
def visible: Boolean
Definition Classes
UIElement
def visible_=(b: Boolean): Unit
Definition Classes
UIElement

Inherited from LazyPublisher

Value Members

def subscribe(listener: Reaction): Unit
Definition Classes
LazyPublisher → Publisher
def unsubscribe(listener: Reaction): Unit
Definition Classes
LazyPublisher → Publisher

Inherited from Publisher

Value Members

val listeners: RefSet[Reaction]
Attributes
protected
Definition Classes
Publisher
def publish(e: Event): Unit
Definition Classes
Publisher

Inherited from Reactor

Value Members

def deafTo(ps: Publisher*): Unit
Definition Classes
Reactor
def listenTo(ps: Publisher*): Unit
Definition Classes
Reactor
val reactions: Reactions
Definition Classes
Reactor

Inherited from Proxy

Value Members

def equals(that: Any): Boolean
Definition Classes
Proxy → Any
def hashCode(): Int
Definition Classes
Proxy → Any

Inherited from AnyRef

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
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
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()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
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])
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.

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0
Definition Classes
Any
final def isInstanceOf[T0]: Boolean
Definition Classes
Any

Ungrouped

final class Traced[TraceData] extends ViewComponent[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
ViewComponent
trait SuperMixin extends JComponent
Attributes
protected
Definition Classes
Component

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
ViewComponent
final def asInstanceOf[T0]: T0
Definition Classes
Any
def background: scala.swing.Color
Definition Classes
UIElement
def background_=(c: scala.swing.Color): Unit
Definition Classes
UIElement
def border: Border
Definition Classes
Component
def border_=(b: Border): Unit
Definition Classes
Component
def bounds: Rectangle
Definition Classes
UIElement
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
def componentOrientation: ComponentOrientation
Definition Classes
UIElement
def componentOrientation_=(x: ComponentOrientation): Unit
Definition Classes
UIElement
def cursor: Cursor
Definition Classes
UIElement
def cursor_=(c: Cursor): Unit
Definition Classes
UIElement
def deafTo(ps: Publisher*): Unit
Definition Classes
Reactor
def displayable: Boolean
Definition Classes
UIElement
def enabled: Boolean
Definition Classes
Component
def enabled_=(b: Boolean): Unit
Definition Classes
Component
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(that: Any): Boolean
Definition Classes
Proxy → Any
def focusable: Boolean
Definition Classes
Component
def focusable_=(b: Boolean): Unit
Definition Classes
Component
def font: Font
Definition Classes
UIElement
def font_=(f: Font): Unit
Definition Classes
UIElement
def foreground: scala.swing.Color
Definition Classes
UIElement
def foreground_=(c: scala.swing.Color): Unit
Definition Classes
UIElement
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
def hasFocus: Boolean
Definition Classes
Component
def hashCode(): Int
Definition Classes
Proxy → Any
def ignoreRepaint: Boolean
Definition Classes
UIElement
def ignoreRepaint_=(b: Boolean): Unit
Definition Classes
UIElement
def inputVerifier: (Component) => Boolean
Definition Classes
Component
def inputVerifier_=(v: (Component) => Boolean): Unit
Definition Classes
Component
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 listenTo(ps: Publisher*): Unit
Definition Classes
Reactor
val listeners: RefSet[Reaction]
Attributes
protected
Definition Classes
Publisher
def locale: Locale
Definition Classes
UIElement
def location: Point
Definition Classes
UIElement
def locationOnScreen: Point
Definition Classes
UIElement
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 maximumSize: Dimension
Definition Classes
UIElement
def maximumSize_=(x: Dimension): Unit
Definition Classes
UIElement
def minimumSize: Dimension
Definition Classes
UIElement
def minimumSize_=(x: Dimension): Unit
Definition Classes
UIElement
def model: Model
the model object represented in the view.
the model object represented in the view.
Definition Classes
HasModelField
def name: String
Definition Classes
Component
def name_=(s: String): Unit
Definition Classes
Component
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 onFirstSubscribe(): Unit
Attributes
protected
Definition Classes
Component → UIElement → LazyPublisher
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 onLastUnsubscribe(): Unit
Attributes
protected
Definition Classes
UIElement → LazyPublisher
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
def opaque: Boolean
Definition Classes
Component
def opaque_=(b: Boolean): Unit
Definition Classes
Component
def paint(g: Graphics2D): Unit
Definition Classes
Component
def paintBorder(g: Graphics2D): Unit
Attributes
protected
Definition Classes
Component
def paintChildren(g: Graphics2D): Unit
Attributes
protected
Definition Classes
Component
final def paintComponent(myGraphics: Graphics2D): Unit
Renders the view as a Java AWT BufferedImage onto the component.
Renders the view as a Java AWT BufferedImage onto the component.
Definition Classes
ViewComponent → Component
lazy val peer: JComponent
Definition Classes
Component → UIElement
def preferredSize: Dimension
Definition Classes
UIElement
def preferredSize_=(x: Dimension): Unit
Definition Classes
UIElement
def publish(e: Event): Unit
Definition Classes
Publisher
val reactions: Reactions
Definition Classes
Reactor
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
ViewComponent
val refreshPolicy: RefreshPolicy
Definition Classes
ViewComponent
def repaint(rect: Rectangle): Unit
Definition Classes
UIElement
def repaint(): Unit
Definition Classes
UIElement
def requestFocus(): Unit
Definition Classes
Component
def requestFocusInWindow(): Boolean
Definition Classes
Component
def revalidate(): Unit
Definition Classes
Component
def self: Any
Definition Classes
UIElement → Proxy
def showing: Boolean
Definition Classes
UIElement
final def simulate(tickLimit: Int = Int.MaxValue): Unit
Runs the view as if by calling start except that it runs “headless”, without expectation of being visible in a GUI and independently of a real-time clock.
Runs the view as if by calling start except that it runs “headless”, without expectation of being visible in a GUI 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
ViewComponent → 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 size: Dimension
Definition Classes
UIElement
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 into the component and starts the clock.
Starts the view: loads the model into the component and starts the clock. Cf. simulate.
Definition Classes
ViewComponent → 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 and stops listening to events.
Stops the view: stops the clock and stops listening to events. A stopped view cannot be restarted.
Definition Classes
ViewComponent
def subscribe(listener: Reaction): Unit
Definition Classes
LazyPublisher → Publisher
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
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
def toolkit: Toolkit
Definition Classes
UIElement
def tooltip: String
Definition Classes
Component
def tooltip_=(t: String): Unit
Definition Classes
Component
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
ViewComponent → ControlDefaults
See also
traced, tracedPics
def unsubscribe(listener: Reaction): Unit
Definition Classes
LazyPublisher → Publisher
def validate(): Unit
Definition Classes
UIElement
def visible: Boolean
Definition Classes
UIElement
def visible_=(b: Boolean): Unit
Definition Classes
UIElement
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])
def xLayoutAlignment: Double
Definition Classes
Component
def xLayoutAlignment_=(x: Double): Unit
Definition Classes
Component
def yLayoutAlignment: Double
Definition Classes
Component
def yLayoutAlignment_=(y: Double): Unit
Definition Classes
Component
object keys extends Publisher
Definition Classes
Component
object mouse
Definition Classes
Component
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 ViewComponent[Model] with TraceGeneratingDefaults[Model, TraceData]

Instance Constructors

Type Members

Value Members

Deprecated Value Members

Inherited from TraceGeneratingDefaults[Model, TraceData]

Value Members

Inherited from GeneratesTrace[Model, TraceData]

Value Members

Inherited from ViewComponent[Model]

Value Members

Inherited from ControlDefaults[Model]

Value Members

Inherited from HasModelField[Model]

Value Members

Inherited from ViewImpl.ViewComponent[Model]

Value Members

Inherited from Component

Value Members

Inherited from UIElement

Value Members

Inherited from LazyPublisher

Value Members

Inherited from Publisher

Value Members

Inherited from Reactor

Value Members

Inherited from Proxy

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

Packages

Traced

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

Instance Constructors

Type Members

Value Members

Deprecated Value Members

Inherited from TraceGeneratingDefaults[Model, TraceData]

Value Members

Inherited from GeneratesTrace[Model, TraceData]

Value Members

Inherited from ViewComponent[Model]

Value Members

Inherited from ControlDefaults[Model]

Value Members

Inherited from HasModelField[Model]

Value Members

Inherited from ViewImpl.ViewComponent[Model]

Value Members

Inherited from Component

Value Members

Inherited from UIElement

Value Members

Inherited from LazyPublisher

Value Members

Inherited from Publisher

Value Members

Inherited from Reactor

Value Members

Inherited from Proxy

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

Traced