ViewComponent

abstract class ViewComponent[Model <: AnyRef](val initialModel: Model, tickRate: Double, initialDelay: Int, refreshPolicy: RefreshPolicy) extends ViewComponentImpl[Model] with Controls[Model]

A Swing-embeddable view (complete with a picture, a ticking clock, event handlers, etc.). It works like a ViewFrame except that it’s a Swing component, not a standalone GUI frame. See ViewFrame for an overview.

Type parameters:
Model

the type of the model object

Value parameters:
initialDelay

an additional delay in milliseconds between calling start and the clock starting (optional; defaults to 600)

initialModel

the model to be displayed in the view (the only required parameter). It usually makes sense to use a mutable object here and change its state via the event handlers (cf. o1.gui.immutable.ViewComponent).

refreshPolicy

a policy for how eagerly the view should try to update the graphical representation of its model (optional; changing this may improve efficiency in some circumstances)

tickRate

the clock of the view will tick roughly this many times per second (optional; defaults to 24)

trait Controls[Model]
trait Fast
class ViewComponentImpl[Model]
class Component
trait UIElement
trait Publisher
trait Reactor
trait Proxy
class Object
trait Matchable
class Any
class Traced[TraceData]

Type members

Classlikes

final class Traced[TraceData](val extractTrace: Model => TraceData) extends ViewComponent[Model] with TraceGeneratingView[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.

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 classlikes

object keys extends Publisher
Inherited from:
Component
object mouse

Contains publishers for various mouse events. They are separated for efficiency reasons.

Contains publishers for various mouse events. They are separated for efficiency reasons.

Inherited from:
Component

Value members

Concrete methods

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

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.

Inherited from:
ViewComponentImpl
Inherited from:
UIElement
Inherited from:
UIElement
Inherited from:
Component
Inherited from:
Component
Inherited from:
UIElement
Inherited from:
UIElement
Inherited from:
UIElement
def deafTo(ps: Publisher*): Unit

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
Inherited from:
UIElement
Inherited from:
Component
Inherited from:
Component
override def equals(that: Any): Boolean

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 type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

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
Inherited from:
Component
Inherited from:
Component
def font: Font
Inherited from:
UIElement
def font_=(f: Font): Unit
Inherited from:
UIElement
Inherited from:
UIElement
Inherited from:
UIElement
Inherited from:
Component
override def hashCode(): Int

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
Inherited from:
UIElement
Inherited from:
UIElement
Inherited from:
Component

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.

Inherited from:
Controls
override def isPaused: Boolean

Indicates whether the view is paused. By default, always returns false.

Indicates whether the view is paused. By default, always returns false.

See also:
Definition Classes
Inherited from:
Controls

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
Inherited from:
UIElement
Inherited from:
UIElement
Inherited from:
UIElement

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 Pics of equal dimensions.

Inherited from:
Controls
Inherited from:
UIElement
Inherited from:
UIElement
Inherited from:
UIElement
Inherited from:
UIElement
def model: Model

the model object represented in the view.

the model object represented in the view.

Inherited from:
HasModelField (hidden)
Inherited from:
Component
def name_=(s: String): Unit
Inherited from:
Component

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

Inherited from:
Controls
def onClick(position: Pos): Unit

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

Inherited from:
Controls

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

Inherited from:
Controls
def onKeyDown(key: Key): Unit

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

Inherited from:
Controls
def onKeyUp(event: KeyReleased): Unit

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

Inherited from:
Controls
def onKeyUp(key: Key): Unit

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

Inherited from:
Controls

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

Inherited from:
Controls
def onMouseDown(position: Pos): Unit

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

Inherited from:
Controls

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

Inherited from:
Controls
def onMouseDrag(position: Pos): Unit

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

Inherited from:
Controls

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

Inherited from:
Controls

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

Inherited from:
Controls

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

Inherited from:
Controls
def onMouseMove(position: Pos): Unit

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

Inherited from:
Controls

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

Inherited from:
Controls
def onMouseUp(position: Pos): Unit

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

Inherited from:
Controls
override def onStop(): Unit

Causes an additional effect when the view is stopped (with stop()). By default, this method does nothing.

Causes an additional effect when the view is stopped (with stop()). By default, this method does nothing.

Definition Classes
Inherited from:
Controls
def onTick(time: Long): Unit

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

Inherited from:
Controls
def onTick(): Unit

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.

Inherited from:
Controls
def onType(event: KeyTyped): Unit

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

Inherited from:
Controls
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. 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

Inherited from:
Controls

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

Inherited from:
Controls
def onWheel(rotation: Int): Unit

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)

Inherited from:
Controls
Inherited from:
Component
Inherited from:
Component
Inherited from:
Component
final override 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
Inherited from:
ViewComponentImpl
Inherited from:
UIElement
Inherited from:
UIElement
def publish(e: Event): Unit

Notify all registered reactions.

Notify all registered reactions.

Inherited from:
Publisher
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).

Inherited from:
ViewComponentImpl
def repaint(rect: Rectangle): Unit
Inherited from:
UIElement
def repaint(): Unit
Inherited from:
UIElement
Inherited from:
Component
Inherited from:
Component
def self: Any
Inherited from:
UIElement
Inherited from:
UIElement
final def simulate(tickLimit: Int): 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. 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
Inherited from:
UIElement

Determines whether the view should play a sound, given the current state of its model. By default, no sounds are played.

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

Inherited from:
Controls
final def start(): Unit

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
final def stop(): Unit

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
override def subscribe(listener: Reaction): Unit
Definition Classes
Inherited from:
LazyPublisher (hidden)
override def toString: String

Returns a brief textual description of the view.

Returns a brief textual description of the view.

Definition Classes
Inherited from:
ViewComponentImpl
Inherited from:
UIElement
Inherited from:
Component
Inherited from:
Component
final def traced: Traced[String]

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
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. 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
override def unsubscribe(listener: Reaction): Unit
Definition Classes
Inherited from:
LazyPublisher (hidden)
def validate(): Unit
Inherited from:
UIElement
Inherited from:
UIElement
Inherited from:
UIElement

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
Inherited from:
Component
Inherited from:
Component
Inherited from:
Component

Inherited fields

protected val listeners: RefSet[Reaction]
Inherited from:
Publisher
lazy override val peer: JComponent

The underlying Swing peer.

The underlying Swing peer.

Inherited from:
Component

All reactions of this reactor.

All reactions of this reactor.

Inherited from:
Reactor