PopupControl

class PopupControl(val delegate: PopupControl) extends PopupWindow with Styleable with Skinnable with SFXDelegate[PopupControl]

Wraps a JavaFX PopupControl.

Wraps a JavaFX PopupControl.

Value Params
delegate

JavaFX PopupControl to be wrapped. It defaul value is a new JavaFX PopupControl

Constructor

Creates a new ScalaFX PopupControl from its JavaFX counterpart.

Companion
object
trait Skinnable
trait Styleable
class Window
trait EventTarget
trait SFXDelegate[PopupControl]
class Object
trait Matchable
class Any
class Tooltip

Type members

Inherited classlikes

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
Inherited from
EventHandlerDelegate2
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"

Inherited from
EventHandlerDelegate2
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"

Inherited from
EventHandlerDelegate2

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"

Inherited from
EventHandlerDelegate2
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"

Inherited from
EventHandlerDelegate2

Value members

Concrete methods

The id of this Node.

The id of this Node.

def id_=(v: String): Unit

Property for overriding the control's computed maximum height.

Property for overriding the control's computed maximum height.

def maxHeight_=(v: Double): Unit

Property for overriding the control's computed maximum width.

Property for overriding the control's computed maximum width.

def maxWidth_=(v: Double): Unit

Property for overriding the control's computed minimum height.

Property for overriding the control's computed minimum height.

def minHeight_=(v: Double): Unit

Property for overriding the control's computed minimum width.

Property for overriding the control's computed minimum width.

def minWidth_=(v: Double): Unit

Property for overriding the control's computed preferred height.

Property for overriding the control's computed preferred height.

def prefHeight_=(v: Double): Unit

Property for overriding the control's computed preferred width.

Property for overriding the control's computed preferred width.

def prefWidth_=(v: Double): Unit
def pseudoClassStateChanged(pseudoClass: PseudoClass, active: Boolean): Unit
Since

8.0

A string representation of the CSS style associated with this specific Node.

A string representation of the CSS style associated with this specific Node.

def style_=(v: String): Unit

Inherited 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

Inherited from
EventHandlerDelegate2
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

Inherited from
EventHandlerDelegate2
def anchorLocation: ObjectProperty[AnchorLocation]

Specifies the popup anchor point which is used in popup positioning.

Specifies the popup anchor point which is used in popup positioning.

Inherited from
PopupWindow
Inherited from
PopupWindow

Specifies the x coordinate of the popup anchor point on the screen.

Specifies the x coordinate of the popup anchor point on the screen.

Inherited from
PopupWindow

Specifies the y coordinate of the popup anchor point on the screen.

Specifies the y coordinate of the popup anchor point on the screen.

Inherited from
PopupWindow

This convenience variable indicates whether, when the popup is shown, it should automatically correct its position such that it doesn't end up positioned off the screen.

This convenience variable indicates whether, when the popup is shown, it should automatically correct its position such that it doesn't end up positioned off the screen.

Inherited from
PopupWindow
def autoFix_=(v: Boolean): Unit
Inherited from
PopupWindow

Specifies whether Popups should auto hide.

Specifies whether Popups should auto hide.

Inherited from
PopupWindow
def autoHide_=(v: Boolean): Unit
Inherited from
PopupWindow
def buildEventDispatchChain(chain: EventDispatchChain): EventDispatchChain

Construct an event dispatch chain for this target.

Construct an event dispatch chain for this target.

Inherited from
EventHandlerDelegate2
def centerOnScreen(): Unit

Sets x and y properties on this Window so that it is centered on the screen.

Sets x and y properties on this Window so that it is centered on the screen.

Inherited from
Window

Specifies whether the event, which caused the Popup to hide, should be consumed.

Specifies whether the event, which caused the Popup to hide, should be consumed.

Since

2.2

Inherited from
PopupWindow
def consumeAutoHidingEvents_=(v: Boolean): Unit
Inherited from
PopupWindow
def cssMetaData: Seq[CssMetaData[_ <: Styleable, _]]

The CssMetaData of this Styleable.

The CssMetaData of this Styleable.

Inherited from
Styleable
override def equals(ref: Any): Boolean

Verifies if a object is equals to this delegate.

Verifies if a object is equals to this delegate.

Value Params
ref

Object to be compared.

Returns

if the other object is equals to this delegate or not.

Definition Classes
Inherited from
SFXDelegate
def eventDispatcher: ObjectProperty[EventDispatcher]

Specifies the event dispatcher for this node.

Specifies the event dispatcher for this node.

Inherited from
Window
def eventDispatcher_=(v: EventDispatcher): Unit
Inherited from
Window
Definition Classes
Inherited from
Window
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.

Inherited from
EventHandlerDelegate2
def fireEvent(event: Event): Unit

Whether or not this Window has the keyboard or input focus.

Whether or not this Window has the keyboard or input focus.

Inherited from
Window

Whether or not this Window has the keyboard or input focus.

Whether or not this Window has the keyboard or input focus.

Inherited from
Window

Boolean property that controls whether only integer render scales are set by default by the system when there is a change in the associated output scale. The renderScale properties will be updated directly and simultaneously with any changes in the associated outputScale properties, but the values can be overridden by subsequent calls to the setRenderScale setters or through appropriate use of binding. This property will not prevent setting non-integer scales directly using the renderScale property object or the convenience setter method.

Boolean property that controls whether only integer render scales are set by default by the system when there is a change in the associated output scale. The renderScale properties will be updated directly and simultaneously with any changes in the associated outputScale properties, but the values can be overridden by subsequent calls to the setRenderScale setters or through appropriate use of binding. This property will not prevent setting non-integer scales directly using the renderScale property object or the convenience setter method.

Default value is false

See also
Since

9

Inherited from
Window
def forceIntegerRenderScale_=(forced: Boolean): Unit
Inherited from
Window
def getId: String

The id of this Styleable.

The id of this Styleable.

IMPLEMENTATION NOTE: For this method was adopted the name getId instead id to not conflict with its subclasses already have a method with this name which returns a StringProperty.

Inherited from
Styleable
def getStyle: String

A string representation of the CSS style associated with this specific Node.

A string representation of the CSS style associated with this specific Node.

IMPLEMENTATION NOTE: For this method was adopted the name getStyle instead style to not conflict with its subclasses already have a method with this name which returns a StringProperty.

Inherited from
Styleable
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

Inherited from
EventHandlerDelegate2
override def hashCode: Int
Returns

The delegate hashcode

Definition Classes
Inherited from
SFXDelegate

The height of this Stage.

The height of this Stage.

Inherited from
Window
def height_=(h: Double): Unit
Inherited from
Window
def hide(): Unit

Attempts to hide this Window by setting the visibility to false.

Attempts to hide this Window by setting the visibility to false.

Inherited from
Window

Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.

Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.

Inherited from
PopupWindow
def hideOnEscape_=(v: Boolean): Unit
Inherited from
PopupWindow
def onAutoHide: ObjectProperty[EventHandler[Event]]

Called after autoHide is run.

Called after autoHide is run.

Inherited from
PopupWindow
def onAutoHide_=(v: EventHandler[Event]): Unit
Inherited from
PopupWindow
def onCloseRequest: ObjectProperty[EventHandler[WindowEvent]]

Called when there is an external request to close this Window.

Called when there is an external request to close this Window.

Inherited from
Window
def onCloseRequest_=(v: EventHandler[WindowEvent]): Unit
Inherited from
Window
def onHidden: ObjectProperty[EventHandler[WindowEvent]]

Called just after the Window has been hidden.

Called just after the Window has been hidden.

Inherited from
Window
def onHidden_=(v: EventHandler[WindowEvent]): Unit
Inherited from
Window
def onHiding: ObjectProperty[EventHandler[WindowEvent]]

Called just prior to the Window being hidden.

Called just prior to the Window being hidden.

Inherited from
Window
def onHiding_=(v: EventHandler[WindowEvent]): Unit
Inherited from
Window
def onShowing: ObjectProperty[EventHandler[WindowEvent]]

Called just prior to the Window being shown, even if the menu has no items to show.

Called just prior to the Window being shown, even if the menu has no items to show.

Inherited from
Window
def onShowing_=(v: EventHandler[WindowEvent]): Unit
Inherited from
Window
def onShown: ObjectProperty[EventHandler[WindowEvent]]

Called just after the Window is shown.

Called just after the Window is shown.

Inherited from
Window
def onShown_=(v: EventHandler[WindowEvent]): Unit
Inherited from
Window

Defines the opacity of the Stage as a value between 0.0 and 1.0.

Defines the opacity of the Stage as a value between 0.0 and 1.0.

Inherited from
Window
def opacity_=(v: Double): Unit
Inherited from
Window

The scale that the Window will apply to horizontal scene coordinates in all stages of rendering and compositing the output to the screen or other destination device. This property is updated asynchronously by the system at various times including:

The scale that the Window will apply to horizontal scene coordinates in all stages of rendering and compositing the output to the screen or other destination device. This property is updated asynchronously by the system at various times including:

  • Window creation

  • At some point during moving a window to a new Screen which may be before or after the Screen property is updated.

  • In response to a change in user preferences for output scaling.

See also
Since

9

Inherited from
Window
def outputScaleX_=(value: Double): Unit
Inherited from
Window

The scale that the Window will apply to vertical scene coordinates in all stages of rendering and compositing the output to the screen or other destination device. This property is updated asynchronously by the system at various times including:

The scale that the Window will apply to vertical scene coordinates in all stages of rendering and compositing the output to the screen or other destination device. This property is updated asynchronously by the system at various times including:

  • Window creation

  • At some point during moving a window to a new Screen which may be before or after the Screen property is updated.

  • In response to a change in user preferences for output scaling.

See also
Since

9

Inherited from
Window
def outputScaleY_=(value: Double): Unit
Inherited from
Window

The node which is the owner of this popup.

The node which is the owner of this popup.

Inherited from
PopupWindow

The window which is the parent of this popup.

The window which is the parent of this popup.

Inherited from
PopupWindow
def pseudoClassStates: ObservableSet[PseudoClass]

The pseudo-class state of this Styleable.

The pseudo-class state of this Styleable.

Inherited from
Styleable
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

Inherited from
EventHandlerDelegate2
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

Inherited from
EventHandlerDelegate2

The horizontal scale that the Window will use when rendering its Scene to the rendering buffer. This property is automatically updated whenever there is a change in the outputScaleX property and can be overridden either by calling setRenderScaleX() in response to a listener on the outputScaleX property or by binding it appropriately.

The horizontal scale that the Window will use when rendering its Scene to the rendering buffer. This property is automatically updated whenever there is a change in the outputScaleX property and can be overridden either by calling setRenderScaleX() in response to a listener on the outputScaleX property or by binding it appropriately.

Default value is outputScaleX

See also
Since

9

Inherited from
Window
def renderScaleX_=(scale: Double): Unit
Inherited from
Window

The vertical scale that the Window will use when rendering its Scene to the rendering buffer. This property is automatically updated whenever there is a change in the outputScaleY property and can be overridden either by calling setRenderScaleY() in response to a listener on the outputScaleY property or by binding it appropriately.

The vertical scale that the Window will use when rendering its Scene to the rendering buffer. This property is automatically updated whenever there is a change in the outputScaleY property and can be overridden either by calling setRenderScaleY() in response to a listener on the outputScaleY property or by binding it appropriately.

DefaultValue is outputScaleY

See also
Since

9

Inherited from
Window
def renderScaleY_=(scale: Double): Unit
Inherited from
Window
def requestFocus(): Unit

Requests that this Window get the input focus.

Requests that this Window get the input focus.

Inherited from
Window

The Scene to be rendered on this Stage.

The Scene to be rendered on this Stage.

Inherited from
Window
def show(owner: Window, screenX: Double, screenY: Double): Unit

Show the Popup at the specified x,y location relative to the screen

Show the Popup at the specified x,y location relative to the screen

Inherited from
PopupWindow
def show(owner: Window): Unit

Show the popup.

Show the popup.

Inherited from
PopupWindow
def show(owner: Node, screenX: Double, screenY: Double): Unit

Show the Popup at the specified x,y location relative to the screen

Show the Popup at the specified x,y location relative to the screen

Inherited from
PopupWindow

Whether or not this Stage is showing (that is, open on the user's system).

Whether or not this Stage is showing (that is, open on the user's system).

Inherited from
Window
def sizeToScene(): Unit

Set the width and height of this Window to match the size of the content of this Window's Scene.

Set the width and height of this Window to match the size of the content of this Window's Scene.

Inherited from
Window
def skin: ObjectProperty[Skin[_]]

Skin is responsible for rendering this Control.

Skin is responsible for rendering this Control.

Inherited from
Skinnable
def skin_=(v: Skin[_]): Unit
Inherited from
Skinnable

A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.

A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.

Inherited from
Styleable

Returns the Node that represents this Styleable object. This method should be overridden in cases where the Styleable is not itself a Node, so that it may optionally return the relevant root node representation of itself. By default this method returns null, which can mean that either the Styleable itself is a Node, or if that is not the case, that the Styleable does not have a node representation available at the time of request.

Returns the Node that represents this Styleable object. This method should be overridden in cases where the Styleable is not itself a Node, so that it may optionally return the relevant root node representation of itself. By default this method returns null, which can mean that either the Styleable itself is a Node, or if that is not the case, that the Styleable does not have a node representation available at the time of request.

Returns

the Node that represents this Styleable object

Since

9

Inherited from
Styleable

The parent of this Styleable, or null if there is no parent.

The parent of this Styleable, or null if there is no parent.

Inherited from
Styleable
override def toString: String
Returns

Returns the original delegate's toString() adding a [SFX] prefix.

Definition Classes
Inherited from
SFXDelegate
def typeSelector: String

The type of this Styleable that is to be used in selector matching.

The type of this Styleable that is to be used in selector matching.

Inherited from
Styleable

The width of this Stage.

The width of this Stage.

Inherited from
Window
def width_=(w: Double): Unit
Inherited from
Window

The horizontal location of this Stage on the screen.

The horizontal location of this Stage on the screen.

Inherited from
Window
def x_=(value: Double): Unit
Inherited from
Window

The vertical location of this Stage on the screen.

The vertical location of this Stage on the screen.

Inherited from
Window
def y_=(value: Double): Unit
Inherited from
Window

Concrete fields

override val delegate: PopupControl