O1Library Docs
Fall 2023
Docs API

# Controls

o1.gui.viewimpl.default$.mutable$.Controls
trait Controls[Model] extends Fast

## Attributes

Graph
Supertypes
  trait Fast
  class Object
  trait Matchable
  class Any
Known subtypes
  trait TraceGeneratingView[Model, TraceData]
  class Traced[TraceData]
  class Traced[TraceData]
  class ViewComponent[Model]
  class ViewFrame[Model]

## Members list

### Value members

#### Abstract methods

def makePic: Pic

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.

## Attributes

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

#### Concrete methods

def isDone: Boolean

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.

## Attributes

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

## Attributes

See also

  HasPauseToggle

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

## Parameters

position

  the position of the mouse cursor relative to the view’s top left-hand corner

## Attributes

def onClick(event: MouseClicked): 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 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.

## Parameters

event

  the GUI event that caused this handler to be called

## Attributes

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.

## Parameters

key

  the key that was pressed down

## Attributes

def onKeyDown(event: KeyPressed): 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 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.

## Parameters

event

  the GUI event that caused this handler to be called

## Attributes

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.

## Parameters

key

  the key that was released

## Attributes

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.

## Parameters

event

  the GUI event that caused this handler to be called

## Attributes

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.

## Parameters

position

  the position of the mouse cursor relative to the view’s top left-hand corner

## Attributes

def onMouseDown(event: MousePressed): 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 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.

## Parameters

event

  the GUI event that caused this handler to be called

## Attributes

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.

## Parameters

position

  the position of the mouse cursor relative to the view’s top left-hand corner

## Attributes

def onMouseDrag(event: MouseDragged): 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 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.

## Parameters

event

  the GUI event that caused this handler to be called

## Attributes

def onMouseEnter(event: MouseEntered): Unit

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.

## Parameters

event

  the GUI event that caused this handler to be called

## Attributes

def onMouseExit(event: MouseExited): Unit

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.

## Parameters

event

  the GUI event that caused this handler to be called

## Attributes

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.

## Parameters

position

  the position of the mouse cursor relative to the view’s top left-hand corner

## Attributes

def onMouseMove(event: MouseMoved): 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 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.

## Parameters

event

  the GUI event that caused this handler to be called

## Attributes

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.

## Parameters

position

  the position of the mouse cursor relative to the view’s top left-hand corner

## Attributes

def onMouseUp(event: MouseReleased): 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 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.

## Parameters

event

  the GUI event that caused this handler to be called

## Attributes

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.

## Attributes

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

## Attributes

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.

## Parameters

time

  the running number of the clock tick (the first tick being number 1, the second 2, etc.)

## Attributes

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.

## Parameters

character

  the key that was typed

## Attributes

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.

## Parameters

event

  the GUI event that caused this handler to be called

## Attributes

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.

## Parameters

rotation

  the number of steps the wheel rotated (negative means up, positive down)

## Attributes

def onWheel(event: MouseWheelMoved): 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 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.

## Parameters

event

  the GUI event that caused this handler to be called

## Attributes

def sound: Option[Sound]

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.

## Attributes

Returns

  a Sound that the view should play; `None` if no sound is appropriate for the current state

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.

## Attributes

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.

## Attributes

#### Inherited methods

def model: Model

the model object represented in the view.

the model object represented in the view.

## Attributes

Inherited from:
  HasModelField (hidden)

def simulate(tickLimit: Int): Unit

## Attributes

Inherited from:
  Controls (hidden)

def start(): Unit

## Attributes

Inherited from:
  Controls (hidden)