Packages

  • package root
    Definition Classes
    root
  • package scala
    Definition Classes
    root
  • package swing

    Scala-swing is a graphical user interface library that will wrap most of Java Swing for Scala in a straightforward manner.

    Scala-swing is a graphical user interface library that will wrap most of Java Swing for Scala in a straightforward manner.

    Overview

    The widget class hierarchy loosely resembles that of Java Swing. The main differences are:

    • In Java Swing all components are containers per default. This does not make much sense for a number of components, like scala.swing.TextField, scala.swing.CheckBox, scala.swing.RadioButton, and so on. Our guess is that this architecture was chosen because Java lacks multiple inheritance. In scala-swing, components that can have child components extend the scala.swing.Container trait.
    • Layout managers and panels are coupled. There is no way to exchange the layout manager of a panel. As a result, the layout constraints for widgets can be typed. (Note that you gain more type-safety and do not loose much flexibility here. Besides being not a common operation, exchanging the layout manager of a panel in Java Swing almost always leads to exchanging the layout constraints for every of the panel's child component. In the end, it is not more work to move all children to a newly created panel.)
    • Widget hierarchies are built by adding children to their parent container's contents collection. The typical usage style is to create anonymous subclasses of the widgets to customize their properties, and nest children and event reactions.
    • The scala-swing event system follows a different approach than the underlying Java system. Instead of adding event listeners with a particular interface (such as java.awt.ActionListener), a scala.swing.Reactor instance announces the interest in receiving events by calling listenTo for a scala.swing.Publisher. Publishers are also reactors and listen to themselves per default as a convenience. A reactor contains an object reactions which serves as a convenient place to register observers by adding partial functions that pattern match for any event that the observer is interested in. This is shown in the examples section below.
    • For more details see SIP-8.

    Scala-swing comprises two main packages:

    • scala.swing: All widget classes and traits.
    • scala.swing.event: The event hierarchy.

    This package object contains useful type aliases that do not have wrappers.

    Examples

    The following example shows how to plug components and containers together and react to a mouse click on a button:

    import scala.swing._
    
    new Frame {
      title = "Hello world"
    
      contents = new FlowPanel {
        contents += new Label("Launch rainbows:")
        contents += new Button("Click me") {
          reactions += {
            case event.ButtonClicked(_) =>
              println("All the colours!")
          }
        }
      }
    
      pack()
      centerOnScreen()
      open()
    }
    Definition Classes
    scala
  • object Scrollable
    Definition Classes
    swing
  • Wrapper

trait Wrapper extends Component with Scrollable

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Wrapper
  2. Scrollable
  3. Component
  4. PeerContainer
  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

Type Members

  1. trait SuperMixin extends JComponent

    This trait is used to redirect certain calls from the peer to the wrapper and back.

    This trait is used to redirect certain calls from the peer to the wrapper and back. Useful to expose methods that can be customized by overriding.

    Attributes
    protected
    Definition Classes
    Component

Abstract Value Members

  1. abstract def scrollablePeer: javax.swing.Scrollable
    Attributes
    protected

Concrete Value Members

  1. object keys extends Publisher
    Definition Classes
    Component
  2. object mouse

    Contains publishers for various mouse events.

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

    Definition Classes
    Component
  3. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def ##: Int
    Definition Classes
    AnyRef → Any
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def background: Color
    Definition Classes
    UIElement
  8. def background_=(c: Color): Unit
    Definition Classes
    UIElement
  9. def blockIncrement(visibleRect: Rectangle, orientation: Orientation.Value, direction: Int): Int
    Definition Classes
    WrapperScrollable
  10. def border: Border
    Definition Classes
    Component
  11. def border_=(b: Border): Unit
    Definition Classes
    Component
  12. def bounds: Rectangle
    Definition Classes
    UIElement
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  14. def componentOrientation: ComponentOrientation
    Definition Classes
    UIElement
  15. def componentOrientation_=(x: ComponentOrientation): Unit
    Definition Classes
    UIElement
  16. def cursor: Cursor
    Definition Classes
    UIElement
  17. def cursor_=(c: Cursor): Unit
    Definition Classes
    UIElement
  18. 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.

    Definition Classes
    Reactor
  19. def displayable: Boolean
    Definition Classes
    UIElement
  20. def enabled: Boolean
    Definition Classes
    Component
  21. def enabled_=(b: Boolean): Unit
    Definition Classes
    Component
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(that: Any): Boolean
    Definition Classes
    Proxy → Any
  24. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  25. def focusable: Boolean
    Definition Classes
    Component
  26. def focusable_=(b: Boolean): Unit
    Definition Classes
    Component
  27. def font: Font
    Definition Classes
    UIElement
  28. def font_=(f: Font): Unit
    Definition Classes
    UIElement
  29. def foreground: Color
    Definition Classes
    UIElement
  30. def foreground_=(c: Color): Unit
    Definition Classes
    UIElement
  31. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  32. def hasFocus: Boolean
    Definition Classes
    Component
  33. def hashCode(): Int
    Definition Classes
    Proxy → Any
  34. def ignoreRepaint: Boolean
    Definition Classes
    UIElement
  35. def ignoreRepaint_=(b: Boolean): Unit
    Definition Classes
    UIElement
  36. def inputVerifier: (Component) => Boolean
    Definition Classes
    Component
  37. def inputVerifier_=(v: (Component) => Boolean): Unit
    Definition Classes
    Component
  38. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  39. 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.

    Definition Classes
    Reactor
  40. val listeners: RefSet[Reaction]
    Attributes
    protected
    Definition Classes
    Publisher
  41. def locale: Locale
    Definition Classes
    UIElement
  42. def location: Point
    Definition Classes
    UIElement
  43. def locationOnScreen: Point
    Definition Classes
    UIElement
  44. def maximumSize: Dimension
    Definition Classes
    UIElement
  45. def maximumSize_=(x: Dimension): Unit
    Definition Classes
    UIElement
  46. def minimumSize: Dimension
    Definition Classes
    UIElement
  47. def minimumSize_=(x: Dimension): Unit
    Definition Classes
    UIElement
  48. def name: String
    Definition Classes
    Component
  49. def name_=(s: String): Unit
    Definition Classes
    Component
  50. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  51. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  52. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  53. def onFirstSubscribe(): Unit
    Attributes
    protected
    Definition Classes
    ComponentUIElement → LazyPublisher
  54. def onLastUnsubscribe(): Unit
    Attributes
    protected
    Definition Classes
    UIElement → LazyPublisher
  55. def opaque: Boolean
    Definition Classes
    Component
  56. def opaque_=(b: Boolean): Unit
    Definition Classes
    Component
  57. def paint(g: Graphics2D): Unit
    Definition Classes
    Component
  58. def paintBorder(g: Graphics2D): Unit
    Attributes
    protected
    Definition Classes
    Component
  59. def paintChildren(g: Graphics2D): Unit
    Attributes
    protected
    Definition Classes
    Component
  60. def paintComponent(g: Graphics2D): Unit

    For custom painting, users should usually override this method.

    For custom painting, users should usually override this method.

    Attributes
    protected
    Definition Classes
    Component
  61. lazy val peer: JComponent

    The underlying Swing peer.

    The underlying Swing peer.

    Definition Classes
    ComponentPeerContainerUIElement
  62. def preferredSize: Dimension
    Definition Classes
    UIElement
  63. def preferredSize_=(x: Dimension): Unit
    Definition Classes
    UIElement
  64. def preferredViewportSize: Dimension
    Definition Classes
    WrapperScrollable
  65. def publish(e: Event): Unit

    Notify all registered reactions.

    Notify all registered reactions.

    Definition Classes
    Publisher
  66. val reactions: Reactions

    All reactions of this reactor.

    All reactions of this reactor.

    Definition Classes
    Reactor
  67. def repaint(rect: Rectangle): Unit
    Definition Classes
    UIElement
  68. def repaint(): Unit
    Definition Classes
    UIElement
  69. def requestFocus(): Unit
    Definition Classes
    Component
  70. def requestFocusInWindow(): Boolean
    Definition Classes
    Component
  71. def revalidate(): Unit
    Definition Classes
    Component
  72. def self: Any
    Definition Classes
    UIElement → Proxy
  73. def showing: Boolean
    Definition Classes
    UIElement
  74. def size: Dimension
    Definition Classes
    UIElement
  75. def subscribe(listener: Reaction): Unit
    Definition Classes
    LazyPublisher → Publisher
  76. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  77. def toString(): String
    Definition Classes
    Component → Proxy → AnyRef → Any
  78. def toolkit: Toolkit
    Definition Classes
    UIElement
  79. def tooltip: String
    Definition Classes
    Component
  80. def tooltip_=(t: String): Unit
    Definition Classes
    Component
  81. def tracksViewportHeight: Boolean
    Definition Classes
    WrapperScrollable
  82. def tracksViewportWidth: Boolean
    Definition Classes
    WrapperScrollable
  83. def unitIncrement(visibleRect: Rectangle, orientation: Orientation.Value, direction: Int): Int
    Definition Classes
    WrapperScrollable
  84. def unsubscribe(listener: Reaction): Unit
    Definition Classes
    LazyPublisher → Publisher
  85. def validate(): Unit
    Definition Classes
    UIElement
  86. def visible: Boolean
    Definition Classes
    UIElement
  87. def visible_=(b: Boolean): Unit
    Definition Classes
    UIElement
  88. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  89. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  90. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  91. 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.

    Definition Classes
    Component
  92. def xLayoutAlignment_=(x: Double): Unit
    Definition Classes
    Component
  93. def yLayoutAlignment: Double
    Definition Classes
    Component
  94. def yLayoutAlignment_=(y: Double): Unit
    Definition Classes
    Component

Inherited from Scrollable

Inherited from Component

Inherited from PeerContainer

Inherited from UIElement

Inherited from LazyPublisher

Inherited from Publisher

Inherited from Reactor

Inherited from Proxy

Inherited from AnyRef

Inherited from Any

Ungrouped