The Alert class subclasses the Dialog
class, and provides support for a number
of pre-built dialog types that can be easily shown to users to prompt for a
response.
The Alert class subclasses the Dialog
class, and provides support for a number
of pre-built dialog types that can be easily shown to users to prompt for a
response.
Wraps a JavaFX Alert.
Example of displaying an information dialog:
new Alert(AlertType.Information) {
title = "Information Dialog"
headerText = "Look, an Information Dialog"
contentText = "I have a great message for you!"
}.showAndWait()
A bit more elaborated example that is using a custom buttons:
val One = new ButtonType("One")
val Two = new ButtonType("Two")
val Three = new ButtonType("Three")
val alert = new Alert(AlertType.Confirmation) {
title = "Confirmation Dialog with Custom Actions"
headerText = "Look, a Confirmation Dialog with Custom Actions"
contentText = "Choose your option."
buttonTypes = Seq(One, Two, Three, ButtonType.Cancel)
}
val result = alert.showAndWait()
result match {
case Some(One) => println("... user chose \"One\"")
case Some(Two) => println("... user chose \"Two\"")
case Some(Three) => println("... user chose \"Three\"")
case _ => println("... user chose CANCEL or closed the dialog")
}
- Companion
- object
Value members
Constructors
Creates an alert with the given AlertType (refer to the AlertType
documentation for clarification over which one is most appropriate).
Creates an alert with the given AlertType (refer to the AlertType
documentation for clarification over which one is most appropriate).
By passing in an AlertType, default values for the
title
property, headerText
property, graphic
property properties are set. Once the Alert
is instantiated, developers are able to modify the values of the alert as
desired.
Creates an alert with the given contentText, ButtonTypes, and AlertType
(refer to the AlertType
documentation for clarification over which
one is most appropriate).
Creates an alert with the given contentText, ButtonTypes, and AlertType
(refer to the AlertType
documentation for clarification over which
one is most appropriate).
By passing in a variable number of ButtonType arguments, the developer is directly overriding the default buttons that will be displayed in the dialog, replacing the pre-defined buttons with whatever is specified in the varargs array.
By passing in an AlertType, default values for the
title
property, headerText
property, graphic
property properties are set. Once the Alert
is instantiated, developers are able to modify the values of the alert as
desired.
Concrete methods
Returns an ObservableBuffer
of all ButtonType
instances that
are currently set inside this Alert instance.
Returns an ObservableBuffer
of all ButtonType
instances that
are currently set inside this Alert instance.
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 theresult
.
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
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
- Inherited from
- Dialog
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
- SFXDelegate -> Any
- Inherited from
- SFXDelegate
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
- Inherited from
- Dialog
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
- Inherited from
- Dialog
Property representing the height of the dialog.
Property representing the height of the dialog.
- Inherited from
- 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.
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.
- Inherited from
- 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.
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.
- Inherited from
- 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.
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.
- Inherited from
- Dialog
Retrieves the modality attribute for this dialog.
Retrieves the modality attribute for this dialog.
- Returns
the modality.
- See also
- Inherited from
- Dialog
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.
- Inherited from
- Dialog
Called just prior to the Dialog being hidden.
Called just prior to the Dialog being hidden.
- Inherited from
- Dialog
Called just prior to the Dialog being shown.
Called just prior to the Dialog being shown.
- Inherited from
- Dialog
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
- Inherited from
- Dialog
Represents whether the dialog is resizable.
Represents whether the dialog is resizable.
- Inherited from
- 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.
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
- Inherited from
- Dialog
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.
- Inherited from
- Dialog
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 theresult
.- See also
- Inherited from
- Dialog
Represents whether the dialog is currently showing.
Represents whether the dialog is currently showing.
- Inherited from
- Dialog
- Returns
Returns the original delegate's
toString()
adding a[SFX]
prefix.- Definition Classes
- SFXDelegate -> Any
- Inherited from
- SFXDelegate
Property representing the width of the dialog.
Property representing the width of the dialog.
- Inherited from
- Dialog
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.
- Inherited from
- Dialog
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.
- Inherited from
- Dialog