Dialog

class Dialog[R](val delegate: Dialog[R]) extends EventTarget with SFXDelegate[Dialog[R]]

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

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

Wraps a JavaFX Dialog.

Type Params
R

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

Companion
object
trait SFXDelegate[Dialog[R]]
class Object
trait Matchable
class Any

Value members

Concrete methods

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.

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
def contentText_=(value: String): Unit
def dialogPane: ObjectProperty[DialogPane]
def dialogPane_=(value: DialogPane): Unit

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
def graphic_=(value: Node): Unit

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.

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
def headerText_=(value: String): Unit
def headerText_=(value: Option[String]): Unit

Property representing the height of the dialog.

Property representing the height of the dialog.

def height_=(h: Double): Unit
def initModality(modality: Modality): Unit

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.

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.

Value Params
modality

the modality for this dialog.

Throws
IllegalStateException

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

def initOwner(window: Window): Unit

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.

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.

Value Params
window

the owner Window for this dialog.

Throws
IllegalStateException

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

def initStyle(style: StageStyle): Unit

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.

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.

Value Params
style

the style for this dialog.

Throws
IllegalStateException

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

Retrieves the modality attribute for this dialog.

Retrieves the modality attribute for this dialog.

Returns

the modality.

See also
def onCloseRequest: ObjectProperty[EventHandler[DialogEvent]]
def onCloseRequest_=(v: EventHandler[DialogEvent]): Unit
def onHidden: ObjectProperty[EventHandler[DialogEvent]]

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.

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.

def onHidden_=(v: EventHandler[DialogEvent]): Unit
def onHiding: ObjectProperty[EventHandler[DialogEvent]]

Called just prior to the Dialog being hidden.

Called just prior to the Dialog being hidden.

def onHiding_=(v: EventHandler[DialogEvent]): Unit
def onShowing: ObjectProperty[EventHandler[DialogEvent]]

Called just prior to the Dialog being shown.

Called just prior to the Dialog being shown.

def onShowing_=(v: EventHandler[DialogEvent]): Unit
def onShown: ObjectProperty[EventHandler[DialogEvent]]

Called just after the Dialog is shown.

Called just after the Dialog is shown.

def onShown_=(v: EventHandler[DialogEvent]): Unit

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

Represents whether the dialog is resizable.

Represents whether the dialog is resizable.

def resizable_=(v: Boolean): Unit

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.

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

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.

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.

def resultConverter_=(f: ButtonType => R): Unit
def result_=(value: R): Unit
def showAndWait[F](j2s: F)(convert: DConvert[R, 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.

See also

Represents whether the dialog is currently showing.

Represents whether the dialog is currently showing.

Return the title of the dialog.

Return the title of the dialog.

def title_=(v: String): Unit

Property representing the width of the dialog.

Property representing the width of the dialog.

def width_=(w: Double): Unit

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

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

def x_=(v: Double): Unit

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

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

def y_=(v: Double): Unit

Inherited methods

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 Params
tail

the initial chain to build from

Returns

the resulting event dispatch chain for this target

See also
Inherited from
EventTarget
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 Params
ref

Object to be compared.

Returns

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

Definition Classes
Inherited from
SFXDelegate
override def hashCode: Int
Returns

The delegate hashcode

Definition Classes
Inherited from
SFXDelegate
override def toString: String
Returns

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

Definition Classes
Inherited from
SFXDelegate

Concrete fields

override val delegate: Dialog[R]