Class/Object

scalafx.scene.control

Dialog

Related Docs: object Dialog | package control

Permalink

class Dialog[R] extends EventTarget with SFXDelegate[javafx.scene.control.Dialog[R]]

A Dialog wraps a DialogPane and provides the necessary API to present it to end users.

Wraps a JavaFX Dialog.

R

The default return type of the dialog, via the result property or showAndWait method.

Source
Dialog.scala
Linear Supertypes
EventTarget, SFXDelegate[javafx.scene.control.Dialog[R]], AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Dialog
  2. EventTarget
  3. SFXDelegate
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Dialog(delegate: javafx.scene.control.Dialog[R] = new jfxsc.Dialog[R]())

    Permalink

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def buildEventDispatchChain(tail: EventDispatchChain): EventDispatchChain

    Permalink

    Construct an event dispatch chain for this target.

    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.

    tail

    the initial chain to build from

    returns

    the resulting event dispatch chain for this target

    Definition Classes
    EventTarget
    See also

    Original Documentation.

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def contentText: StringProperty

    Permalink

    A property representing the content text for the dialog pane.

    A property representing the content text for the dialog pane. The content text is lower precedence than the scalafx.scene.control.DialogPane.content node, meaning that if both the content node and the contentText properties are set, the content text will not be displayed in a default DialogPane instance.

    See also

    Original Documentation.

  8. def contentText_=(value: String): Unit

    Permalink
  9. val delegate: javafx.scene.control.Dialog[R]

    Permalink

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    DialogEventTargetSFXDelegate
  10. def dialogPane: ObjectProperty[javafx.scene.control.DialogPane]

    Permalink
  11. def dialogPane_=(value: DialogPane): Unit

    Permalink
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. 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
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. def graphic: ObjectProperty[javafx.scene.Node]

    Permalink

    The dialog graphic, presented either in the header, if one is showing, or to the left of the content.

    The dialog graphic, presented either in the header, if one is showing, or to the left of the content.

    See also

    Original Documentation.

  17. def graphic_=(value: Node): Unit

    Permalink
  18. def hashCode(): Int

    Permalink

    returns

    The delegate hashcode

    Definition Classes
    SFXDelegate → AnyRef → Any
  19. def headerText: StringProperty

    Permalink

    A property representing the header text for the dialog pane.

    A property representing the header text for the dialog pane. The header text is lower precedence than the scalafx.scene.control.DialogPane.header node, meaning that if both the header node and the headerText properties are set, the header text will not be displayed in a default DialogPane instance.

    See also

    Original Documentation.

  20. def headerText_=(value: Option[String]): Unit

    Permalink
  21. def headerText_=(value: String): Unit

    Permalink
  22. def height: ReadOnlyDoubleProperty

    Permalink

    Property representing the height of the dialog.

  23. def height_=(h: Double): Unit

    Permalink
  24. def initModality(modality: Modality): Unit

    Permalink

    Specifies the modality for this dialog.

    Specifies the modality for this dialog. This must be done prior to making the dialog visible. The modality is one of: Modality.NONE, Modality.WINDOW_MODAL, or Modality.APPLICATION_MODAL.

    modality

    the modality for this dialog.

    Exceptions thrown

    IllegalStateException if this property is set after the dialog has ever been made visible.

  25. def initOwner(window: Window): Unit

    Permalink

    Specifies the owner Window for this dialog, or null for a top-level, unowned dialog.

    Specifies the owner Window for this dialog, or null for a top-level, unowned dialog. This must be done prior to making the dialog visible.

    window

    the owner Window for this dialog.

    Exceptions thrown

    IllegalStateException if this property is set after the dialog has ever been made visible.

  26. def initStyle(style: StageStyle): Unit

    Permalink

    Specifies the style for this dialog.

    Specifies the style for this dialog. This must be done prior to making the dialog visible. The style is one of: StageStyle.DECORATED, StageStyle.UNDECORATED, StageStyle.TRANSPARENT, StageStyle.UTILITY, or StageStyle.UNIFIED.

    style

    the style for this dialog.

    Exceptions thrown

    IllegalStateException if this property is set after the dialog has ever been made visible.

  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  28. def modality: Modality

    Permalink

    Retrieves the modality attribute for this dialog.

    Retrieves the modality attribute for this dialog.

    returns

    the modality.

    See also

    getModality Original Documentation.

  29. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  32. def onCloseRequest: ObjectProperty[EventHandler[javafx.scene.control.DialogEvent]]

    Permalink
  33. def onCloseRequest_=(v: EventHandler[javafx.scene.control.DialogEvent]): Unit

    Permalink
  34. def onHidden: ObjectProperty[EventHandler[javafx.scene.control.DialogEvent]]

    Permalink

    Called just after the Dialog has been hidden.

    Called just after the Dialog has been hidden. When the scalafx.scene.control.Dialog is hidden, this event handler is invoked allowing the developer to clean up resources or perform other tasks when the scalafx.scene.control.Dialog is closed.

  35. def onHidden_=(v: EventHandler[javafx.scene.control.DialogEvent]): Unit

    Permalink
  36. def onHiding: ObjectProperty[EventHandler[javafx.scene.control.DialogEvent]]

    Permalink

    Called just prior to the Dialog being hidden.

  37. def onHiding_=(v: EventHandler[javafx.scene.control.DialogEvent]): Unit

    Permalink
  38. def onShowing: ObjectProperty[EventHandler[javafx.scene.control.DialogEvent]]

    Permalink

    Called just prior to the Dialog being shown.

  39. def onShowing_=(v: EventHandler[javafx.scene.control.DialogEvent]): Unit

    Permalink
  40. def onShown: ObjectProperty[EventHandler[javafx.scene.control.DialogEvent]]

    Permalink

    Called just after the Dialog is shown.

  41. def onShown_=(v: EventHandler[javafx.scene.control.DialogEvent]): Unit

    Permalink
  42. def owner: Window

    Permalink

    Retrieves the owner Window for this dialog, or null for an unowned dialog.

    Retrieves the owner Window for this dialog, or null for an unowned dialog.

    returns

    the owner Window.

    See also

    Original Documentation.

  43. def resizable: BooleanProperty

    Permalink

    Represents whether the dialog is resizable.

  44. def resizable_=(v: Boolean): Unit

    Permalink
  45. def result: ObjectProperty[R]

    Permalink

    A property representing what has been returned from the dialog.

    A property representing what has been returned from the dialog. A result is generated through the resultConverter, which is intended to convert from the ButtonType that the user clicked on into a value of type R.

    See also

    Original Documentation.

  46. def resultConverter: ObjectProperty[(ButtonType) ⇒ R]

    Permalink

    API to convert the scalafx.scene.control.ButtonType that the user clicked on into a result that can be returned via the scalafx.scene.control.Dialog.result property.

    API to convert the scalafx.scene.control.ButtonType that the user clicked on into a result that can be returned via the scalafx.scene.control.Dialog.result property. This is necessary as scalafx.scene.control.ButtonType represents the visual button within the dialog, and do not know how to map themselves to a valid result - that is a requirement of the dialog implementation by making use of the result converter. In some cases, the result type of a Dialog subclass is ButtonType (which means that the result converter can be null), but in some cases (where the result type, R, is not ButtonType or Void), this callback must be specified.

  47. def resultConverter_=(f: (ButtonType) ⇒ R): Unit

    Permalink
  48. def result_=(value: R): Unit

    Permalink
  49. def showAndWait[F](j2s: F = x: R => x)(implicit convert: DConvert[R, F]): Option[S]

    Permalink

    Shows the dialog and waits for the user response (in other words, brings up a blocking dialog, with the returned value the users input).

    Shows the dialog and waits for the user response (in other words, brings up a blocking dialog, with the returned value the users input).

    The intended use when return value is ignored:

    dialog.showAndWait()

    Or when return value is required:

    val r = dialog.showAndWait()
    r match {
      case Some(v) => ...
      case None => ...
    }
    returns

    An Option that contains the result.

    See also

    showAndWait Original Documentation.

  50. def showing: ReadOnlyBooleanProperty

    Permalink

    Represents whether the dialog is currently showing.

  51. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  52. def title: StringProperty

    Permalink

    Return the title of the dialog.

  53. def title_=(v: String): Unit

    Permalink
  54. def toString(): String

    Permalink

    returns

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

    Definition Classes
    SFXDelegate → AnyRef → Any
  55. final def wait(): Unit

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

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

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

    Permalink

    Property representing the width of the dialog.

  59. def width_=(w: Double): Unit

    Permalink
  60. def x: ReadOnlyDoubleProperty

    Permalink

    The horizontal location of this scalafx.scene.control.Dialog.

    The horizontal location of this scalafx.scene.control.Dialog. Changing this attribute will move the scalafx.scene.control.Dialog horizontally.

  61. def x_=(v: Double): Unit

    Permalink
  62. def y: ReadOnlyDoubleProperty

    Permalink

    The vertical location of this scalafx.scene.control.Dialog.

    The vertical location of this scalafx.scene.control.Dialog. Changing this attribute will move the scalafx.scene.control.Dialog vertically.

  63. def y_=(v: Double): Unit

    Permalink

Inherited from EventTarget

Inherited from SFXDelegate[javafx.scene.control.Dialog[R]]

Inherited from AnyRef

Inherited from Any

Ungrouped