Generated with

scalafx/scalafx/scalafx.scene/scalafx.scene.control/Dialog

Dialog

scalafx.scene.control.Dialog

See theDialog companion object

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

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

Wraps a JavaFX Dialog.

Type parameters

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

Attributes

Companion: object
Graph
Supertypes: class EventTarget

trait SFXDelegate[Dialog[R]]

class Object

trait Matchable

class Any
Known subtypes: class Alert

class ChoiceDialog[T]

class TextInputDialog

Members list

Type members

Inherited classlikes

Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

Attributes

Inherited from:: EventTarget
Supertypes: class Object

trait Matchable

class Any

Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

Attributes

Inherited from:: EventTarget
Supertypes: class Object

trait Matchable

class Any

Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

Attributes

Inherited from:: EventTarget
Supertypes: class Object

trait Matchable

class Any

Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

Attributes

Inherited from:: EventTarget
Supertypes: 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.

Attributes

See also: Original Documentation.

The dialog graphic, presented either in the header, if one is showing, or to the left of the content.

Attributes

See also: Original Documentation.

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.

Attributes

See also: Original Documentation.

Property representing the height of the dialog.

Attributes

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 parameters

modality: the modality for this dialog.

Attributes

Throws: IllegalStateException
if this property is set after the dialog has ever been made 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 parameters

window: the owner Window for this dialog.

Attributes

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

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 parameters

style: the style for this dialog.

Attributes

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

Retrieves the modality attribute for this dialog.

Attributes

Returns: the modality.
See also: getModality Original Documentation.

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.

Attributes

Called just prior to the Dialog being hidden.

Attributes

Called just prior to the Dialog being shown.

Attributes

Called just after the Dialog is shown.

Attributes

Retrieves the owner Window for this dialog, or null for an unowned dialog.

Attributes

Returns: the owner Window.
See also: Original Documentation.

Represents whether the dialog is resizable.

Attributes

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.

Attributes

See also: Original Documentation.

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.

Attributes

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 => ...
 }

Attributes

Returns: An Option that contains the result.
See also: showAndWait Original Documentation.

Represents whether the dialog is currently showing.

Attributes

Return the title of the dialog.

Attributes

Property representing the width of the dialog.

Attributes

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

Attributes

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

Attributes

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.

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 parameters

tail: the initial chain to build from

Attributes

Returns: the resulting event dispatch chain for this target
See also: Original Documentation.
Inherited from:: EventTarget

Verifies if a object is equals to this delegate.

Value parameters

ref: Object to be compared.

Attributes

Returns: if the other object is equals to this delegate or not.
Definition Classes: SFXDelegate -> Any
Inherited from:: SFXDelegate

Registers an event filter. Registered event filters get an event before any associated event handlers.

Example of filtering mouse events

pane.filterEvent(MouseEvent.Any) {
  me: MouseEvent => {
    me.eventType match {
      case MouseEvent.MousePressed => {
        ...
      }
      case MouseEvent.MouseDragged => {
        ...
      }
      case _ => {
        ...
      }
    }
  }
}

pane.filterEvent(MouseEvent.Any) { () => println("Some mouse event handled") }

Type parameters

J: type JavaFX delegate of the event
S: ScalaFX type for J type wrapper.

Value parameters

eventType: type of events that will be handled.
filter: code handling the event, see examples above.

Attributes

Inherited from:: EventTarget

Registers an event handler. The handler is called when the node receives an Event of the specified type during the bubbling phase of event delivery.

Example of handling mouse events

pane.handleEvent(MouseEvent.Any) {
  me: MouseEvent => {
    me.eventType match {
      case MouseEvent.MousePressed => ...
      case MouseEvent.MouseDragged => ...
      case _                       => {}
    }
  }
}

pane.handleEvent(MouseEvent.Any) { () => println("Some mouse event handled") }

Type parameters

J: type JavaFX delegate of the event
S: ScalaFX type for J type wrapper.

Value parameters

eventType: type of events that will be handled.
handler: code handling the event, see examples above.

Attributes

Returns: Returns a subscription that can be used to cancel/remove this event handler
Inherited from:: EventTarget

Attributes

Returns: The delegate hashcode
Definition Classes: SFXDelegate -> Any
Inherited from:: SFXDelegate

Attributes

Returns: Returns the original delegate's toString() adding a [SFX] prefix.
Definition Classes: SFXDelegate -> Any
Inherited from:: SFXDelegate

Concrete fields

JavaFX object to be wrapped.

Attributes

In this article

Generated with