Packages

  • package o1

    O1Library is a toolkit designed for the course Programming 1 (a.k.a. O1) at Aalto University.

    O1Library is a toolkit designed for the course Programming 1 (a.k.a. O1) at Aalto University. It contains an assortment of tools; most prominently, it provides a framework for simple graphical programming and utilities for playing sound.

    This is the front page of O1Library’s documentation. However, this is probably not the best place to start learning about O1Library as a student. That’s because the relevant content of this library is introduced bit by bit in the chapters of O1’s custom ebook alongside the associated programming concepts and assignments.

    You may still find this documentation useful as a reference. You can also find some optional content here that you may wish to try.

    This front page lists the content available in the top-level package called simply o1. These tools are available with the simple command import o1._ in your Scala programs. Some of them you’ll use a lot; some of them you won’t necessarily need at all.

    The tools listed here are actually implemented in a number of subpackages (o1.gui, o1.sound, etc.); what you see here are just “shortcut aliases” to those actual implementations. The aliases are here to make that convenient import command work and to provide you with this list of links to some of the more commonly used tools in O1Library. The subpackages also contain additional content not listed here.

    O1Library has been developed by Aleksi Lukkarinen and Juha Sorva. Several of the key components in o1.gui and o1.world are built upon Aleksi’s Scala Media Computation Library. Some parts of O1Library draw inspiration from the “teachpacks” of the Racket programming language.

    We are grateful to Riku Autio, Joonatan Honkamaa, Juhani Numminen, Leo Varis, Veera Kahva, and anonymous students for bug reports and fixes. We thank Otto Seppälä for helpful discussions.

    Definition Classes
    root
  • package gui

    This package contains tools for building simple GUIs.

    This package contains tools for building simple GUIs. The toolkit is particularly well suited to constructing GUIs that display information as 2D images and/or geometric shapes. It is not designed for demanding graphical needs that call for high efficiency. Some of the tools in this package are built on the Swing GUI library, and the two libraries can be used in combination.

    Some of the types in this package have aliases in the top-level package o1, so they are accessible to students simply via import o1._. Some of the package contents are not available in the top-level package or included in this documentation.

    Please note: One of this package’s key components (views) comes in multiple varieties, which which are defined in the subpackages o1.gui.mutable and o1.gui.immutable and not listed below. The View that is most commonly used in O1 (and aliased as o1.View in the top-level package) is o1.gui.mutable.ViewFrame.

    Definition Classes
    o1
  • package colors

    This package contains Color constants.

    This package contains Color constants. They cover all the colors listed in the W3C’s CSS Color Module specification (July 5th, 2017); there are some additional ones as well.

    All the colors are fully opaque, except Transparent, which is fully transparent.

    The contents of this package are aliased in the top-level package o1 so that they are accessible to students simply via import o1._.

    Definition Classes
    gui
  • package event

    This package exists in order to provide aliases to event classes in Swing and to add some methods to Swing’s InputEvent via o1.gui.event.ConvenientInputEvent.

    This package exists in order to provide aliases to event classes in Swing and to add some methods to Swing’s InputEvent via o1.gui.event.ConvenientInputEvent.

    The contents of this package are aliased in the top-level package o1, so that they are accessible to students simply via* import o1._.

    Definition Classes
    gui
  • package layout

    The package o1.gui.layout contains utilities that make it more convenient to lay out components in simple GridBagPanels from Scala's Swing library.

    The package o1.gui.layout contains utilities that make it more convenient to lay out components in simple GridBagPanels from Scala's Swing library. These utilities are used internally by some of the given GUIs in O1.

    NOTE TO STUDENTS: In this course, you don't need to understand how this package works or can be used.

    Definition Classes
    gui
  • Animation
  • Color
  • DefaultFrameSettings
  • Dialog
  • Escapable
  • Pic
  • SimpleFrame
  • TerminatesOnClose
  • View
  • immutable
  • mutable
t

o1.gui

TerminatesOnClose

trait TerminatesOnClose extends Window

Give this convenience trait to a Swing GUI frame to make it terminate the application when closed.

Linear Supertypes
Window, RootPanel, Container, UIElement, LazyPublisher, Publisher, Reactor, Proxy, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TerminatesOnClose
  2. Window
  3. RootPanel
  4. Container
  5. UIElement
  6. LazyPublisher
  7. Publisher
  8. Reactor
  9. Proxy
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def peer: Window with InterfaceMixin
    Definition Classes
    Window → RootPanel → UIElement

Concrete Value Members

  1. def background: scala.swing.Color
    Definition Classes
    UIElement
  2. def background_=(c: scala.swing.Color): Unit
    Definition Classes
    UIElement
  3. def bounds: Rectangle
    Definition Classes
    UIElement
  4. def bounds_=(rect: Rectangle): Unit
    Definition Classes
    Window
  5. def centerOnScreen(): Unit
    Definition Classes
    Window
  6. def close(): Unit
    Definition Classes
    Window
  7. def closeOperation(): Unit

    Call closeOperation on the superclass, then terminates the entire application.

    Call closeOperation on the superclass, then terminates the entire application. (Skips termination if it seems the program is running in the REPL.)

    Definition Classes
    TerminatesOnClose → Window
  8. def componentOrientation: ComponentOrientation
    Definition Classes
    UIElement
  9. def componentOrientation_=(x: ComponentOrientation): Unit
    Definition Classes
    UIElement
  10. def contents: Seq[Component]
    Definition Classes
    RootPanel → Container
  11. def contents_=(c: Component): Unit
    Definition Classes
    Window → RootPanel
  12. def cursor: Cursor
    Definition Classes
    UIElement
  13. def cursor_=(c: Cursor): Unit
    Definition Classes
    UIElement
  14. def defaultButton: Option[Button]
    Definition Classes
    Window
  15. def defaultButton_=(b: Option[Button]): Unit
    Definition Classes
    Window
  16. def defaultButton_=(b: Button): Unit
    Definition Classes
    Window
  17. def displayable: Boolean
    Definition Classes
    UIElement
  18. def dispose(): Unit
    Definition Classes
    Window
  19. def equals(that: Any): Boolean
    Definition Classes
    Proxy → Any
  20. def font: Font
    Definition Classes
    UIElement
  21. def font_=(f: Font): Unit
    Definition Classes
    UIElement
  22. def foreground: scala.swing.Color
    Definition Classes
    UIElement
  23. def foreground_=(c: scala.swing.Color): Unit
    Definition Classes
    UIElement
  24. def hashCode(): Int
    Definition Classes
    Proxy → Any
  25. def ignoreRepaint: Boolean
    Definition Classes
    UIElement
  26. def ignoreRepaint_=(b: Boolean): Unit
    Definition Classes
    UIElement
  27. def locale: Locale
    Definition Classes
    UIElement
  28. def location: Point
    Definition Classes
    UIElement
  29. def locationOnScreen: Point
    Definition Classes
    UIElement
  30. def location_=(p: Point): Unit
    Definition Classes
    Window
  31. def maximumSize: Dimension
    Definition Classes
    UIElement
  32. def maximumSize_=(x: Dimension): Unit
    Definition Classes
    UIElement
  33. def minimumSize: Dimension
    Definition Classes
    UIElement
  34. def minimumSize_=(x: Dimension): Unit
    Definition Classes
    UIElement
  35. def open(): Unit
    Definition Classes
    Window
  36. def owner: Window
    Definition Classes
    Window
  37. def pack(): TerminatesOnClose.this.type
    Definition Classes
    Window
  38. def preferredSize: Dimension
    Definition Classes
    UIElement
  39. def preferredSize_=(x: Dimension): Unit
    Definition Classes
    UIElement
  40. def publish(e: Event): Unit
    Definition Classes
    Publisher
  41. def repaint(rect: Rectangle): Unit
    Definition Classes
    UIElement
  42. def repaint(): Unit
    Definition Classes
    UIElement
  43. def self: Any
    Definition Classes
    UIElement → Proxy
  44. def setLocationRelativeTo(c: UIElement): Unit
    Definition Classes
    Window
  45. def showing: Boolean
    Definition Classes
    UIElement
  46. def size: Dimension
    Definition Classes
    UIElement
  47. def size_=(size: Dimension): Unit
    Definition Classes
    Window
  48. def subscribe(listener: Reaction): Unit
    Definition Classes
    LazyPublisher → Publisher
  49. def toString: String
    Definition Classes
    Proxy → Any
  50. def toolkit: Toolkit
    Definition Classes
    UIElement
  51. def unsubscribe(listener: Reaction): Unit
    Definition Classes
    LazyPublisher → Publisher
  52. def validate(): Unit
    Definition Classes
    UIElement
  53. def visible: Boolean
    Definition Classes
    UIElement
  54. def visible_=(b: Boolean): Unit
    Definition Classes
    UIElement