O1Library Docs
Fall 2024
DocsAPI
Generated with
This document is part of the ebook for O1 (aka CS-A1110 Programming 1), a course at Aalto University.
This document is part of the ebook for O1 (aka CS-A1110 Programming 1), a course at Aalto University.
O1Library Docs/o1/o1.gui/o1.gui.viewimpl/ViewComponentImpl

ViewComponentImpl

o1.gui.viewimpl.ViewComponentImpl
abstract class ViewComponentImpl[Model <: Matchable](val initialState: Model, tickRate: Double, initialDelay: Int, val refreshPolicy: RefreshPolicy) extends Component

Attributes

Graph
Supertypes
class Component
trait UIElement
trait Publisher
trait Reactor
trait Proxy
class Object
trait Matchable
class Any
Show all
Known subtypes
class ViewComponent[Model]
class Traced[TraceData]
class ViewComponent[Model]
class Traced[TraceData]
Self type

Members list

Type members

Inherited classlikes

object keys extends Publisher

Attributes

Inherited from:
Component
Supertypes
trait Publisher
trait Reactor
class Object
trait Matchable
class Any
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.

Attributes

Inherited from:
Component
Supertypes
class Object
trait Matchable
class Any

Value members

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

Attributes

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.

Attributes

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

Attributes

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.

Parameters

tickLimit

the maximum number of ticks to simulate; Int.MaxValue (which is the default) means there is no such limit

Attributes

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.

Attributes

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.

Attributes

override def toString: String

Returns a brief textual description of the view.

Returns a brief textual description of the view.

Attributes

Definition Classes

Inherited methods

def background: Color

Attributes

Inherited from:
UIElement
def background_=(c: Color): Unit

Attributes

Inherited from:
UIElement
def border: Border

Attributes

Inherited from:
Component
def border_=(b: Border): Unit

Attributes

Inherited from:
Component
def bounds: Rectangle

Attributes

Inherited from:
UIElement
def componentOrientation: ComponentOrientation

Attributes

Inherited from:
UIElement
def componentOrientation_=(x: ComponentOrientation): Unit

Attributes

Inherited from:
UIElement
def cursor: Cursor

Attributes

Inherited from:
UIElement
def cursor_=(c: Cursor): Unit

Attributes

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.

Attributes

Inherited from:
Reactor
def displayable: Boolean

Attributes

Inherited from:
UIElement
def enabled: Boolean

Attributes

Inherited from:
Component
def enabled_=(b: Boolean): Unit

Attributes

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

Parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Proxy -> Any
Inherited from:
Proxy
def focusable: Boolean

Attributes

Inherited from:
Component
def focusable_=(b: Boolean): Unit

Attributes

Inherited from:
Component
def font: Font

Attributes

Inherited from:
UIElement
def font_=(f: Font): Unit

Attributes

Inherited from:
UIElement
def foreground: Color

Attributes

Inherited from:
UIElement
def foreground_=(c: Color): Unit

Attributes

Inherited from:
UIElement
def hasFocus: Boolean

Attributes

Inherited from:
Component
override def hashCode(): Int

Calculates a hash code value for the object.

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

Attributes

Returns

the hash code value for this object.

Definition Classes
Proxy -> Any
Inherited from:
Proxy
def ignoreRepaint: Boolean

Attributes

Inherited from:
UIElement
def ignoreRepaint_=(b: Boolean): Unit

Attributes

Inherited from:
UIElement
def inputVerifier: Component => Boolean

Attributes

Inherited from:
Component
def inputVerifier_=(v: Component => Boolean): Unit

Attributes

Inherited from:
Component
def listenTo(ps: Publisher*): Unit

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.

Attributes

Inherited from:
Reactor
def locale: Locale

Attributes

Inherited from:
UIElement
def location: Point

Attributes

Inherited from:
UIElement
def locationOnScreen: Point

Attributes

Inherited from:
UIElement
def maximumSize: Dimension

Attributes

Inherited from:
UIElement
def maximumSize_=(x: Dimension): Unit

Attributes

Inherited from:
UIElement
def minimumSize: Dimension

Attributes

Inherited from:
UIElement
def minimumSize_=(x: Dimension): Unit

Attributes

Inherited from:
UIElement
def name: String

Attributes

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

Attributes

Inherited from:
Component
def opaque: Boolean

Attributes

Inherited from:
Component
def opaque_=(b: Boolean): Unit

Attributes

Inherited from:
Component
def paint(g: Graphics2D): Unit

Attributes

Inherited from:
Component
def preferredSize: Dimension

Attributes

Inherited from:
UIElement
def preferredSize_=(x: Dimension): Unit

Attributes

Inherited from:
UIElement
def publish(e: Event): Unit

Notify all registered reactions.

Notify all registered reactions.

Attributes

Inherited from:
Publisher
def repaint(rect: Rectangle): Unit

Attributes

Inherited from:
UIElement
def repaint(): Unit

Attributes

Inherited from:
UIElement
def requestFocus(): Unit

Attributes

Inherited from:
Component
def requestFocusInWindow(): Boolean

Attributes

Inherited from:
Component
def revalidate(): Unit

Attributes

Inherited from:
Component
def self: Any

Attributes

Inherited from:
UIElement
def showing: Boolean

Attributes

Inherited from:
UIElement
def size: Dimension

Attributes

Inherited from:
UIElement
override def subscribe(listener: Reaction): Unit

Attributes

Definition Classes
Inherited from:
LazyPublisher (hidden)
def toolkit: Toolkit

Attributes

Inherited from:
UIElement
def tooltip: String

Attributes

Inherited from:
Component
def tooltip_=(t: String): Unit

Attributes

Inherited from:
Component
override def unsubscribe(listener: Reaction): Unit

Attributes

Definition Classes
Inherited from:
LazyPublisher (hidden)
def validate(): Unit

Attributes

Inherited from:
UIElement
def visible: Boolean

Attributes

Inherited from:
UIElement
def visible_=(b: Boolean): Unit

Attributes

Inherited from:
UIElement
def xLayoutAlignment: Double

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.

Attributes

Inherited from:
Component
def xLayoutAlignment_=(x: Double): Unit

Attributes

Inherited from:
Component
def yLayoutAlignment: Double

Attributes

Inherited from:
Component
def yLayoutAlignment_=(y: Double): Unit

Attributes

Inherited from:
Component

Concrete fields

Inherited fields

protected val listeners: RefSet[Reaction]

Attributes

Inherited from:
Publisher
lazy override val peer: JComponent

The underlying Swing peer.

The underlying Swing peer.

Attributes

Inherited from:
Component
val reactions: Reactions

All reactions of this reactor.

All reactions of this reactor.

Attributes

Inherited from:
Reactor
Generated with
This document is part of the ebook for O1 (aka CS-A1110 Programming 1), a course at Aalto University.
This document is part of the ebook for O1 (aka CS-A1110 Programming 1), a course at Aalto University.