Traced
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) do
println(traceEvent + ": " + traceItem)
Or, equivalently:
myTracedView.simulate(500)
for (traceItem, traceEvent) <- myTracedView.trace do
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 do
println(traceEvent + ": " + traceItem)
- Type parameters:
- TraceData
the type of the model-state descriptions in the trace
- Value parameters:
- extractTrace
a function that determines how to describe a model state in the generated trace
Type members
Inherited classlikes
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.
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) do
println(traceEvent + ": " + traceItem)
Or, equivalently:
myTracedView.simulate(500)
for (traceItem, traceEvent) <- myTracedView.trace do
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 do
println(traceEvent + ": " + traceItem)
- Type parameters:
- TraceData
the type of the model-state descriptions in the trace
- Value parameters:
- extractTrace
a function that determines how to describe a model state in the generated trace
- Inherited from:
- ViewComponent
Value members
Inherited methods
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.
- Inherited from:
- ViewComponentImpl
Installed reaction won't receive events from the given publisher anylonger.
Installed reaction won't receive events from the given publisher anylonger.
- Inherited from:
- Reactor
Compares the receiver object (this
) with the argument object (that
) for equivalence.
Compares the receiver object (this
) with the argument object (that
) for equivalence.
Any implementation of this method should be an equivalence relation:
- It is reflexive: for any instance
x
of typeAny
,x.equals(x)
should returntrue
. - It is symmetric: for any instances
x
andy
of typeAny
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any instances
x
,y
, andz
of typeAny
ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
.
If you override this method, you should verify that your implementation remains an equivalence relation.
Additionally, when overriding this method it is usually necessary to override hashCode
to ensure that
objects which are "equal" (o1.equals(o2)
returns true
) hash to the same scala.Int.
(o1.hashCode.equals(o2.hashCode)
).
- Value parameters:
- that
the object to compare against this object for equality.
- Returns:
true
if the receiver object is equivalent to the argument;false
otherwise.- Definition Classes
- Inherited from:
- Proxy
Calculate a hash code value for the object.
Calculate a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)
) yet
not be equal (o1.equals(o2)
returns false
). A degenerate implementation could always return 0
.
However, it is required that if two objects are equal (o1.equals(o2)
returns true
) that they have
identical hash codes (o1.hashCode.equals(o2.hashCode)
). Therefore, when overriding this method, be sure
to verify that the behavior is consistent with the equals
method.
- Returns:
the hash code value for this object.
- Definition Classes
- Inherited from:
- Proxy
Determines if the given state is a “done state” for the view.
This implementation delegates to the underlying View
that is being traced.
Determines if the given state is a “done state” for the view.
This implementation delegates to the underlying View
that is being traced.
- Value parameters:
- state
a state of the model (possibly a done state)
- Definition Classes
- Inherited from:
- TraceGeneratingView
Indicates whether the view is paused. This implementation delegates
to the underlying View
that is being traced.
Indicates whether the view is paused. This implementation delegates
to the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- GeneratesTrace
Listen to the given publisher as long as deafTo
isn't called for
them.
Listen to the given publisher as long as deafTo
isn't called for
them.
- Inherited from:
- Reactor
Returns a Pic that graphically represents the current state of the view’s model
object.
This implementation delegates to the underlying View
that is being traced.
Returns a Pic that graphically represents the current state of the view’s model
object.
This implementation delegates to the underlying View
that is being traced.
- Value parameters:
- state
a state of the model to be displayed
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
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.
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
- Inherited from:
- GeneratesTrace
Handles a clock tick and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a clock tick and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a clock tick and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a clock tick and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
Handles a GUI event and adds it to the view’s trace. Delegates the actual event-handling
to the corresponding method on the underlying View
that is being traced.
- Definition Classes
- Inherited from:
- TraceGeneratingView
Renders the view as a Java AWT BufferedImage
onto the component.
Renders the view as a Java AWT BufferedImage
onto the component.
- Definition Classes
- Inherited from:
- ViewComponentImpl
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).
- Inherited from:
- ViewComponentImpl
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.
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.
- Value parameters:
- tickLimit
the maximum number of ticks to simulate;
Int.MaxValue
(which is the default) means there is no such limit
- Inherited from:
- ViewComponentImpl
Simulates this trace-generating view with simulate and returns the resulting trace. This is equivalent to calling first simulate, then trace. See also startAndGet.
Simulates this trace-generating view with simulate and returns the resulting trace. This is equivalent to calling first simulate, then trace. See also startAndGet.
- Value parameters:
- tickLimit
the maximum number of ticks to simulate;
Int.MaxValue
(which is the default) means there is no such limit
- Inherited from:
- GeneratesTrace
Determines whether the view should play a sound, given a state of its model.
This implementation delegates to the underlying underlying View
that is being traced.
Determines whether the view should play a sound, given a state of its model.
This implementation delegates to the underlying underlying View
that is being traced.
- Value parameters:
- state
a state of the model
- Definition Classes
- Inherited from:
- TraceGeneratingView
Starts the view: loads the model into the component and starts the clock. Cf. simulate.
Starts the view: loads the model into the component and starts the clock. Cf. simulate.
- Inherited from:
- ViewComponentImpl
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
TraceAborted, producing a partial trace. See also simulateAndGet.
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
TraceAborted, producing a partial trace. See also simulateAndGet.
- Value parameters:
- tickLimit
the maximum number of ticks to process before the future completes with a failure; defaults to
Long.MaxValue
- Inherited from:
- GeneratesTrace
Stops the view: stops the clock and stops listening to events. A stopped view cannot be restarted.
Stops the view: stops the clock and stops listening to events. A stopped view cannot be restarted.
- Inherited from:
- ViewComponentImpl
Returns a brief textual description of the view.
Returns a brief textual description of the view.
- Definition Classes
- Inherited from:
- GeneratesTrace
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.
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.
- Inherited from:
- GeneratesTrace
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 (immutable) state of the
View
’s model. This is equivalent to calling tracedWith and passing in identity
.
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 (immutable) state of the
View
’s model. This is equivalent to calling tracedWith and passing in identity
.
- Inherited from:
- Controls
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.
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.
- Inherited from:
- Controls
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.
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.
- Type parameters:
- TraceData
the type of the model-state descriptions in the trace
- Value parameters:
- extractTrace
a function that determines how to describe a model state in the generated trace
- See also:
- Inherited from:
- ViewComponent
Used by certain layout managers, e.g., BoxLayout or OverlayLayout to align components relative to each other.
Used by certain layout managers, e.g., BoxLayout or OverlayLayout to align components relative to each other.
- Inherited from:
- Component