scalafx/scalafx.event/EventHandlerDelegate2

EventHandlerDelegate2

trait EventHandlerDelegate2

Helps adding delagates for addEventHandler/removeEventHandler, addEventFilter/removeEventFilter, and buildEventDispatchChain.

Helps adding delagates for addEventHandler/removeEventHandler, addEventFilter/removeEventFilter, and buildEventDispatchChain.

Intended for internal library use.

See also

EventHandlerDelegate1

class Object
trait Matchable
class Any
class Service[T]
class Task[T]
class Node
class SwingNode
class Camera
class LightBase
class Parent
class Group
class Region
class Axis[T]
class ValueAxis[T]
class Chart
class PieChart
class XYChart[X, Y]
class AreaChart[X, Y]
class BarChart[X, Y]
class BubbleChart[X, Y]
class LineChart[X, Y]
class ScatterChart[X, Y]
class StackedAreaChart[X, Y]
class StackedBarChart[X, Y]
class Control
class Accordion
class ButtonBar
class ChoiceBox[J]
class ComboBoxBase[T]
class ComboBox[T]
class Labeled
class Button
class CheckBox
class Hyperlink
class Cell[T]
class DateCell
class IndexedCell[T]
class ListCell[T]
class TableCell[S, T]
class CheckBoxTableCell[S, T]
class ChoiceBoxTableCell[S, T]
class ComboBoxTableCell[S, T]
class TextFieldTableCell[S, T]
class TableRow[T]
class TreeCell[T]
class TreeTableCell[S, T]
class TreeTableRow[T]
class Label
class ListView[T]
class MenuBar
class ScrollBar
class Separator
class Slider
class Spinner[T]
class SplitPane
class TabPane
class TableView[S]
class TextArea
class TextField
class ToolBar
class TreeTableView[S]
class TreeView[T]
class Pane
class FlowPane
class GridPane
class HBox
class StackPane
class TilePane
class VBox
class TextFlow
class WebView
class SubScene
class Canvas
class ImageView
class MediaView
class Shape
class Arc
class Circle
class Ellipse
class Line
class Path
class Polygon
class Polyline
class QuadCurve
class Rectangle
class SVGPath
class Text
class Shape3D
class Box
class Cylinder
class MeshView
class Sphere
class Window
class Tooltip
class Popup
class Stage

Type members

Classlikes

trait EventHandled

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

Trait used for handle events manipulation. JavaFX class wrapped must have methods defined in scalafx.event.EventHandlerDelegate2.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
sealed trait FilterMagnet[J <: Event, S <: SFXDelegate[J]]

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

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

Companion
object
object FilterMagnet

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

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

Companion
class
sealed trait HandlerMagnet[J <: Event, S <: SFXDelegate[J]]

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

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

Companion
object
object HandlerMagnet

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

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

Companion
class

Value members

Abstract methods

protected def eventHandlerDelegate: EventHandled

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

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

Concrete methods

def addEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

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

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

Type Params
E

Event class

Value Params
eventHandler

the filter to register that will filter event

eventType

the type of the events to receive by the filter

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

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.

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.

Type Params
E

Event class

Value Params
eventHandler

the handler to register that will manipulate event

eventType

the type of the events to receive by the handler

def buildEventDispatchChain(chain: EventDispatchChain): EventDispatchChain

Construct an event dispatch chain for this target.

Construct an event dispatch chain for this target.

def filterEvent[J <: Event, S <: Event & SFXDelegate[J]](eventType: EventType[J])(filter: FilterMagnet[J, S]): Subscription

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

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") }
Type Params
J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value Params
eventType

type of events that will be handled.

filter

code handling the event, see examples above.

def handleEvent[J <: Event, S <: Event & SFXDelegate[J]](eventType: EventType[J])(handler: HandlerMagnet[J, S]): Subscription

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.

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") }
Type Params
J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value Params
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

def removeEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

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.

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.

Type Params
E

Event class

Value Params
eventHandler

the filter to unregister

eventType

the event type from which to unregister

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

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.

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.

Type Params
E

Event class

Value Params
eventHandler

the handler to unregister

eventType

the event type from which to unregister