Class/Object

scalafx.scene.control

Tooltip

Related Docs: object Tooltip | package control

Permalink

class Tooltip extends PopupControl with SFXDelegate[javafx.scene.control.Tooltip]

Wraps a JavaFX Tooltip.

Source
Tooltip.scala
Linear Supertypes
PopupControl, Skinnable, Styleable, PopupWindow, Window, EventTarget, SFXDelegate[javafx.scene.control.Tooltip], EventHandlerDelegate, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tooltip
  2. PopupControl
  3. Skinnable
  4. Styleable
  5. PopupWindow
  6. Window
  7. EventTarget
  8. SFXDelegate
  9. EventHandlerDelegate
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Tooltip(text: String)

    Permalink

    Creates a tooltip with the specified text.

  2. new Tooltip(delegate: javafx.scene.control.Tooltip = new jfxsc.Tooltip)

    Permalink

    Creates a new ScalaFX Tooltip from its JavaFX counterpart.

    Creates a new ScalaFX Tooltip from its JavaFX counterpart.

    delegate

    JavaFX Tooltip to be wrapped. It defaul value is a new JavaFX Tooltip with no text.

Type Members

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

    Permalink

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

    Permalink

    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"

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

    Permalink

    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"

    Definition Classes
    EventHandlerDelegate

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object FilterMagnet

    Permalink

    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"

    Definition Classes
    EventHandlerDelegate
  5. object HandlerMagnet

    Permalink

    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"

    Definition Classes
    EventHandlerDelegate
  6. def activated: ReadOnlyBooleanProperty

    Permalink

    Typically, the tooltip is "activated" when the mouse moves over a Control.

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

    Permalink

    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

    Definition Classes
    EventHandlerDelegate
  8. def addEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Permalink

    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

    Definition Classes
    EventHandlerDelegate
  9. def anchorLocation: ObjectProperty[AnchorLocation]

    Permalink

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

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

    Definition Classes
    PopupWindow
  10. def anchorLocation_=(v: AnchorLocation): Unit

    Permalink
    Definition Classes
    PopupWindow
  11. def anchorX: ReadOnlyDoubleProperty

    Permalink

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

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

    Definition Classes
    PopupWindow
  12. def anchorY: ReadOnlyDoubleProperty

    Permalink

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

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

    Definition Classes
    PopupWindow
  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  14. def autoFix: BooleanProperty

    Permalink

    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.

    Definition Classes
    PopupWindow
  15. def autoFix_=(v: Boolean): Unit

    Permalink
    Definition Classes
    PopupWindow
  16. def autoHide: BooleanProperty

    Permalink

    Specifies whether Popups should auto hide.

    Specifies whether Popups should auto hide.

    Definition Classes
    PopupWindow
  17. def autoHide_=(v: Boolean): Unit

    Permalink
    Definition Classes
    PopupWindow
  18. def buildEventDispatchChain(chain: EventDispatchChain): EventDispatchChain

    Permalink

    Construct an event dispatch chain for this target.

    Construct an event dispatch chain for this target.

    Definition Classes
    EventHandlerDelegate
  19. def centerOnScreen(): Unit

    Permalink

    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.

    Definition Classes
    Window
  20. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. def consumeAutoHidingEvents: BooleanProperty

    Permalink

    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.

    Definition Classes
    PopupWindow
    Since

    2.2

  22. def consumeAutoHidingEvents_=(v: Boolean): Unit

    Permalink
    Definition Classes
    PopupWindow
  23. def contentDisplay: ObjectProperty[javafx.scene.control.ContentDisplay]

    Permalink

    Specifies the positioning of the graphic relative to the text.

  24. def contentDisplay_=(v: ContentDisplay): Unit

    Permalink
  25. def cssMetaData: Seq[CssMetaData[_ <: Styleable, _]]

    Permalink

    The CssMetaData of this Styleable.

    The CssMetaData of this Styleable.

    Definition Classes
    Styleable
  26. val delegate: javafx.scene.control.Tooltip

    Permalink

    JavaFX Tooltip to be wrapped.

    JavaFX Tooltip to be wrapped. It defaul value is a new JavaFX Tooltip with no text.

    Definition Classes
    TooltipPopupControlPopupWindowWindowSFXDelegate
  27. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. def equals(ref: Any): Boolean

    Permalink

    Verifies if a object is equals to this delegate.

    Verifies if a object is equals to this delegate.

    ref

    Object to be compared.

    returns

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

    Definition Classes
    SFXDelegate → AnyRef → Any
  29. def eventDispatcher: ObjectProperty[EventDispatcher]

    Permalink

    Specifies the event dispatcher for this node.

    Specifies the event dispatcher for this node.

    Definition Classes
    Window
  30. def eventDispatcher_=(v: EventDispatcher): Unit

    Permalink
    Definition Classes
    Window
  31. def eventHandlerDelegate: EventHandled

    Permalink

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

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

    Attributes
    protected
    Definition Classes
    WindowEventHandlerDelegate
  32. def filterEvent[J <: Event, S <: Event with SFXDelegate[J]](eventType: EventType[J])(filter: FilterMagnet[J, S]): Subscription

    Permalink

    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.

    Definition Classes
    EventHandlerDelegate
  33. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  34. def fireEvent(event: Event): Unit

    Permalink

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

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

    Definition Classes
    Window
  35. def focused: ReadOnlyBooleanProperty

    Permalink

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

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

    Definition Classes
    Window
  36. def font: ObjectProperty[Font]

    Permalink

    The default font to use for text in the Tooltip.

  37. def font_=(v: Font): Unit

    Permalink
  38. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  39. def getId: String

    Permalink

    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.

    Definition Classes
    Styleable
  40. def getStyle: String

    Permalink

    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.

    Definition Classes
    Styleable
  41. def graphic: ObjectProperty[javafx.scene.Node]

    Permalink

    An optional icon for the Tooltip.

  42. def graphicTextGap: DoubleProperty

    Permalink

    The amount of space between the graphic and text

  43. def graphicTextGap_=(v: Double): Unit

    Permalink
  44. def graphic_=(v: Node): Unit

    Permalink
  45. def handleEvent[J <: Event, S <: Event with SFXDelegate[J]](eventType: EventType[J])(handler: HandlerMagnet[J, S]): Subscription

    Permalink

    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

    Definition Classes
    EventHandlerDelegate
  46. def hashCode(): Int

    Permalink

    returns

    The delegate hashcode

    Definition Classes
    SFXDelegate → AnyRef → Any
  47. def height: ReadOnlyDoubleProperty

    Permalink

    The height of this Stage.

    The height of this Stage.

    Definition Classes
    Window
  48. def height_=(h: Double): Unit

    Permalink
    Definition Classes
    Window
  49. def hide(): Unit

    Permalink

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

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

    Definition Classes
    Window
  50. def hideOnEscape: BooleanProperty

    Permalink

    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.

    Definition Classes
    PopupWindow
  51. def hideOnEscape_=(v: Boolean): Unit

    Permalink
    Definition Classes
    PopupWindow
  52. def id: StringProperty

    Permalink

    The id of this Node.

    The id of this Node.

    Definition Classes
    PopupControl
  53. def id_=(v: String): Unit

    Permalink
    Definition Classes
    PopupControl
  54. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  55. def maxHeight: DoubleProperty

    Permalink

    Property for overriding the control's computed maximum height.

    Property for overriding the control's computed maximum height.

    Definition Classes
    PopupControl
  56. def maxHeight_=(v: Double): Unit

    Permalink
    Definition Classes
    PopupControl
  57. def maxWidth: DoubleProperty

    Permalink

    Property for overriding the control's computed maximum width.

    Property for overriding the control's computed maximum width.

    Definition Classes
    PopupControl
  58. def maxWidth_=(v: Double): Unit

    Permalink
    Definition Classes
    PopupControl
  59. def minHeight: DoubleProperty

    Permalink

    Property for overriding the control's computed minimum height.

    Property for overriding the control's computed minimum height.

    Definition Classes
    PopupControl
  60. def minHeight_=(v: Double): Unit

    Permalink
    Definition Classes
    PopupControl
  61. def minWidth: DoubleProperty

    Permalink

    Property for overriding the control's computed minimum width.

    Property for overriding the control's computed minimum width.

    Definition Classes
    PopupControl
  62. def minWidth_=(v: Double): Unit

    Permalink
    Definition Classes
    PopupControl
  63. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  64. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  65. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  66. def onAutoHide: ObjectProperty[EventHandler[Event]]

    Permalink

    Called after autoHide is run.

    Called after autoHide is run.

    Definition Classes
    PopupWindow
  67. def onAutoHide_=(v: EventHandler[Event]): Unit

    Permalink
    Definition Classes
    PopupWindow
  68. def onCloseRequest: ObjectProperty[EventHandler[WindowEvent]]

    Permalink

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

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

    Definition Classes
    Window
  69. def onCloseRequest_=(v: EventHandler[WindowEvent]): Unit

    Permalink
    Definition Classes
    Window
  70. def onHidden: ObjectProperty[EventHandler[WindowEvent]]

    Permalink

    Called just after the Window has been hidden.

    Called just after the Window has been hidden.

    Definition Classes
    Window
  71. def onHidden_=(v: EventHandler[WindowEvent]): Unit

    Permalink
    Definition Classes
    Window
  72. def onHiding: ObjectProperty[EventHandler[WindowEvent]]

    Permalink

    Called just prior to the Window being hidden.

    Called just prior to the Window being hidden.

    Definition Classes
    Window
  73. def onHiding_=(v: EventHandler[WindowEvent]): Unit

    Permalink
    Definition Classes
    Window
  74. def onShowing: ObjectProperty[EventHandler[WindowEvent]]

    Permalink

    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.

    Definition Classes
    Window
  75. def onShowing_=(v: EventHandler[WindowEvent]): Unit

    Permalink
    Definition Classes
    Window
  76. def onShown: ObjectProperty[EventHandler[WindowEvent]]

    Permalink

    Called just after the Window is shown.

    Called just after the Window is shown.

    Definition Classes
    Window
  77. def onShown_=(v: EventHandler[WindowEvent]): Unit

    Permalink
    Definition Classes
    Window
  78. def opacity: DoubleProperty

    Permalink

    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.

    Definition Classes
    Window
  79. def opacity_=(v: Double): Unit

    Permalink
    Definition Classes
    Window
  80. def ownerNode: ReadOnlyObjectProperty[javafx.scene.Node]

    Permalink

    The node which is the owner of this popup.

    The node which is the owner of this popup.

    Definition Classes
    PopupWindow
  81. def ownerWindow: ReadOnlyObjectProperty[Window]

    Permalink

    The window which is the parent of this popup.

    The window which is the parent of this popup.

    Definition Classes
    PopupWindow
  82. def prefHeight: DoubleProperty

    Permalink

    Property for overriding the control's computed preferred height.

    Property for overriding the control's computed preferred height.

    Definition Classes
    PopupControl
  83. def prefHeight_=(v: Double): Unit

    Permalink
    Definition Classes
    PopupControl
  84. def prefWidth: DoubleProperty

    Permalink

    Property for overriding the control's computed preferred width.

    Property for overriding the control's computed preferred width.

    Definition Classes
    PopupControl
  85. def prefWidth_=(v: Double): Unit

    Permalink
    Definition Classes
    PopupControl
  86. def pseudoClassStateChanged(pseudoClass: PseudoClass, active: Boolean): Unit

    Permalink

    Definition Classes
    PopupControl
    Since

    8.0

  87. def pseudoClassStates: ObservableSet[PseudoClass]

    Permalink

    The pseudo-class state of this Styleable.

    The pseudo-class state of this Styleable.

    Definition Classes
    Styleable
  88. def removeEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Permalink

    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

    Definition Classes
    EventHandlerDelegate
  89. def removeEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Permalink

    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

    Definition Classes
    EventHandlerDelegate
  90. def requestFocus(): Unit

    Permalink

    Requests that this Window get the input focus.

    Requests that this Window get the input focus.

    Definition Classes
    Window
  91. def scene: ReadOnlyObjectProperty[javafx.scene.Scene]

    Permalink

    The Scene to be rendered on this Stage.

    The Scene to be rendered on this Stage.

    Definition Classes
    Window
  92. def show(owner: Window, screenX: Double, screenY: Double): Unit

    Permalink

    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

    Definition Classes
    PopupWindow
  93. def show(owner: Window): Unit

    Permalink

    Show the popup.

    Show the popup.

    Definition Classes
    PopupWindow
  94. def show(owner: Node, screenX: Double, screenY: Double): Unit

    Permalink

    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

    Definition Classes
    PopupWindow
  95. def showing: ReadOnlyBooleanProperty

    Permalink

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

    Definition Classes
    Window
  96. def sizeToScene(): Unit

    Permalink

    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.

    Definition Classes
    Window
  97. def skin: ObjectProperty[javafx.scene.control.Skin[_]]

    Permalink

    Skin is responsible for rendering this Control.

    Skin is responsible for rendering this Control.

    Definition Classes
    Skinnable
  98. def skin_=(v: Skin[_]): Unit

    Permalink
    Definition Classes
    Skinnable
  99. def style: StringProperty

    Permalink

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

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

    Definition Classes
    PopupControl
  100. def styleClass: ObservableBuffer[String]

    Permalink

    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.

    Definition Classes
    Styleable
  101. def style_=(v: String): Unit

    Permalink
    Definition Classes
    PopupControl
  102. def styleableParent: Styleable

    Permalink

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

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

    Definition Classes
    Styleable
  103. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  104. def text: StringProperty

    Permalink

    The text to display in the tooltip.

  105. def textAlignment: ObjectProperty[TextAlignment]

    Permalink

    Specifies the behavior for lines of text when text is multiline Unlike contentDisplay which affects the graphic and text, this setting only affects multiple lines of text relative to the text bounds.

  106. def textAlignment_=(v: TextAlignment): Unit

    Permalink
  107. def textOverrun: ObjectProperty[javafx.scene.control.OverrunStyle]

    Permalink

    Specifies the behavior to use if the text of the Tooltip exceeds the available space for rendering the text.

  108. def textOverrun_=(v: OverrunStyle): Unit

    Permalink
  109. def text_=(v: String): Unit

    Permalink
  110. def toString(): String

    Permalink

    returns

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

    Definition Classes
    SFXDelegate → AnyRef → Any
  111. def typeSelector: String

    Permalink

    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.

    Definition Classes
    Styleable
  112. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  113. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  114. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  115. def width: ReadOnlyDoubleProperty

    Permalink

    The width of this Stage.

    The width of this Stage.

    Definition Classes
    Window
  116. def width_=(w: Double): Unit

    Permalink
    Definition Classes
    Window
  117. def wrapText: BooleanProperty

    Permalink

    If a run of text exceeds the width of the Tooltip, then this variable indicates whether the text should wrap onto another line.

  118. def wrapText_=(v: Boolean): Unit

    Permalink
  119. def x: ReadOnlyDoubleProperty

    Permalink

    The horizontal location of this Stage on the screen.

    The horizontal location of this Stage on the screen.

    Definition Classes
    Window
  120. def x_=(value: Double): Unit

    Permalink
    Definition Classes
    Window
  121. def y: ReadOnlyDoubleProperty

    Permalink

    The vertical location of this Stage on the screen.

    The vertical location of this Stage on the screen.

    Definition Classes
    Window
  122. def y_=(value: Double): Unit

    Permalink
    Definition Classes
    Window

Inherited from PopupControl

Inherited from Skinnable

Inherited from Styleable

Inherited from PopupWindow

Inherited from Window

Inherited from EventTarget

Inherited from SFXDelegate[javafx.scene.control.Tooltip]

Inherited from EventHandlerDelegate

Inherited from AnyRef

Inherited from Any

Ungrouped