Class Alert

public class Alert
extends Dialog<ButtonType>

Optional<ButtonType> result = alert.showAndWait();
 if (result.isPresent() && result.get() == ButtonType.OK) {
     formatSystem();
 }

alert.showAndWait().ifPresent(response -> {
     if (response == ButtonType.OK) {
         formatSystem();
     }
 });

alert.showAndWait()
      .filter(response -> response == ButtonType.OK)
      .ifPresent(response -> formatSystem());

• Property Summary

  All MethodsInstance MethodsConcrete Methods

  Type	Property and Description
  ObjectProperty<Alert.AlertType>	alertType When creating an Alert instance, users must pass in an Alert.AlertType enumeration value.

  • Properties inherited from class javafx.scene.control.Dialog

    contentText, dialogPane, graphic, headerText, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, resizable, resultConverter, result, showing, title, width, x, y

• Nested Class Summary

  Nested Classes

  Modifier and Type	Class and Description
  static class	Alert.AlertType An enumeration containing the available, pre-built alert types that the Alert class can use to pre-populate various properties.

• Constructor Summary

  Constructors

  Constructor and Description
  Alert(Alert.AlertType alertType) Creates an alert with the given AlertType (refer to the Alert.AlertType documentation for clarification over which one is most appropriate).
  Alert(Alert.AlertType alertType, String contentText, ButtonType... buttons) Creates an alert with the given contentText, ButtonTypes, and AlertType (refer to the Alert.AlertType documentation for clarification over which one is most appropriate).

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type	Method and Description
  ObjectProperty<Alert.AlertType>	alertTypeProperty() When creating an Alert instance, users must pass in an Alert.AlertType enumeration value.
  Alert.AlertType	getAlertType() Gets the value of the property alertType.
  ObservableList<ButtonType>	getButtonTypes() Returns an ObservableList of all ButtonType instances that are currently set inside this Alert instance.
  void	setAlertType(Alert.AlertType alertType) Sets the value of the property alertType.

  • Methods inherited from class javafx.scene.control.Dialog

    buildEventDispatchChain, close, contentTextProperty, dialogPaneProperty, getContentText, getDialogPane, getGraphic, getHeaderText, getHeight, getModality, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOwner, getResult, getResultConverter, getTitle, getWidth, getX, getY, graphicProperty, headerTextProperty, heightProperty, hide, initModality, initOwner, initStyle, isResizable, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, resizableProperty, resultConverterProperty, resultProperty, setContentText, setDialogPane, setGraphic, setHeaderText, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setResizable, setResult, setResultConverter, setTitle, setWidth, setX, setY, show, showAndWait, showingProperty, titleProperty, widthProperty, xProperty, yProperty

  • Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Property Detail

  • alertType

    public final ObjectProperty<Alert.AlertType> alertTypeProperty

    When creating an Alert instance, users must pass in an Alert.AlertType enumeration value. It is by passing in this value that the Alert instance will configure itself appropriately (by setting default values for many of the Dialog properties, including title, header, and graphic, as well as the default buttons that are expected in a dialog of the given type.

    See Also:

    getAlertType(), setAlertType(AlertType)

• Constructor Detail

  • Alert

    public Alert(Alert.AlertType alertType)

    Creates an alert with the given AlertType (refer to the Alert.AlertType documentation for clarification over which one is most appropriate).

    By passing in an AlertType, default values for the title, headerText, and graphic properties are set, as well as the relevant buttons being installed. Once the Alert is instantiated, developers are able to modify the values of the alert as desired.

    It is important to note that the one property that does not have a default value set, and which therefore the developer must set, is the content text property (or alternatively, the developer may call alert.getDialogPane().setContent(Node) if they want a more complex alert). If the contentText (or content) properties are not set, there is no useful information presented to end users.

  • Alert

    public Alert(Alert.AlertType alertType,
                 String contentText,
                 ButtonType... buttons)

    Creates an alert with the given contentText, ButtonTypes, and AlertType (refer to the Alert.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, headerText, and graphic properties are set. Once the Alert is instantiated, developers are able to modify the values of the alert as desired.

• Method Detail

  • getAlertType

    public final Alert.AlertType getAlertType()

    Gets the value of the property alertType.

    Property description:

    When creating an Alert instance, users must pass in an Alert.AlertType enumeration value. It is by passing in this value that the Alert instance will configure itself appropriately (by setting default values for many of the Dialog properties, including title, header, and graphic, as well as the default buttons that are expected in a dialog of the given type.

  • setAlertType

    public final void setAlertType(Alert.AlertType alertType)

    Sets the value of the property alertType.

    Property description:

    When creating an Alert instance, users must pass in an Alert.AlertType enumeration value. It is by passing in this value that the Alert instance will configure itself appropriately (by setting default values for many of the Dialog properties, including title, header, and graphic, as well as the default buttons that are expected in a dialog of the given type.

  • alertTypeProperty

    public final ObjectProperty<Alert.AlertType> alertTypeProperty()

    When creating an Alert instance, users must pass in an Alert.AlertType enumeration value. It is by passing in this value that the Alert instance will configure itself appropriately (by setting default values for many of the Dialog properties, including title, header, and graphic, as well as the default buttons that are expected in a dialog of the given type.

    See Also:

    getAlertType(), setAlertType(AlertType)

  • getButtonTypes

    public final ObservableList<ButtonType> getButtonTypes()

    Returns an ObservableList of all ButtonType instances that are currently set inside this Alert instance. A ButtonType may either be one of the pre-defined types (e.g. ButtonType.OK), or it may be a custom type (created via the ButtonType.ButtonType(String) or ButtonType.ButtonType(String, javafx.scene.control.ButtonBar.ButtonData) constructors.

    Readers should refer to the ButtonType class documentation for more details, but at a high level, each ButtonType instance is converted to a Node (although most commonly a Button) via the (overridable) DialogPane.createButton(ButtonType) method on DialogPane.