TraceGeneratingView
Value members
Concrete methods
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.
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
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.
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
Pic
s of equal dimensions.
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.
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.
- Value parameters:
- position
the position of the mouse cursor relative to the view’s top left-hand corner
- Definition Classes
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.
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.
- Value parameters:
- event
the GUI event that caused this handler to be called
- Definition Classes
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.
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.
- Value parameters:
- key
the key that was pressed down
- Definition Classes
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.
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.
- Value parameters:
- event
the GUI event that caused this handler to be called
- Definition Classes
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.
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.
- Value parameters:
- key
the key that was released
- Definition Classes
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.
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.
- Value parameters:
- event
the GUI event that caused this handler to be called
- Definition Classes
Causes an effect whenever a mouse button is pressed down above the view. Does nothing by default but can be overridden.
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.
- Value parameters:
- position
the position of the mouse cursor relative to the view’s top left-hand corner
- Definition Classes
Causes an effect whenever a mouse button is pressed down above the view. Does nothing by default but can be overridden.
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.
- Value parameters:
- event
the GUI event that caused this handler to be called
- Definition Classes
Causes an effect whenever the mouse cursor is dragged above the view. Does nothing by default but can be overridden.
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.
- Value parameters:
- position
the position of the mouse cursor relative to the view’s top left-hand corner
- Definition Classes
Causes an effect whenever the mouse cursor is dragged above the view. Does nothing by default but can be overridden.
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.
- Value parameters:
- event
the GUI event that caused this handler to be called
- Definition Classes
Causes an effect whenever the mouse cursor enters the view. Does nothing by default but can be overridden.
Causes an effect whenever the mouse cursor enters the view. Does nothing by default but can be overridden.
- Value parameters:
- event
the GUI event that caused this handler to be called
- Definition Classes
Causes an effect whenever the mouse cursor exits the view. Does nothing by default but can be overridden.
Causes an effect whenever the mouse cursor exits the view. Does nothing by default but can be overridden.
- Value parameters:
- event
the GUI event that caused this handler to be called
- Definition Classes
Causes an effect whenever the mouse cursor moves above the view. Does nothing by default but can be overridden.
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.
- Value parameters:
- position
the position of the mouse cursor relative to the view’s top left-hand corner
- Definition Classes
Causes an effect whenever the mouse cursor moves above the view. Does nothing by default but can be overridden.
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.
- Value parameters:
- event
the GUI event that caused this handler to be called
- Definition Classes
Causes an effect whenever a mouse button is released above the view. Does nothing by default but can be overridden.
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.
- Value parameters:
- position
the position of the mouse cursor relative to the view’s top left-hand corner
- Definition Classes
Causes an effect whenever a mouse button is released above the view. Does nothing by default but can be overridden.
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.
- Value parameters:
- event
the GUI event that caused this handler to be called
- Definition Classes
Causes an effect whenever the view’s internal clock ticks. Does nothing by default but can be overridden.
Causes an effect whenever the view’s internal clock ticks. Does nothing by default but can be overridden.
- Definition Classes
Causes an effect whenever the view’s internal clock ticks. Does nothing by default but can be overridden.
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.
- Value parameters:
- time
the running number of the clock tick (the first tick being number 1, the second 2, etc.)
- Definition Classes
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.
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.
- Value parameters:
- character
the key that was typed
- Definition Classes
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.
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.
- Value parameters:
- event
the GUI event that caused this handler to be called
- Definition Classes
Causes an effect whenever the mouse wheel is rotated above the view. Does nothing by default but can be overridden.
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.
- Value parameters:
- rotation
the number of steps the wheel rotated (negative means up, positive down)
- Definition Classes
Causes an effect whenever the mouse wheel is rotated above the view. Does nothing by default but can be overridden.
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.
- Value parameters:
- event
the GUI event that caused this handler to be called
- Definition Classes
Inherited methods
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
the model object represented in the view.
the model object represented in the view.
- Inherited from:
- HasModelField (hidden)
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
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:
- Controls
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
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
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 toString
description of
the View
’s (mutable) model. This is equivalent to calling tracedWith and passing in
that toString
method.
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.
- 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