Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: DialogPane

[96:7] extends: Pane

The DialogPane class wraps the JavaFX DialogPane, the root pane used inside a Dialog to present a structured layout with a header, content area, expandable details section, and a button bar. It is the default root node of any Dialog or Alert and uses the CSS style class dialog-pane. DialogPane extends Pane, which extends Region, giving it the full set of Region and Node CSS properties in addition to its own graphic property.

CSS Properties -- DialogPane

Property Values Default Description
-fx-graphic <uri> null URI of a graphic image shown in the header area of the dialog.

CSS Properties -- Region

Background fills

Property Values Default Description
-fx-background-color <paint> [, <paint>]* transparent One or more paint values for background fill layers, rendered back to front.
-fx-background-insets <size> or <t> <r> <b> <l> [, ...]* 0 0 0 0 Insets from the region edges for each background fill layer.
-fx-background-radius <size> [/ <size>]* [, ...]* 0 0 0 0 Corner radii for each background fill layer.

Background images

Property Values Default Description
-fx-background-image <uri> [, <uri>]* null One or more image URIs for background image layers.
-fx-background-position <bg-position> [, ...]* 0% 0% Position of each background image within the region. Accepts keywords or size values.
-fx-background-repeat <repeat-style> [, ...]* repeat repeat Tiling behavior for each background image. Values: repeat, no-repeat, round, space applied per axis.
-fx-background-size <bg-size> [, ...]* auto auto Dimensions for each background image. Supports cover, contain, stretch, or explicit sizes.

Stroked borders

Property Values Default Description
-fx-border-color <paint> or <t> <r> <b> <l> [, ...]* null Paint colors for the border stroke layers.
-fx-border-insets <size> or <t> <r> <b> <l> [, ...]* null Insets from region edges for each border layer.
-fx-border-radius <size> [, ...]* null Corner radii for border stroke layers.
-fx-border-style <border-style> [, ...]* null Border line style (solid, dotted, dashed) plus phase and line cap/join options per layer.
-fx-border-width <size> or <t> <r> <b> <l> [, ...]* null Thickness of each border stroke layer, per side.

Border images

Property Values Default Description
-fx-border-image-source <uri> [, <uri>]* null Image URIs used to paint the border.
-fx-border-image-insets <size> or <t> <r> <b> <l> [, ...]* 0 0 0 0 Insets for each border image layer.
-fx-border-image-repeat <repeat-style> [, ...]* repeat repeat Tiling behavior for each border image.
-fx-border-image-slice <size> or <t> <r> <b> <l> [fill] [, ...]* 100% Divides each border image into nine regions. Adding fill preserves the center region.
-fx-border-image-width <size> or <t> <r> <b> <l> [, ...]* 1 1 1 1 Width of each border image slice per side.

Other Region properties

Property Values Default Description
-fx-padding <size> or <t> <r> <b> <l> 0 0 0 0 Interior padding between the region border and its content.
-fx-shape <string> null SVG path string that defines a custom clip shape for the region.
-fx-scale-shape true | false true When true, the shape is scaled to fit the region.
-fx-position-shape true | false true When true, the shape is centered within the region.
-fx-snap-to-pixel true | false true When true, positions and sizes are rounded to whole pixel boundaries.
-fx-min-width <size> -1 Minimum width. -1 uses the computed minimum.
-fx-pref-width <size> -1 Preferred width. -1 uses the computed preferred.
-fx-max-width <size> -1 Maximum width. -1 uses the computed maximum.
-fx-min-height <size> -1 Minimum height. -1 uses the computed minimum.
-fx-pref-height <size> -1 Preferred height. -1 uses the computed preferred.
-fx-max-height <size> -1 Maximum height. -1 uses the computed maximum.

CSS Properties -- Node

Property Values Default Description
-fx-blend-mode add | blue | color-burn | color-dodge | darken | difference | exclusion | green | hard-light | lighten | multiply | overlay | red | screen | soft-light | src-atop | src-in | src-out | src-over null Blend mode used when compositing this node with nodes beneath it.
-fx-cursor null | crosshair | default | hand | move | e-resize | h-resize | ne-resize | nw-resize | n-resize | se-resize | sw-resize | s-resize | w-resize | v-resize | text | wait | <url> null (inherits) Mouse cursor shape shown when the pointer is over this node. Inherits from parent by default.
-fx-effect <effect> null A visual effect (e.g. DropShadow, InnerShadow) applied to the rendered node.
-fx-focus-traversable true | false false Whether this node participates in focus traversal via the keyboard Tab key.
-fx-view-order <number> 0 Adjusts rendering and hit-test order within the parent without changing the scene graph order.
-fx-opacity <number> [0.0 - 1.0] 1 Opacity of the node. 0 is fully transparent, 1 is fully opaque.
-fx-rotate <number> 0 Rotation angle in degrees applied around the node's center point. Positive values are clockwise.
-fx-scale-x <number> 1 Scale factor along the X axis about the node's center.
-fx-scale-y <number> 1 Scale factor along the Y axis about the node's center.
-fx-scale-z <number> 1 Scale factor along the Z axis about the node's center.
-fx-translate-x <number> 0 Translation offset along the X axis in pixels.
-fx-translate-y <number> 0 Translation offset along the Y axis in pixels.
-fx-translate-z <number> 0 Translation offset along the Z axis in pixels.
visibility visible | hidden | collapse | inherit visible Controls whether the node is rendered and participates in layout. collapse removes it from layout; hidden keeps the space.
-fx-managed true | false true When false, the parent layout does not manage this node's position or size.

Methods

  • DialogPane ()

    Constructor that creates the DialogPane object.

    • @r this object
  • getGraphic ()

    Returns the graphic Node AJO shown in the header.

    • @r An AJO around the graphic Node or null.
  • setGraphic (object NodeObj)

    Sets the graphic Node shown in the header.

    • @p NodeObj is a Node wrapper for the graphic.
    • @r this object for chaining
  • graphicProperty ()

    Returns the ObjectProperty AJO for the graphic.

    • @r An AJO around the graphic ObjectProperty.
  • getHeader ()

    Returns the custom header Node AJO.

    • @r An AJO around the header Node or null.
  • setHeader (object NodeObj)

    Sets a custom header Node, overriding the default header text area.

    • @p NodeObj is a Node wrapper for the header.
    • @r this object for chaining
  • headerProperty ()

    Returns the ObjectProperty AJO for the header.

    • @r An AJO around the header ObjectProperty.
  • getHeaderText ()

    Returns the header text string.

    • @r A string with the header text or null.
  • setHeaderText (string Text)

    Sets the header text shown in the default header area.

    • @p Text is a string with the header text.
    • @r this object for chaining
  • headerTextProperty ()

    Returns the StringProperty AJO for the header text.

    • @r An AJO around the headerText StringProperty.
  • getContent ()

    Returns the custom content Node AJO.

    • @r An AJO around the content Node or null.
  • setContent (object NodeObj)

    Sets a custom content Node, overriding the default content text label.

    • @p NodeObj is a Node wrapper for the content.
    • @r this object for chaining
  • contentProperty ()

    Returns the ObjectProperty AJO for the content.

    • @r An AJO around the content ObjectProperty.
  • getContentText ()

    Returns the content text string.

    • @r A string with the content text or null.
  • setContentText (string Text)

    Sets the content text shown in the default content label.

    • @p Text is a string with the content text.
    • @r this object for chaining
  • contentTextProperty ()

    Returns the StringProperty AJO for the content text.

    • @r An AJO around the contentText StringProperty.
  • getExpandableContent ()

    Returns the expandable content Node AJO.

    • @r An AJO around the expandable content Node or null.
  • setExpandableContent (object NodeObj)

    Sets the expandable content Node shown when the details button is open.

    • @p NodeObj is a Node wrapper for the expandable content.
    • @r this object for chaining
  • expandableContentProperty ()

    Returns the ObjectProperty AJO for the expandable content.

    • @r An AJO around the expandableContent ObjectProperty.
  • isExpanded ()

    Returns whether the expandable content area is expanded.

    • @r A bool with true if expanded.
  • setExpanded (bool Exp)

    Sets whether the expandable content area is expanded.

    • @p Exp is a bool with true to expand.
    • @r this object for chaining
  • expandedProperty ()

    Returns the BooleanProperty AJO for expanded.

    • @r An AJO around the expanded BooleanProperty.
  • getButtonTypes ()

    Returns the modifiable list of ButtonType entries that defines the dialog's button bar.

    • @r An AJO around the ObservableList of ButtonType.
  • lookupButton (object Bt)

    Looks up the button Node AJO created for a ButtonType.

    • @p Bt is an AJO around the javafx.scene.control.ButtonType to look up.
    • @r An AJO around the button Node or null.