Packages

  • package root

    ScalaFX is a UI DSL written within the Scala Language that sits on top of JavaFX 2.x and and JavaFX 8.

    ScalaFX is a UI DSL written within the Scala Language that sits on top of JavaFX 2.x and and JavaFX 8. This means that every ScalaFX application is also a valid Scala application. By extension it supports full interoperability with Java and can run anywhere the Java Virtual Machine (JVM) and JavaFX 2.0 or JavaFX 8 are supported.

    Package Structure

    ScalaFX package structure corresponds to JavaFX package structure, for instance scalafx.animation corresponds to javafx.animation.

    Example Usage

    A basic ScalaFX application is created creating an object that is an instance of JFXApp. Following Java FX theatre metaphor, it contains a stage that contains a scene. A stage roughly corresponds to a window in a typical UI environment. The scene holds UI content presented to the user. In the example below, the content is a pane with a single label component.

    package hello

import scalafx.application.JFXApp
import scalafx.application.JFXApp.PrimaryStage
import scalafx.geometry.Insets
import scalafx.scene.Scene
import scalafx.scene.control.Label
import scalafx.scene.layout.BorderPane

object HelloWorld extends JFXApp {
  stage = new PrimaryStage {
    title = "Hello"
    scene = new Scene {
      root = new BorderPane {
        padding = Insets(25)
        center = new Label("Hello World")
      }
    }
  }
}
    Definition Classes
    root
  • package scalafx

    Base package for ScalaFX classes.

    Base package for ScalaFX classes.

    Definition Classes
    root
  • package event

    Wraps javafx.event package.

    Wraps javafx.event package.

    Definition Classes
    scalafx
  • package subscriptions

    Definition Classes
    event
  • ActionEvent
  • Event
  • EventDispatchChain
  • EventDispatcher
  • EventHandler
  • EventHandlerDelegate
  • EventIncludes
  • EventTarget
  • EventType
  • WeakEventHandler
t

scalafx.event

EventHandlerDelegate

trait EventHandlerDelegate extends AnyRef

Trait used for handle events manipulation. JavaFX class wrapped must have methods defined in scalafx.event.EventHandlerDelegate.EventHandled Type:

def addEventHandler   [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
def removeEventHandler[E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
def addEventFilter    [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
def removeEventFilter [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
def buildEventDispatchChain(chain: jfxe.EventDispatchChain): jfxe.EventDispatchChain
Source
EventHandler.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
PrimaryStage, PrimaryStage, ScheduledService, Service, Task, SwingNode, AmbientLight, Camera, Group, LightBase, Node, ParallelCamera, Parent, PerspectiveCamera, PointLight, SubScene, Canvas, AreaChart, Axis, BarChart, BubbleChart, CategoryAxis, Chart, LineChart, NumberAxis, PieChart, ScatterChart, StackedAreaChart, StackedBarChart, ValueAxis, XYChart, Accordion, Button, ButtonBar, ButtonBase, Cell, CheckBox, CheckMenuItem, ChoiceBox, ColorPicker, ComboBox, ComboBoxBase, ContextMenu, Control, CustomMenuItem, DateCell, DatePicker, DialogPane, Hyperlink, IndexedCell, Label, Labeled, ListCell, ListView, Menu, MenuBar, MenuButton, MenuItem, Pagination, PasswordField, PopupControl, ProgressBar, ProgressIndicator, RadioButton, RadioMenuItem, ScrollBar, ScrollPane, Separator, SeparatorMenuItem, Slider, Spinner, SplitMenuButton, SplitPane, TabPane, TableCell, TableColumn, TableColumnBase, TableRow, TableView, TextArea, TextField, TextInputControl, TitledPane, ToggleButton, ToolBar, Tooltip, TreeCell, TreeItem, TreeTableCell, TreeTableColumn, TreeTableRow, TreeTableView, TreeView, CheckBoxListCell, CheckBoxTableCell, CheckBoxTreeCell, CheckBoxTreeTableCell, ChoiceBoxListCell, ChoiceBoxTableCell, ChoiceBoxTreeCell, ChoiceBoxTreeTableCell, ComboBoxListCell, ComboBoxTableCell, ComboBoxTreeCell, ComboBoxTreeTableCell, ProgressBarTableCell, TextFieldListCell, TextFieldTableCell, TextFieldTreeCell, TextFieldTreeTableCell, ImageView, AnchorPane, BorderPane, FlowPane, GridPane, HBox, Pane, Region, StackPane, TilePane, VBox, MediaView, Arc, Box, Circle, CubicCurve, Cylinder, Ellipse, Line, MeshView, Path, Polygon, Polyline, QuadCurve, Rectangle, SVGPath, Shape, Shape3D, Sphere, Text, TextFlow, HTMLEditor, WebView, Popup, PopupWindow, Stage, Window
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventHandlerDelegate
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type EventHandled = AnyRef { ... /* 5 definitions in type refinement */ }

  2. sealed trait FilterMagnet[J <: javafx.event.Event, S <: SFXDelegate[J]] extends AnyRef

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

  3. sealed trait HandlerMagnet[J <: javafx.event.Event, S <: SFXDelegate[J]] extends AnyRef

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

Abstract Value Members

  1. abstract def eventHandlerDelegate: EventHandled

    Returns a object that implements scalafx.event.EventHandlerDelegate.EventHandled.

    Returns a object that implements scalafx.event.EventHandlerDelegate.EventHandled.

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addEventFilter[E <: javafx.event.Event](eventType: javafx.event.EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Registers an event filter to this task.

    Registers an event filter to this task. Registered event filters get an event before any associated event handlers.

    E

    Event class

    eventType

    the type of the events to receive by the filter

    eventHandler

    the filter to register that will filter event

  5. def addEventHandler[E <: javafx.event.Event](eventType: javafx.event.EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Registers an event handler to this task.

    Registers an event handler to this task. Any event filters are first processed, then the specified onFoo event handlers, and finally any event handlers registered by this method. As with other events in the scene graph, if an event is consumed, it will not continue dispatching.

    E

    Event class

    eventType

    the type of the events to receive by the handler

    eventHandler

    the handler to register that will manipulate event

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def buildEventDispatchChain(chain: javafx.event.EventDispatchChain): javafx.event.EventDispatchChain

    Construct an event dispatch chain for this target.

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def filterEvent[J <: javafx.event.Event, S <: Event with SFXDelegate[J]](eventType: EventType[J])(filter: FilterMagnet[J, S]): Subscription

    Registers an event filter.

    Registers an event filter. Registered event filters get an event before any associated event handlers.

    Example of filtering mouse events

    pane.filterEvent(MouseEvent.Any) {
  me: MouseEvent => {
    me.eventType match {
      case MouseEvent.MousePressed => {
        ...
      }
      case MouseEvent.MouseDragged => {
        ...
      }
      case _ => {
        ...
      }
    }
  }
}

    or

    pane.filterEvent(MouseEvent.Any) { () => println("Some mouse event handled") }
    J

    type JavaFX delegate of the event

    S

    ScalaFX type for J type wrapper.

    eventType

    type of events that will be handled.

    filter

    code handling the event, see examples above.

  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def handleEvent[J <: javafx.event.Event, S <: Event with SFXDelegate[J]](eventType: EventType[J])(handler: HandlerMagnet[J, S]): Subscription

    Registers an event handler.

    Registers an event handler. The handler is called when the node receives an Event of the specified type during the bubbling phase of event delivery.

    Example of handling mouse events

    pane.handleEvent(MouseEvent.Any) {
  me: MouseEvent => {
    me.eventType match {
      case MouseEvent.MousePressed => ...
      case MouseEvent.MouseDragged => ...
      case _                       => {}
    }
  }
}

    or

    pane.handleEvent(MouseEvent.Any) { () => println("Some mouse event handled") }
    J

    type JavaFX delegate of the event

    S

    ScalaFX type for J type wrapper.

    eventType

    type of events that will be handled.

    handler

    code handling the event, see examples above.

    returns

    Returns a subscription that can be used to cancel/remove this event handler

  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def removeEventFilter[E <: javafx.event.Event](eventType: javafx.event.EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Unregisters a previously registered event filter from this task.

    Unregisters a previously registered event filter from this task. One filter might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the filter.

    E

    Event class

    eventType

    the event type from which to unregister

    eventHandler

    the filter to unregister

  20. def removeEventHandler[E <: javafx.event.Event](eventType: javafx.event.EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Unregisters a previously registered event handler from this task.

    Unregisters a previously registered event handler from this task. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler.

    E

    Event class

    eventType

    the event type from which to unregister

    eventHandler

    the handler to unregister

  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. object FilterMagnet

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

  27. object HandlerMagnet

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped