Class/Object

scalafx.scene.control

ChoiceDialog

Related Docs: object ChoiceDialog | package control

Permalink

class ChoiceDialog[T] extends Dialog[T] with SFXDelegate[javafx.scene.control.ChoiceDialog[T]]

A dialog that shows a list of choices to the user, from which they can pick one item at most.

Wraps a JavaFX ChoiceDialog.

T

The type of the items to show to the user, and the type that is returned via result when the dialog is dismissed.

Source
ChoiceDialog.scala
See also

Dialog

Linear Supertypes
Dialog[T], EventTarget, SFXDelegate[javafx.scene.control.ChoiceDialog[T]], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChoiceDialog
  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 ChoiceDialog(defaultChoice: T, choices: Iterable[T])

    Permalink

    Creates a new ChoiceDialog instance with the first argument specifying the default choice that should be shown to the user, and the second argument specifying a collection of all available choices for the user.

    Creates a new ChoiceDialog instance with the first argument specifying the default choice that should be shown to the user, and the second argument specifying a collection of all available choices for the user. It is expected that the defaultChoice be one of the elements in the choices collection. If this is not true, then defaultChoice will be set to null and the dialog will show with the initial choice set to the first item in the list of choices.

    defaultChoice

    The item to display as the pre-selected choice in the dialog. This item must be contained within the choices varargs array.

    choices

    All possible choices to present to the user.

  2. new ChoiceDialog(delegate: javafx.scene.control.ChoiceDialog[T] = new jfxsc.ChoiceDialog[T]())

    Permalink

    Creates a default, empty instance of ChoiceDialog with no set items and a null default choice.

    Creates a default, empty instance of ChoiceDialog with no set items and a null default choice. Users of this constructor will subsequently need to call items to specify which items to show to the user.

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.

    Definition Classes
    Dialog
    See also

    Original Documentation.

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

    Permalink
    Definition Classes
    Dialog
  9. def defaultChoice: T

    Permalink

    Returns the default choice that was specified in the constructor.

  10. val delegate: javafx.scene.control.ChoiceDialog[T]

    Permalink

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    ChoiceDialogDialogEventTargetSFXDelegate
  11. def dialogPane: ObjectProperty[javafx.scene.control.DialogPane]

    Permalink
    Definition Classes
    Dialog
  12. def dialogPane_=(value: DialogPane): Unit

    Permalink
    Definition Classes
    Dialog
  13. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. 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.

    Definition Classes
    Dialog
    See also

    Original Documentation.

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

    Permalink
    Definition Classes
    Dialog
  19. def hashCode(): Int

    Permalink

    returns

    The delegate hashcode

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

    Definition Classes
    Dialog
    See also

    Original Documentation.

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

    Permalink
    Definition Classes
    Dialog
  22. def headerText_=(value: String): Unit

    Permalink
    Definition Classes
    Dialog
  23. def height: ReadOnlyDoubleProperty

    Permalink

    Property representing the height of the dialog.

    Property representing the height of the dialog.

    Definition Classes
    Dialog
  24. def height_=(h: Double): Unit

    Permalink
    Definition Classes
    Dialog
  25. 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.

    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

    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.

    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

    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.

    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

    Permalink
    Definition Classes
    Any
  29. def items: ObservableBuffer[T]

    Permalink

    Returns the buffer of all items that will be displayed to users.

    Returns the buffer of all items that will be displayed to users. This buffer can be modified by the developer to add, remove, or reorder the items to present to the user.

  30. def modality: Modality

    Permalink

    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.

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

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

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

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

    Permalink
    Definition Classes
    Dialog
  35. def onCloseRequest_=(v: EventHandler[javafx.scene.control.DialogEvent]): Unit

    Permalink
    Definition Classes
    Dialog
  36. 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.

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

    Permalink
    Definition Classes
    Dialog
  38. def onHiding: ObjectProperty[EventHandler[javafx.scene.control.DialogEvent]]

    Permalink

    Called just prior to the Dialog being hidden.

    Called just prior to the Dialog being hidden.

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

    Permalink
    Definition Classes
    Dialog
  40. def onShowing: ObjectProperty[EventHandler[javafx.scene.control.DialogEvent]]

    Permalink

    Called just prior to the Dialog being shown.

    Called just prior to the Dialog being shown.

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

    Permalink
    Definition Classes
    Dialog
  42. def onShown: ObjectProperty[EventHandler[javafx.scene.control.DialogEvent]]

    Permalink

    Called just after the Dialog is shown.

    Called just after the Dialog is shown.

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

    Permalink
    Definition Classes
    Dialog
  44. 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.

    Definition Classes
    Dialog
    See also

    Original Documentation.

  45. def resizable: BooleanProperty

    Permalink

    Represents whether the dialog is resizable.

    Represents whether the dialog is resizable.

    Definition Classes
    Dialog
  46. def resizable_=(v: Boolean): Unit

    Permalink
    Definition Classes
    Dialog
  47. def result: ObjectProperty[T]

    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.

    Definition Classes
    Dialog
    See also

    Original Documentation.

  48. def resultConverter: ObjectProperty[(ButtonType) ⇒ T]

    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.

    Definition Classes
    Dialog
  49. def resultConverter_=(f: (ButtonType) ⇒ T): Unit

    Permalink
    Definition Classes
    Dialog
  50. def result_=(value: T): Unit

    Permalink
    Definition Classes
    Dialog
  51. def selectedItem: ReadOnlyObjectProperty[T]

    Permalink

    Returns the property representing the currently selected item in the dialog.

  52. def selectedItem_=(item: T): Unit

    Permalink

    Sets the currently selected item in the dialog.

    Sets the currently selected item in the dialog.

    item

    The item to select in the dialog.

  53. def showAndWait(): Option[T]

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

    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.

  54. def showAndWait[F](j2s: F = x: R => x)(implicit convert: DConvert[T, 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.

    Definition Classes
    Dialog
    See also

    showAndWait Original Documentation.

  55. def showing: ReadOnlyBooleanProperty

    Permalink

    Represents whether the dialog is currently showing.

    Represents whether the dialog is currently showing.

    Definition Classes
    Dialog
  56. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  57. def title: StringProperty

    Permalink

    Return the title of the dialog.

    Return the title of the dialog.

    Definition Classes
    Dialog
  58. def title_=(v: String): Unit

    Permalink
    Definition Classes
    Dialog
  59. def toString(): String

    Permalink

    returns

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

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

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

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

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

    Permalink

    Property representing the width of the dialog.

    Property representing the width of the dialog.

    Definition Classes
    Dialog
  64. def width_=(w: Double): Unit

    Permalink
    Definition Classes
    Dialog
  65. 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.

    Definition Classes
    Dialog
  66. def x_=(v: Double): Unit

    Permalink
    Definition Classes
    Dialog
  67. 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.

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

    Permalink
    Definition Classes
    Dialog

Inherited from Dialog[T]

Inherited from EventTarget

Inherited from SFXDelegate[javafx.scene.control.ChoiceDialog[T]]

Inherited from AnyRef

Inherited from Any

Ungrouped