Packages

class TextInputDialog extends Dialog[String] with SFXDelegate[javafx.scene.control.TextInputDialog]

A dialog that shows a text input control to the user.

Wraps a JavaFX TextInputDialog.

Source
TextInputDialog.scala
Linear Supertypes
Dialog[String], EventTarget, SFXDelegate[javafx.scene.control.TextInputDialog], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TextInputDialog
  2. Dialog
  3. EventTarget
  4. SFXDelegate
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TextInputDialog(defaultValue: String)

    Creates a new TextInputDialog with the default value entered into the dialog TextField.

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

    Creates a new TextInputDialog without a default value entered into the dialog.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def buildEventDispatchChain(tail: EventDispatchChain): EventDispatchChain

    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
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. def contentText: StringProperty

    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.

    Definition Classes
    Dialog
    See also

    Original Documentation.

  8. def contentText_=(value: String): Unit
    Definition Classes
    Dialog
  9. def defaultValue: String

    The default value that was specified in the constructor.

  10. val delegate: javafx.scene.control.TextInputDialog

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    TextInputDialog → Dialog → EventTarget → SFXDelegate
  11. def dialogPane: ObjectProperty[javafx.scene.control.DialogPane]
    Definition Classes
    Dialog
  12. def dialogPane_=(value: DialogPane): Unit
    Definition Classes
    Dialog
  13. def editor: TextField

    The TextField used within this dialog.

  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(ref: Any): Boolean

    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
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def graphic: ObjectProperty[javafx.scene.Node]

    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.

    Definition Classes
    Dialog
    See also

    Original Documentation.

  18. def graphic_=(value: Node): Unit
    Definition Classes
    Dialog
  19. def hashCode(): Int

    returns

    The delegate hashcode

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

    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.

    Definition Classes
    Dialog
    See also

    Original Documentation.

  21. def headerText_=(value: Option[String]): Unit
    Definition Classes
    Dialog
  22. def headerText_=(value: String): Unit
    Definition Classes
    Dialog
  23. def height: ReadOnlyDoubleProperty

    Property representing the height of the dialog.

    Property representing the height of the dialog.

    Definition Classes
    Dialog
  24. def height_=(h: Double): Unit
    Definition Classes
    Dialog
  25. def initModality(modality: Modality): Unit

    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.

    Definition Classes
    Dialog
    Exceptions thrown

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

  26. def initOwner(window: Window): Unit

    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.

    Definition Classes
    Dialog
    Exceptions thrown

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

  27. def initStyle(style: StageStyle): Unit

    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.

    Definition Classes
    Dialog
    Exceptions thrown

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

  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def modality: Modality

    Retrieves the modality attribute for this dialog.

    Retrieves the modality attribute for this dialog.

    returns

    the modality.

    Definition Classes
    Dialog
    See also

    getModality Original Documentation.

  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def onCloseRequest: ObjectProperty[EventHandler[javafx.scene.control.DialogEvent]]
    Definition Classes
    Dialog
  34. def onCloseRequest_=(v: EventHandler[javafx.scene.control.DialogEvent]): Unit
    Definition Classes
    Dialog
  35. def onHidden: ObjectProperty[EventHandler[javafx.scene.control.DialogEvent]]

    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.

    Definition Classes
    Dialog
  36. def onHidden_=(v: EventHandler[javafx.scene.control.DialogEvent]): Unit
    Definition Classes
    Dialog
  37. def onHiding: ObjectProperty[EventHandler[javafx.scene.control.DialogEvent]]

    Called just prior to the Dialog being hidden.

    Called just prior to the Dialog being hidden.

    Definition Classes
    Dialog
  38. def onHiding_=(v: EventHandler[javafx.scene.control.DialogEvent]): Unit
    Definition Classes
    Dialog
  39. def onShowing: ObjectProperty[EventHandler[javafx.scene.control.DialogEvent]]

    Called just prior to the Dialog being shown.

    Called just prior to the Dialog being shown.

    Definition Classes
    Dialog
  40. def onShowing_=(v: EventHandler[javafx.scene.control.DialogEvent]): Unit
    Definition Classes
    Dialog
  41. def onShown: ObjectProperty[EventHandler[javafx.scene.control.DialogEvent]]

    Called just after the Dialog is shown.

    Called just after the Dialog is shown.

    Definition Classes
    Dialog
  42. def onShown_=(v: EventHandler[javafx.scene.control.DialogEvent]): Unit
    Definition Classes
    Dialog
  43. def owner: Window

    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.

    Definition Classes
    Dialog
    See also

    Original Documentation.

  44. def resizable: BooleanProperty

    Represents whether the dialog is resizable.

    Represents whether the dialog is resizable.

    Definition Classes
    Dialog
  45. def resizable_=(v: Boolean): Unit
    Definition Classes
    Dialog
  46. def result: ObjectProperty[String]

    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.

    Definition Classes
    Dialog
    See also

    Original Documentation.

  47. def resultConverter: ObjectProperty[(ButtonType) ⇒ String]

    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.

    Definition Classes
    Dialog
  48. def resultConverter_=(f: (ButtonType) ⇒ String): Unit
    Definition Classes
    Dialog
  49. def result_=(value: String): Unit
    Definition Classes
    Dialog
  50. def showAndWait(): Option[String]

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

    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.

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

    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.

    Definition Classes
    Dialog
    See also

    showAndWait Original Documentation.

  52. def showing: ReadOnlyBooleanProperty

    Represents whether the dialog is currently showing.

    Represents whether the dialog is currently showing.

    Definition Classes
    Dialog
  53. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  54. def title: StringProperty

    Return the title of the dialog.

    Return the title of the dialog.

    Definition Classes
    Dialog
  55. def title_=(v: String): Unit
    Definition Classes
    Dialog
  56. def toString(): String

    returns

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

    Definition Classes
    SFXDelegate → AnyRef → Any
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. def width: ReadOnlyDoubleProperty

    Property representing the width of the dialog.

    Property representing the width of the dialog.

    Definition Classes
    Dialog
  61. def width_=(w: Double): Unit
    Definition Classes
    Dialog
  62. def x: ReadOnlyDoubleProperty

    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.

    Definition Classes
    Dialog
  63. def x_=(v: Double): Unit
    Definition Classes
    Dialog
  64. def y: ReadOnlyDoubleProperty

    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.

    Definition Classes
    Dialog
  65. def y_=(v: Double): Unit
    Definition Classes
    Dialog

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Dialog[String]

Inherited from EventTarget

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

Inherited from AnyRef

Inherited from Any

Ungrouped