DialogPane

java.lang.Object
- Pane
- - javafx.scene.control.DialogPane

```
public class DialogPane
extends Pane
```
DialogPane should be considered to be the root node displayed within a Dialog instance. In this role, the DialogPane is responsible for the placement of headers, graphics, content, and buttons. The default implementation of DialogPane (that is, the DialogPane class itself) handles the layout via the normal layoutChildren() method. This method may be overridden by subclasses wishing to handle the layout in an alternative fashion).
In addition to the header and content properties, there exists header text and content text properties. The way the *Text properties work is that they are a lower precedence compared to the Node properties, but they are far more convenient for developers in the common case, as it is likely the case that a developer more often than not simply wants to set a string value into the header or content areas of the DialogPane.
It is important to understand the implications of setting non-null values in the header and headerText properties. The key points are as follows:
1. The header property takes precedence over the headerText property, so if both are set to non-null values, header will be used and headerText will be ignored.
2. If headerText is set to a non-null value, and a graphic has also been set, the default position for the graphic shifts from being located to the left of the content area to being to the right of the header text.
3. If header is set to a non-null value, and a graphic has also been set, the graphic is removed from its default position (to the left of the content area), and is not placed to the right of the custom header node. If the graphic is desired, it should be manually added in to the layout of the custom header node manually.
DialogPane operates on the concept of ButtonType. A ButtonType is a descriptor of a single button that should be represented visually in the DialogPane. Developers who create a DialogPane therefore must specify the button types that they want to display, and this is done via the getButtonTypes() method, which returns a modifiable ObservableList, which users can add to and remove from as desired.
The ButtonType class defines a number of pre-defined button types, such as ButtonType.OK and ButtonType.CANCEL. Many users of the JavaFX dialogs API will find that these pre-defined button types meet their needs, particularly due to their built-in support for default and cancel buttons, as well as the benefit of the strings being translated into all languages which JavaFX is translated to. For users that want to define their own ButtonType (most commonly to define a button with custom text), they may do so via the constructors available on the ButtonType class.
Developers will quickly find that the amount of configurability offered via the ButtonType class is minimal. This is intentional, but does not mean that developers can not modify the buttons created by the ButtonType that have been specified. To do this, developers simply call the lookupButton(ButtonType) method with the ButtonType (assuming it has already been set in the getButtonTypes() list. The returned Node is typically of type Button, but this depends on if the createButton(ButtonType) method has been overridden.
The DialogPane class offers a few methods that can be overridden by subclasses, to more easily enable custom functionality. These methods include the following:
These methods are documented, so please take note of the expectations placed on any developer who wishes to override these methods with their own functionality.
Since:

JavaFX 8u40

See Also:

Dialog

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`<any>`	`content` Property representing the content area of the dialog.
`StringProperty`	`contentText` A property representing the content text for the dialog pane.
`<any>`	`expandableContent` A property that represents the dialog expandable content area.
`BooleanProperty`	`expanded` Represents whether the dialogPane is expanded.
`<any>`	`graphic` The dialog graphic, presented either in the header, if one is showing, or to the left of the `content`.
`<any>`	`header` Property representing the header area of the dialog pane.
`StringProperty`	`headerText` A property representing the header text for the dialog pane.
`private StyleableStringProperty`	`imageUrl` The imageUrl property is set from CSS and then the graphic property is set from the invalidated method.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`DialogPane.StyleableProperties` * Stylesheet Handling * *

Field Summary

Fields
Modifier and Type	Field and Description
`private Node`	`buttonBar`
`private java.util.Map<ButtonType,Node>`	`buttonNodes`
`private <any>`	`buttons`
`private <any>`	`content`
`private Label`	`contentLabel`
`private StringProperty`	`contentText`
`private Node`	`detailsButton`
`private Dialog<?>`	`dialog`
`private <any>`	`expandableContentProperty`
`private BooleanProperty`	`expandedProperty`
`private StackPane`	`graphicContainer`
`private <any>`	`graphicProperty` Properties
`private <any>`	`header`
`private StringProperty`	`headerText`
`private GridPane`	`headerTextPanel` Private fields
`private StyleableStringProperty`	`imageUrl`
`private double`	`oldHeight`

Constructor Summary

Constructors
Constructor and Description

DialogPane()
Creates a new DialogPane instance with a style class of 'dialog-pane'.

Constructors
Constructor and Description
`DialogPane()` Creates a new DialogPane instance with a style class of 'dialog-pane'.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected double`	`computeMinHeight(double width)`
`protected double`	`computeMinWidth(double height)`
`protected double`	`computePrefHeight(double width)`
`protected double`	`computePrefWidth(double height)`
`<any>`	`contentProperty()` Property representing the content area of the dialog.
`StringProperty`	`contentTextProperty()` A property representing the content text for the dialog pane.
`protected Node`	`createButton(ButtonType buttonType)` This method can be overridden by subclasses to create a custom button that will subsequently inserted into the DialogPane button area (created via the `createButtonBar()` method, but mostly commonly it is an instance of `ButtonBar`.
`protected Node`	`createButtonBar()` This method can be overridden by subclasses to provide the button bar.
`(package private) static Label`	`createContentLabel(java.lang.String text)` Creates a Label node that works well within a Dialog.
`protected Node`	`createDetailsButton()` This method can be overridden by subclasses to create a custom details button.
`<any>`	`expandableContentProperty()` A property that represents the dialog expandable content area.
`BooleanProperty`	`expandedProperty()` Represents whether the dialogPane is expanded.
`private Node`	`getActualContent()`
`private Node`	`getActualGraphic()`
`private Node`	`getActualHeader()`
`<any>`	`getButtonTypes()` Observable list of button types used for the dialog button bar area (created via the `createButtonBar()` method).
`static java.util.List<<any>>`	`getClassCssMetaData()`
`Node`	`getContent()` Returns the dialog content as a Node (even if it was set as a String using `setContentText(String)` - this was simply transformed into a `Node` (most probably a `Label`).
`java.lang.String`	`getContentText()` Returns the currently-set content text for this DialogPane.
`java.util.List<<any>>`	`getCssMetaData()`
`Node`	`getExpandableContent()` Returns the dialog expandable content node, if one is set, or null otherwise.
`Node`	`getGraphic()` Gets the value of the property graphic.
`Node`	`getHeader()` Node which acts as the dialog pane header.
`java.lang.String`	`getHeaderText()` Returns the currently-set header text for this DialogPane.
`<any>`	`graphicProperty()` The dialog graphic, presented either in the header, if one is showing, or to the left of the `content`.
`(package private) boolean`	`hasExpandableContent()`
`(package private) boolean`	`hasHeader()`
`<any>`	`headerProperty()` Property representing the header area of the dialog pane.
`StringProperty`	`headerTextProperty()` A property representing the header text for the dialog pane.
`private StyleableStringProperty`	`imageUrlProperty()` The imageUrl property is set from CSS and then the graphic property is set from the invalidated method.
`boolean`	`isExpanded()` Returns whether or not the dialogPane is expanded.
`private boolean`	`isTextHeader()`
`protected void`	`layoutChildren()`
`Node`	`lookupButton(ButtonType buttonType)` This method provides a way in which developers may retrieve the actual Node for a given `ButtonType` (assuming it is part of the `button types` list).
`void`	`setContent(Node content)` Assign dialog content.
`void`	`setContentText(java.lang.String contentText)` Sets the string to show in the dialog content area.
`(package private) void`	`setDialog(Dialog<?> dialog)`
`void`	`setExpandableContent(Node content)` Sets the dialog expandable content node, or null if no expandable content needs to be shown.
`void`	`setExpanded(boolean value)` Sets whether the dialogPane is expanded.
`void`	`setGraphic(Node graphic)` Sets the dialog graphic, which will be displayed either in the header, if one is showing, or to the left of the `content`.
`void`	`setHeader(Node header)` Assigns the dialog pane header.
`void`	`setHeaderText(java.lang.String headerText)` Sets the string to show in the dialog header area.
`private void`	`updateButtons(ButtonBar buttonBar)` Private implementation
`private void`	`updateContentArea()`
`private void`	`updateHeaderArea()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - graphic
```
public final <any> graphicProperty
```
    The dialog graphic, presented either in the header, if one is showing, or to the left of the content.
    
    See Also:
    
    getGraphic(), setGraphic(Node)
  - imageUrl
```
private StyleableStringProperty imageUrlProperty
```
    The imageUrl property is set from CSS and then the graphic property is set from the invalidated method. This ensures that the same image isn't reloaded.
  - header
```
public final <any> headerProperty
```
    Property representing the header area of the dialog pane. Note that if this header is set to a non-null value, that it will take up the entire top area of the DialogPane. It will also result in the DialogPane switching its layout to the 'header' layout - as outlined in the DialogPane class javadoc.
    
    See Also:
    
    getHeader(), setHeader(Node)
  - headerText
```
public final StringProperty headerTextProperty
```
    A property representing the header text for the dialog pane. The header text is lower precedence than the 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.
    When headerText is set to a non-null value, this will result in the DialogPane switching its layout to the 'header' layout - as outlined in the DialogPane class javadoc.
    
    See Also:
    
    getHeaderText(), setHeaderText(String)
  - content
```
public final <any> contentProperty
```
    Property representing the content area of the dialog.
    
    See Also:
    
    getContent(), setContent(Node)
  - contentText
```
public final StringProperty contentTextProperty
```
    A property representing the content text for the dialog pane. The content text is lower precedence than the 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:
    
    getContentText(), setContentText(String)
  - expandableContent
```
public final <any> expandableContentProperty
```
    A property that represents the dialog expandable content area. Any Node can be placed in this area, but it will only be shown when the user clicks the 'Show Details' expandable button. This button will be added automatically when the expandable content property is non-null.
    
    See Also:
    
    getExpandableContent(), setExpandableContent(Node)
  - expanded
```
public final BooleanProperty expandedProperty
```
    Represents whether the dialogPane is expanded.
    
    See Also:
    
    isExpanded(), setExpanded(boolean)
- Field Detail
  - headerTextPanel
```
private final GridPane headerTextPanel
```
    Private fields
  - contentLabel
```
private final Label contentLabel
```
  - graphicContainer
```
private final StackPane graphicContainer
```
  - buttonBar
```
private final Node buttonBar
```
  - buttons
```
private final <any> buttons
```
  - buttonNodes
```
private final java.util.Map<ButtonType,Node> buttonNodes
```
  - detailsButton
```
private Node detailsButton
```
  - dialog
```
private Dialog<?> dialog
```
  - graphicProperty
```
private final <any> graphicProperty
```
    Properties
  - imageUrl
```
private StyleableStringProperty imageUrl
```
  - header
```
private final <any> header
```
  - headerText
```
private final StringProperty headerText
```
  - content
```
private final <any> content
```
  - contentText
```
private final StringProperty contentText
```
  - expandableContentProperty
```
private final <any> expandableContentProperty
```
  - expandedProperty
```
private final BooleanProperty expandedProperty
```
  - oldHeight
```
private double oldHeight
```
- Constructor Detail
  - DialogPane
```
public DialogPane()
```
    Creates a new DialogPane instance with a style class of 'dialog-pane'.
- Method Detail
  - createContentLabel
```
static Label createContentLabel(java.lang.String text)
```
    Creates a Label node that works well within a Dialog.
    
    Parameters:
    
    text - The text to display
  - graphicProperty
```
public final <any> graphicProperty()
```
    The dialog graphic, presented either in the header, if one is showing, or to the left of the content.
    
    See Also:
    
    getGraphic(), setGraphic(Node)
  - getGraphic
```
public final Node getGraphic()
```
    Gets the value of the property graphic.
  - setGraphic
```
public final void setGraphic(Node graphic)
```
    Sets the dialog graphic, which will be displayed either in the header, if one is showing, or to the left of the content.
    
    Parameters:
    
    graphic - The new dialog graphic, or null if no graphic should be shown.
  - imageUrlProperty
```
private StyleableStringProperty imageUrlProperty()
```
    The imageUrl property is set from CSS and then the graphic property is set from the invalidated method. This ensures that the same image isn't reloaded.
  - getHeader
```
public final Node getHeader()
```
    Node which acts as the dialog pane header.
    
    Returns:
    
    the header of the dialog pane.
  - setHeader
```
public final void setHeader(Node header)
```
    Assigns the dialog pane header. Any Node can be used.
    
    Parameters:
    
    header - The new header of the DialogPane.
  - headerProperty
```
public final <any> headerProperty()
```
    Property representing the header area of the dialog pane. Note that if this header is set to a non-null value, that it will take up the entire top area of the DialogPane. It will also result in the DialogPane switching its layout to the 'header' layout - as outlined in the DialogPane class javadoc.
    
    See Also:
    
    getHeader(), setHeader(Node)
  - setHeaderText
```
public final void setHeaderText(java.lang.String headerText)
```
    Sets the string to show in the dialog header area. Note that the header text is lower precedence than the 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.
    When headerText is set to a non-null value, this will result in the DialogPane switching its layout to the 'header' layout - as outlined in the DialogPane class javadoc.
    
    Parameters:
    
    headerText - the string to show in the dialog header area
  - getHeaderText
```
public final java.lang.String getHeaderText()
```
    Returns the currently-set header text for this DialogPane.
    
    Returns:
    
    the currently-set header text for this DialogPane
  - headerTextProperty
```
public final StringProperty headerTextProperty()
```
    A property representing the header text for the dialog pane. The header text is lower precedence than the 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.
    When headerText is set to a non-null value, this will result in the DialogPane switching its layout to the 'header' layout - as outlined in the DialogPane class javadoc.
    
    See Also:
    
    getHeaderText(), setHeaderText(String)
  - getContent
```
public final Node getContent()
```
    Returns the dialog content as a Node (even if it was set as a String using setContentText(String) - this was simply transformed into a Node (most probably a Label).
    
    Returns:
    
    dialog's content
  - setContent
```
public final void setContent(Node content)
```
    Assign dialog content. Any Node can be used
    
    Parameters:
    
    content - dialog's content
  - contentProperty
```
public final <any> contentProperty()
```
    Property representing the content area of the dialog.
    
    See Also:
    
    getContent(), setContent(Node)
  - setContentText
```
public final void setContentText(java.lang.String contentText)
```
    Sets the string to show in the dialog content area. Note that the content text is lower precedence than the 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.
    
    Parameters:
    
    contentText - the string to show in the dialog content area
  - getContentText
```
public final java.lang.String getContentText()
```
    Returns the currently-set content text for this DialogPane.
    
    Returns:
    
    the currently-set content text for this DialogPane
  - contentTextProperty
```
public final StringProperty contentTextProperty()
```
    A property representing the content text for the dialog pane. The content text is lower precedence than the 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:
    
    getContentText(), setContentText(String)
  - expandableContentProperty
```
public final <any> expandableContentProperty()
```
    A property that represents the dialog expandable content area. Any Node can be placed in this area, but it will only be shown when the user clicks the 'Show Details' expandable button. This button will be added automatically when the expandable content property is non-null.
    
    See Also:
    
    getExpandableContent(), setExpandableContent(Node)
  - getExpandableContent
```
public final Node getExpandableContent()
```
    Returns the dialog expandable content node, if one is set, or null otherwise.
    
    Returns:
    
    the dialog expandable content node
  - setExpandableContent
```
public final void setExpandableContent(Node content)
```
    Sets the dialog expandable content node, or null if no expandable content needs to be shown.
    
    Parameters:
    
    content - the dialog expandable content node
  - expandedProperty
```
public final BooleanProperty expandedProperty()
```
    Represents whether the dialogPane is expanded.
    
    See Also:
    
    isExpanded(), setExpanded(boolean)
  - isExpanded
```
public final boolean isExpanded()
```
    Returns whether or not the dialogPane is expanded.
    
    Returns:
    
    true if dialogPane is expanded.
  - setExpanded
```
public final void setExpanded(boolean value)
```
    Sets whether the dialogPane is expanded. This only makes sense when there is expandable content to show.
    
    Parameters:
    
    value - true if dialogPane should be expanded.
  - getButtonTypes
```
public final <any> getButtonTypes()
```
    Observable list of button types used for the dialog button bar area (created via the createButtonBar() method). Modifying the contents of this list will immediately change the buttons displayed to the user within the dialog pane.
    
    Returns:
    
    The ObservableList of button types available to the user.
  - lookupButton
```
public final Node lookupButton(ButtonType buttonType)
```
    This method provides a way in which developers may retrieve the actual Node for a given ButtonType (assuming it is part of the button types list).
    
    Parameters:
    
    buttonType - The ButtonType for which a Node representation is requested.
    
    Returns:
    
    The Node used to represent the button type, as created by createButton(ButtonType), and only if the button type is part of the button types list, otherwise null.
  - createButtonBar
```
protected Node createButtonBar()
```
    This method can be overridden by subclasses to provide the button bar. Note that by overriding this method, the developer must take on multiple responsibilities:
    1. The developer must immediately iterate through all button types and call createButton(ButtonType) for each of them in turn.
    2. The developer must add a listener to the button types list, and when this list changes update the button bar as appropriate.
    3. Similarly, the developer must watch for changes to the expandable content property, adding and removing the details button (created via createDetailsButton() method).
    The default implementation of this method creates and returns a new ButtonBar instance.
    Returns:
    
    the created button bar
  - createButton
```
protected Node createButton(ButtonType buttonType)
```
    This method can be overridden by subclasses to create a custom button that will subsequently inserted into the DialogPane button area (created via the createButtonBar() method, but mostly commonly it is an instance of ButtonBar.
    
    Parameters:
    
    buttonType - The ButtonType to create a button from.
    
    Returns:
    
    A JavaFX Node that represents the given ButtonType, most commonly an instance of Button.
  - createDetailsButton
```
protected Node createDetailsButton()
```
    This method can be overridden by subclasses to create a custom details button.
    To override this method you must do two things:
    1. The button will need to have its own code set to handle mouse / keyboard interaction and to toggle the state of the expanded property.
    2. If your button changes its visuals based on whether the dialog pane is expanded or collapsed, you should add a listener to the expanded property, so that you may update the button visuals.
    Returns:
    
    the created details button
  - layoutChildren
```
protected void layoutChildren()
```
  - computeMinWidth
```
protected double computeMinWidth(double height)
```
  - computeMinHeight
```
protected double computeMinHeight(double width)
```
  - computePrefWidth
```
protected double computePrefWidth(double height)
```
  - computePrefHeight
```
protected double computePrefHeight(double width)
```
  - updateButtons
```
private void updateButtons(ButtonBar buttonBar)
```
    Private implementation
    
    Parameters:
    
    buttonBar -
  - getActualContent
```
private Node getActualContent()
```
  - getActualHeader
```
private Node getActualHeader()
```
  - getActualGraphic
```
private Node getActualGraphic()
```
  - updateHeaderArea
```
private void updateHeaderArea()
```
  - updateContentArea
```
private void updateContentArea()
```
  - hasHeader
```
boolean hasHeader()
```
  - isTextHeader
```
private boolean isTextHeader()
```
  - hasExpandableContent
```
boolean hasExpandableContent()
```
  - setDialog
```
void setDialog(Dialog<?> dialog)
```
  - getClassCssMetaData
```
public static java.util.List<<any>> getClassCssMetaData()
```
    Returns:
    
    The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
  - getCssMetaData
```
public java.util.List<<any>> getCssMetaData()
```

Class DialogPane

Property Summary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

graphic

imageUrl

header

headerText

content

contentText

expandableContent

expanded

Field Detail

headerTextPanel

contentLabel

graphicContainer

buttonBar

buttons

buttonNodes

detailsButton

dialog

graphicProperty

imageUrl

header

headerText

content

contentText

expandableContentProperty

expandedProperty

oldHeight

Constructor Detail

DialogPane

Method Detail

createContentLabel

graphicProperty

getGraphic

setGraphic

imageUrlProperty

getHeader

setHeader

headerProperty

setHeaderText

getHeaderText

headerTextProperty

getContent

setContent

contentProperty

setContentText

getContentText

contentTextProperty

expandableContentProperty

getExpandableContent

setExpandableContent

expandedProperty

isExpanded

setExpanded

getButtonTypes

lookupButton

createButtonBar

createButton

createDetailsButton

layoutChildren

computeMinWidth

computeMinHeight

computePrefWidth

computePrefHeight

updateButtons

getActualContent

getActualHeader

getActualGraphic

updateHeaderArea

updateContentArea

hasHeader

isTextHeader

hasExpandableContent

setDialog