scalafx
API
Generated with
scalafx/scalafx/scalafx.scene/scalafx.scene.control/PopupControl

PopupControl

scalafx.scene.control.PopupControl
See thePopupControl companion object
class PopupControl(val delegate: PopupControl) extends PopupWindow, Styleable, Skinnable, SFXDelegate[PopupControl]

Wraps a JavaFX PopupControl.

Value parameters

delegate

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

Attributes

Constructor

Creates a new ScalaFX PopupControl from its JavaFX counterpart.

Companion
object
Graph
Supertypes
trait Skinnable
trait Styleable
class PopupWindow
class Window
class EventTarget
trait SFXDelegate[PopupControl]
class Object
trait Matchable
class Any
Show all
Known subtypes
class ContextMenu
class Tooltip

Members list

Type members

Inherited classlikes

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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any

Value members

Concrete methods

def id: StringProperty

The id of this Node.

The id of this Node.

Attributes

def id_=(v: String): Unit
def maxHeight: DoubleProperty

Property for overriding the control's computed maximum height.

Property for overriding the control's computed maximum height.

Attributes

def maxWidth: DoubleProperty

Property for overriding the control's computed maximum width.

Property for overriding the control's computed maximum width.

Attributes

def minHeight: DoubleProperty

Property for overriding the control's computed minimum height.

Property for overriding the control's computed minimum height.

Attributes

def minWidth: DoubleProperty

Property for overriding the control's computed minimum width.

Property for overriding the control's computed minimum width.

Attributes

def prefHeight: DoubleProperty

Property for overriding the control's computed preferred height.

Property for overriding the control's computed preferred height.

Attributes

def prefWidth: DoubleProperty

Property for overriding the control's computed preferred width.

Property for overriding the control's computed preferred width.

Attributes

def pseudoClassStateChanged(pseudoClass: PseudoClass, active: Boolean): Unit

Attributes

Since

8.0

def style: StringProperty

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

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

Attributes

def style_=(v: String): Unit

Inherited methods

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.

Attributes

Inherited from:
PopupWindow
def anchorLocation_=(v: AnchorLocation): Unit

Attributes

Inherited from:
PopupWindow
def anchorX: ReadOnlyDoubleProperty

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

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

Attributes

Inherited from:
PopupWindow
def anchorY: ReadOnlyDoubleProperty

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

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

Attributes

Inherited from:
PopupWindow
def autoFix: BooleanProperty

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.

Attributes

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

Attributes

Inherited from:
PopupWindow
def autoHide: BooleanProperty

Specifies whether Popups should auto hide.

Specifies whether Popups should auto hide.

Attributes

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

Attributes

Inherited from:
PopupWindow
def buildEventDispatchChain(tail: EventDispatchChain): EventDispatchChain

Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this EventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an EventDispatcher for itself to the chain.

Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this EventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an EventDispatcher for itself to the chain.

In the case the event target is part of some hierarchy, the chain for it is usually built from event dispatchers collected from the root of the hierarchy to the event target.

The event dispatch chain is constructed by modifications to the provided initial event dispatch chain. The returned chain should have the initial chain at its end so the dispatchers should be prepended to the initial chain.

The caller shouldn't assume that the initial chain remains unchanged nor that the returned value will reference a different chain.

Value parameters

tail

the initial chain to build from

Attributes

Returns

the resulting event dispatch chain for this target

See also
Inherited from:
EventTarget
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.

Attributes

Inherited from:
Window
def consumeAutoHidingEvents: BooleanProperty

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.

Attributes

Since

2.2

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

Attributes

Inherited from:
PopupWindow
def cssMetaData: Seq[CssMetaData[_ <: Styleable, _]]

The CssMetaData of this Styleable.

The CssMetaData of this Styleable.

Attributes

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 parameters

ref

Object to be compared.

Attributes

Returns

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

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

Specifies the event dispatcher for this node.

Specifies the event dispatcher for this node.

Attributes

Inherited from:
Window
def eventDispatcher_=(v: EventDispatcher): Unit

Attributes

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 parameters

J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value parameters

eventType

type of events that will be handled.

filter

code handling the event, see examples above.

Attributes

Inherited from:
EventTarget
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.

Attributes

Inherited from:
Window
def focused: ReadOnlyBooleanProperty

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

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

Attributes

Inherited from:
Window
def forceIntegerRenderScale: BooleanProperty

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

Attributes

See also
Since

9

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

Attributes

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.

Attributes

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.

Attributes

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 parameters

J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value parameters

eventType

type of events that will be handled.

handler

code handling the event, see examples above.

Attributes

Returns

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

Inherited from:
EventTarget
override def hashCode: Int

Attributes

Returns

The delegate hashcode

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
def height: ReadOnlyDoubleProperty

The height of this Stage.

The height of this Stage.

Attributes

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

Attributes

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.

Attributes

Inherited from:
Window
def hideOnEscape: BooleanProperty

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.

Attributes

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

Attributes

Inherited from:
PopupWindow
def onAutoHide: ObjectProperty[EventHandler[Event]]

Called after autoHide is run.

Called after autoHide is run.

Attributes

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

Attributes

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.

Attributes

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

Attributes

Inherited from:
Window
def onHidden: ObjectProperty[EventHandler[WindowEvent]]

Called just after the Window has been hidden.

Called just after the Window has been hidden.

Attributes

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

Attributes

Inherited from:
Window
def onHiding: ObjectProperty[EventHandler[WindowEvent]]

Called just prior to the Window being hidden.

Called just prior to the Window being hidden.

Attributes

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

Attributes

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.

Attributes

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

Attributes

Inherited from:
Window
def onShown: ObjectProperty[EventHandler[WindowEvent]]

Called just after the Window is shown.

Called just after the Window is shown.

Attributes

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

Attributes

Inherited from:
Window
def opacity: DoubleProperty

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.

Attributes

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

Attributes

Inherited from:
Window
def outputScaleX: ReadOnlyDoubleProperty

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.

Attributes

See also
Since

9

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

Attributes

Inherited from:
Window
def outputScaleY: ReadOnlyDoubleProperty

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.

Attributes

See also
Since

9

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

Attributes

Inherited from:
Window
def ownerNode: ReadOnlyObjectProperty[Node]

The node which is the owner of this popup.

The node which is the owner of this popup.

Attributes

Inherited from:
PopupWindow
def ownerWindow: ReadOnlyObjectProperty[Window]

The window which is the parent of this popup.

The window which is the parent of this popup.

Attributes

Inherited from:
PopupWindow
def pseudoClassStates: ObservableSet[PseudoClass]

The pseudo-class state of this Styleable.

The pseudo-class state of this Styleable.

Attributes

Inherited from:
Styleable
def renderScaleX: DoubleProperty

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

Attributes

See also
Since

9

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

Attributes

Inherited from:
Window
def renderScaleY: DoubleProperty

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

Attributes

See also
Since

9

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

Attributes

Inherited from:
Window
def requestFocus(): Unit

Requests that this Window get the input focus.

Requests that this Window get the input focus.

Attributes

Inherited from:
Window
def scene: ReadOnlyObjectProperty[Scene]

The Scene to be rendered on this Stage.

The Scene to be rendered on this Stage.

Attributes

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

Attributes

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

Show the popup.

Show the popup.

Attributes

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

Attributes

Inherited from:
PopupWindow
def showing: ReadOnlyBooleanProperty

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).

Attributes

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.

Attributes

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

Skin is responsible for rendering this Control.

Skin is responsible for rendering this Control.

Attributes

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

Attributes

Inherited from:
Skinnable
def styleClass: ObservableBuffer[String]

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.

Attributes

Inherited from:
Styleable
def styleableNode: Node

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.

Attributes

Returns

the Node that represents this Styleable object

Since

9

Inherited from:
Styleable
def styleableParent: 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.

Attributes

Inherited from:
Styleable
override def toString: String

Attributes

Returns

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

Definition Classes
SFXDelegate -> Any
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.

Attributes

Inherited from:
Styleable
def width: ReadOnlyDoubleProperty

The width of this Stage.

The width of this Stage.

Attributes

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

Attributes

Inherited from:
Window
def x: ReadOnlyDoubleProperty

The horizontal location of this Stage on the screen.

The horizontal location of this Stage on the screen.

Attributes

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

Attributes

Inherited from:
Window
def y: ReadOnlyDoubleProperty

The vertical location of this Stage on the screen.

The vertical location of this Stage on the screen.

Attributes

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

Attributes

Inherited from:
Window

Concrete fields

override val delegate: PopupControl

JavaFX object to be wrapped.

JavaFX object to be wrapped.

Attributes

Generated with